新しいサブスクリプションを作成する

パラメータ

Name	を入力します	入力	必須	説明
account_id	string	path（パス）	True	包含するアカウントリソースのID 例：{{.Account}}

Name

を入力します

入力

必須

説明

account_id

string

path（パス）

True

包含するアカウントリソースのID

例：{{.Account}}

要求の本文

作成される Subscription API リソースの希望値を指定します。

Name	を入力します	必須	説明
を入力します	string	True	リソースのメディアタイプ。定義された値は次のとおりです：「application/astra-subscription」
バージョン	string	True	リソースのバージョン。定義された値は次のとおりです： "1.0" "1.1" "1.2"
顧客概要ID	string	False	http://authorize.net["Authorize.net"]から呼び出された顧客概要IDを含むJSON文字列は、試用期間中は設定されません。設定されていない場合、読み取り操作中に空の文字列を返します。定義値は次のとおりです：最小長さ：0 最大長さ：63
paymentFirstName	string	False	支払い請求に使用される、ユーザーが指定したフルネーム（名）を含むJSON文字列。定期購読の再請求時にのみ指定されます。定義された値は次のとおりです：最小長さ：1 最大長さ：63
paymentLastName	string	False	支払い請求に使用される、ユーザーが指定した長めの姓を含むJSON文字列。定期購読の再請求時にのみ指定されます。定義された値は次のとおりです：最小長さ：1 最大長さ：63
paymentAddress	"paymentAddress"	False	請求先住所を指定するJSON文字列のコレクションを含むJSONオブジェクト。サブスクリプションの再請求時にのみ指定されます。このキーが存在する場合、含まれている6つのJSON文字列すべてが存在します。ユーザーから何も入力されなかった場合、文字列は空になります。
paymentProfileID	string	False	http://Authorize.net["Authorize.net"]から呼び出された支払いプロファイルIDを含むJSON文字列。トライアル期間には設定されません。設定されていない場合、読み取り操作中に空の文字列を返します。定義された値は次のとおりです：最小長さ：0 最大長さ：63
paymentExpiry	string	False	支払い方法の有効期限を示すタイムスタンプを含むJSON文字列。これはauthorize.net](http://authorize.netから取得され、UIによって設定されます。定義された値は次のとおりです： ISO-8601 日付時刻スキーマに準拠しています。このフィールドは試用期間には返されません。
マーケットプレイス	string	False	支払いが記録されるアカウントのマーケットプレイスを示すJSON文字列。定義された値：「netapp」 "azure" "aws" "gcp"
条項	string	True	アカウントの現在のティアを示すJSON文字列。定義された値は次のとおりです： "トライアル" 「paid」
メタデータ	"type_astra_metadata_update"	False	リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです： Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。

Name

を入力します

必須

説明

を入力します

string

True

リソースのメディアタイプ。定義された値は次のとおりです：

「application/astra-subscription」

バージョン

string

True

リソースのバージョン。定義された値は次のとおりです：

"1.0"
"1.1"
"1.2"

顧客概要ID

string

False

http://authorize.net["Authorize.net"]から呼び出された顧客概要IDを含むJSON文字列は、試用期間中は設定されません。設定されていない場合、読み取り操作中に空の文字列を返します。定義値は次のとおりです：

最小長さ：0
最大長さ：63

paymentFirstName

string

False

支払い請求に使用される、ユーザーが指定したフルネーム（名）を含むJSON文字列。定期購読の再請求時にのみ指定されます。定義された値は次のとおりです：

最小長さ：1
最大長さ：63

paymentLastName

string

False

支払い請求に使用される、ユーザーが指定した長めの姓を含むJSON文字列。定期購読の再請求時にのみ指定されます。定義された値は次のとおりです：

最小長さ：1
最大長さ：63

paymentAddress

"paymentAddress"

False

請求先住所を指定するJSON文字列のコレクションを含むJSONオブジェクト。サブスクリプションの再請求時にのみ指定されます。このキーが存在する場合、含まれている6つのJSON文字列すべてが存在します。ユーザーから何も入力されなかった場合、文字列は空になります。

paymentProfileID

string

False

http://Authorize.net["Authorize.net"]から呼び出された支払いプロファイルIDを含むJSON文字列。トライアル期間には設定されません。設定されていない場合、読み取り操作中に空の文字列を返します。定義された値は次のとおりです：

最小長さ：0
最大長さ：63

paymentExpiry

string

False

支払い方法の有効期限を示すタイムスタンプを含むJSON文字列。これはauthorize.net](http://authorize.netから取得され、UIによって設定されます。定義された値は次のとおりです：

ISO-8601 日付時刻スキーマに準拠しています。このフィールドは試用期間には返されません。

マーケットプレイス

string

False

支払いが記録されるアカウントのマーケットプレイスを示すJSON文字列。定義された値：

「netapp」
"azure"
"aws"
"gcp"

条項

string

True

アカウントの現在のティアを示すJSON文字列。定義された値は次のとおりです：

"トライアル"
「paid」

メタデータ

"type_astra_metadata_update"

False

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです：

Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。

リクエスト例

{
  "type": "application/astra-subscription",
  "version": "1.2",
  "terms": "trial"
}

応答

Status: 201, Returns the newly created subscription resource in the JSON response body.

Name	を入力します	必須	説明
を入力します	string	True	リソースのメディアタイプ。定義された値は次のとおりです：「application/astra-subscription」
バージョン	string	True	リソースのバージョン。定義された値は次のとおりです： "1.0" "1.1" "1.2"
ID	string	True	リソースのグローバル一意識別子。定義された値は次のとおりです： UUIDv4スキーマに準拠
顧客概要ID	string	True	http://authorize.net["Authorize.net"]から呼び出された顧客概要IDを含むJSON文字列は、試用期間中は設定されません。設定されていない場合、読み取り操作中に空の文字列を返します。定義値は次のとおりです：最小長さ：0 最大長さ：63
paymentProfileID	string	False	http://Authorize.net["Authorize.net"]から呼び出された支払いプロファイルIDを含むJSON文字列。トライアル期間には設定されません。設定されていない場合、読み取り操作中に空の文字列を返します。定義された値は次のとおりです：最小長さ：0 最大長さ：63
paymentExpiry	string	False	支払い方法の有効期限を示すタイムスタンプを含むJSON文字列。これはauthorize.net](http://authorize.netから取得され、UIによって設定されます。定義された値は次のとおりです： ISO-8601 日付時刻スキーマに準拠しています。このフィールドは試用期間には返されません。
purchaseOrderNumber	string	False	支払い方法に対応する発注番号を含むJSON文字列。定義された値は次のとおりです：最小長さ：1 最大長さ：31
マーケットプレイス	string	False	支払いが記録されるアカウントのマーケットプレイスを示すJSON文字列。定義された値：「netapp」 "azure" "aws" "gcp"
licenseSN	string	False	支払い方法のライセンスシリアル番号を含むJSON文字列。定義されている値は次のとおりです：最小長さ：1 最大長さ：31
条項	string	True	アカウントの現在のティアを示すJSON文字列。定義された値は次のとおりです： "トライアル" 「paid」
ステータス	string	True	サブスクリプションの現在のステータスを示すJSON文字列。定義されている値は次のとおりです： "アクティブ" 「inactive」
appLimit	番号	True	このサブスクリプションにおけるアプリケーション制限を示すJSON数値。-1の値は制限がないことを示します。
namespaceLimit	番号	True	このサブスクリプションにおける名前空間の制限を示すJSON数値。-1の値は制限がないことを示します。
subscriptionPeriod	番号	True	購読期間を示すJSON形式の数値。-1の値は制限がないことを示します。単位：日
gracePeriod	番号	True	トライアル期間が終了した後、または有料サブスクリプションがキャンセルされた後の猶予期間を示すJSON数値。単位：日
reminderBeforePeriod	番号	True	顧客への通知が開始されるトライアル期間終了前の日数を示すJSON形式の数値。値は日数で表され、-1は該当しないことを示します。
onboardStatus	string	True	顧客オンボーディングの現在のステータスを示すJSON文字列。有効な値は "not started"、"in progress"、"success"、"failed" です。定義値は次のとおりです：「未開始」 "進行中" "成功" "失敗"
costPerAppUnit	番号	True	アプリユニットあたりのコストを示すJSON番号。試用版の場合、値は0です。単位：米ドル
costPerNamespaceUnit	番号	True	名前空間単位あたりのコストを示すJSON数値。試用版の場合、値は0です。単位：米ドル
メタデータ	"type_astra_metadata_update"	True	リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです： Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。

Name

を入力します

必須

説明

を入力します

string

True

リソースのメディアタイプ。定義された値は次のとおりです：

「application/astra-subscription」

バージョン

string

True

リソースのバージョン。定義された値は次のとおりです：

"1.0"
"1.1"
"1.2"

ID

string

True

リソースのグローバル一意識別子。定義された値は次のとおりです：

UUIDv4スキーマに準拠

顧客概要ID

string

True

http://authorize.net["Authorize.net"]から呼び出された顧客概要IDを含むJSON文字列は、試用期間中は設定されません。設定されていない場合、読み取り操作中に空の文字列を返します。定義値は次のとおりです：

最小長さ：0
最大長さ：63

paymentProfileID

string

False

http://Authorize.net["Authorize.net"]から呼び出された支払いプロファイルIDを含むJSON文字列。トライアル期間には設定されません。設定されていない場合、読み取り操作中に空の文字列を返します。定義された値は次のとおりです：

最小長さ：0
最大長さ：63

paymentExpiry

string

False

支払い方法の有効期限を示すタイムスタンプを含むJSON文字列。これはauthorize.net](http://authorize.netから取得され、UIによって設定されます。定義された値は次のとおりです：

ISO-8601 日付時刻スキーマに準拠しています。このフィールドは試用期間には返されません。

purchaseOrderNumber

string

False

支払い方法に対応する発注番号を含むJSON文字列。定義された値は次のとおりです：

最小長さ：1
最大長さ：31

マーケットプレイス

string

False

支払いが記録されるアカウントのマーケットプレイスを示すJSON文字列。定義された値：

「netapp」
"azure"
"aws"
"gcp"

licenseSN

string

False

支払い方法のライセンスシリアル番号を含むJSON文字列。定義されている値は次のとおりです：

最小長さ：1
最大長さ：31

条項

string

True

アカウントの現在のティアを示すJSON文字列。定義された値は次のとおりです：

"トライアル"
「paid」

ステータス

string

True

サブスクリプションの現在のステータスを示すJSON文字列。定義されている値は次のとおりです：

"アクティブ"
「inactive」

appLimit

番号

True

このサブスクリプションにおけるアプリケーション制限を示すJSON数値。-1の値は制限がないことを示します。

namespaceLimit

番号

True

このサブスクリプションにおける名前空間の制限を示すJSON数値。-1の値は制限がないことを示します。

subscriptionPeriod

番号

True

購読期間を示すJSON形式の数値。-1の値は制限がないことを示します。単位：日

gracePeriod

番号

True

トライアル期間が終了した後、または有料サブスクリプションがキャンセルされた後の猶予期間を示すJSON数値。単位：日

reminderBeforePeriod

番号

True

顧客への通知が開始されるトライアル期間終了前の日数を示すJSON形式の数値。値は日数で表され、-1は該当しないことを示します。

onboardStatus

string

True

顧客オンボーディングの現在のステータスを示すJSON文字列。有効な値は "not started"、"in progress"、"success"、"failed" です。定義値は次のとおりです：

「未開始」
"進行中"
"成功"
"失敗"

costPerAppUnit

番号

True

アプリユニットあたりのコストを示すJSON番号。試用版の場合、値は0です。単位：米ドル

costPerNamespaceUnit

番号

True

名前空間単位あたりのコストを示すJSON数値。試用版の場合、値は0です。単位：米ドル

メタデータ

"type_astra_metadata_update"

True

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです：

Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。

回答例

{
  "type": "application/astra-subscription",
  "version": "1.2",
  "id": "40b4106f-b743-5d83-95c7-d539b2b45f63",
  "customerProfileID": "2157047189",
  "paymentProfileID": "E7CEB0A9F1BECA32A02493E1B31D5955",
  "paymentExpiry": "2022-02-01T00:00:00Z",
  "purchaseOrderNumber": "72384632",
  "marketplace": "netapp",
  "licenseSN": "278343",
  "terms": "trial",
  "status": "active",
  "appLimit": 0,
  "namespaceLimit": 10,
  "subscriptionPeriod": 90,
  "gracePeriod": 7,
  "reminderBeforePeriod": 30,
  "onboardStatus": "in progress",
  "costPerAppUnit": 0,
  "costPerNamespaceUnit": 0.005,
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

応答

Status: 401, Unauthorized

Name	を入力します	必須
を入力します	string	True
タイトル	string	True
詳細	string	True
ステータス	string	True
correlationID	string	False

Name

を入力します

必須

説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

回答例

{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

応答

Status: 400, Bad request

Name	を入力します	必須	説明
を入力します	string	True
タイトル	string	True
詳細	string	True
ステータス	string	True
correlationID	string	False
invalidFields	配列["invalidFields"]	False	無効なリクエストボディフィールドのリスト

Name

を入力します

必須

説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

invalidFields

配列["invalidFields"]

False

無効なリクエストボディフィールドのリスト

回答例

{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

応答

Status: 409, Conflict

Name	を入力します	必須	説明
を入力します	string	True
タイトル	string	True
詳細	string	True
ステータス	string	True
correlationID	string	False
invalidFields	配列["invalidFields"]	False	無効なリクエストボディフィールドのリスト

Name

を入力します

必須

説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

invalidFields

配列["invalidFields"]

False

無効なリクエストボディフィールドのリスト

回答例

{
  "type": "https://astra.netapp.io/problems/10",
  "title": "JSON resource conflict",
  "detail": "The request body JSON contains a field that conflicts with an idempotent value.",
  "status": "409"
}

応答

Status: 403, Forbidden

Name	を入力します	必須
を入力します	string	True
タイトル	string	True
詳細	string	True
ステータス	string	True
correlationID	string	False

Name

を入力します

必須

説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

回答例

{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

エラー

Status: 404, Not found

Name	を入力します	必須
を入力します	string	True
タイトル	string	True
詳細	string	True
ステータス	string	True
correlationID	string	False

Name

を入力します

必須

説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

エラー応答の例

{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

用語の意味

定義を参照

paymentAddress

請求先住所を指定するJSON文字列のコレクションを含むJSONオブジェクト。サブスクリプションの再請求時にのみ指定されます。このキーが存在する場合、含まれている6つのJSON文字列すべてが存在します。ユーザーから何も入力されなかった場合、文字列は空になります。

Name	を入力します	必須	説明
addressCountry	string	True	ISO 3166 Alpha-2で規定されている、郵便住所に関連付けられた国名または国コードを含むJSON文字列。定義された値は次のとおりです：最小長さ：0 最大長さ：2
addressLocality	string	True	郵便番号に関連付けられた地域（例えば、都市）を含むJSON文字列。定義された値は次のとおりです：最小長さ：0 最大長さ：63
addressRegion	string	True	郵便番号に関連付けられた地域（例えば、州）を含むJSON文字列。定義された値は次のとおりです：最小長さ：0 最大長さ：63
postalCode	string	True	郵便番号に関連付けられた郵便番号を含むJSON文字列。定義された値は次のとおりです：最小長さ：0 最大長さ：63
streetAddress1を使用したチャンクアップロード署名要求がサポートされるようになりました。	string	True	郵便番号に関連付けられた番地を含むJSON文字列。定義された値は次のとおりです：最小長さ：0 最大長さ：63
streetAddress2を使用したチャンクアップロード署名要求がサポートされるようになりました。	string	False	オプションの付加的な住所情報（番地、私書箱など）を含むJSON文字列。定義された値は次のとおりです：最小長さ：0 最大長さ：63

Name

を入力します

必須

説明

addressCountry

string

True

ISO 3166 Alpha-2で規定されている、郵便住所に関連付けられた国名または国コードを含むJSON文字列。定義された値は次のとおりです：

最小長さ：0
最大長さ：2

addressLocality

string

True

郵便番号に関連付けられた地域（例えば、都市）を含むJSON文字列。定義された値は次のとおりです：

最小長さ：0
最大長さ：63

addressRegion

string

True

郵便番号に関連付けられた地域（例えば、州）を含むJSON文字列。定義された値は次のとおりです：

最小長さ：0
最大長さ：63

postalCode

string

True

郵便番号に関連付けられた郵便番号を含むJSON文字列。定義された値は次のとおりです：

最小長さ：0
最大長さ：63

streetAddress1を使用したチャンクアップロード署名要求がサポートされるようになりました。

string

True

郵便番号に関連付けられた番地を含むJSON文字列。定義された値は次のとおりです：

最小長さ：0
最大長さ：63

streetAddress2を使用したチャンクアップロード署名要求がサポートされるようになりました。

string

False

オプションの付加的な住所情報（番地、私書箱など）を含むJSON文字列。定義された値は次のとおりです：

最小長さ：0
最大長さ：63

type_astra_label

Name	を入力します	必須	説明
名前	string	True
Value	string	True

Name

を入力します

必須

説明

名前

string

True

Value

string

True

type_astra_metadata_update

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです：

Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。

Name	を入力します	必須
ラベル	配列["type_astra_label"]	False
作成タイムスタンプ	string	False
modificationTimestamp	string	False
作成者	string	False
modifiedBy	string	False

Name

を入力します

必須

説明

ラベル

配列["type_astra_label"]

False

作成タイムスタンプ

string

False

modificationTimestamp

string

False

作成者

string

False

modifiedBy

string

False

invalidParams

Name	を入力します	必須	説明
名前	string	True	無効なクエリパラメータの名前
理由	string	True	クエリパラメータが無効な理由

Name

を入力します

必須

説明

名前

string

True

無効なクエリパラメータの名前

理由

string

True

クエリパラメータが無効な理由

invalidFields

Name	を入力します	必須	説明
名前	string	True	無効なリクエストボディフィールドの名前
理由	string	True	リクエスト本文フィールドが無効な理由

Name

を入力します

必須

説明

名前

string

True

無効なリクエストボディフィールドの名前

理由

string

True

リクエスト本文フィールドが無効な理由

新しいサブスクリプションを作成する

Creating your file...

パラメータ

要求の本文

応答

応答

応答

応答

応答

エラー

用語の意味