Skip to main content
24.02
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

すべてのサブスクリプションを一覧表示

PDF

GET /accounts/{account_id}/core/v1/subscriptions

コレクション内の一致するすべてのリソースのJSON配列を返します。リクエストで個別のフィールドが指定されている場合、アイテムのJSON配列には、一致する各リソースに対して要求されたフィールドが、指定された順序で含まれます。

パラメータ

Name を入力します 入力 必須 説明

account_id

string

path（パス）

True

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

  • 例：{{.Account}}

続行

query

False

リストの表示を再開するトークンを示します。

URLの例："continue="

OpenAPIの例：""</continue>

カウント

string

query

False

メタデータオブジェクトで返されるリソースの総数。

URLの例："count=true"

OpenAPI の例："true"

フィルタ

string

query

False

コレクションを一覧表示する際に、リソースを返すためにどのフィールドを一致させる必要があるかを示します。

サポートされているオペレータは次のとおりです：

  • eq - 等号

  • lt/gt - より小さい/より大きい

  • lte/gte - 以下/以上

URLの例："filter=field%20eq%20%27value%27"

OpenAPI の例：「field eq 'value'」

含める

string

query

False

コレクションを一覧表示する際に、どのフィールドを返すかを指定します。

URLの例："include=id"、"include=id,name"

OpenAPI の例："id"

制限（ Limit ）

string

query

False

コレクションを一覧表示する際に返されるリソースの最大数を示します。

URLの例："limit=2"

OpenAPI の例："2"

OrderBy

string

query

False

コレクションを一覧表示する際の、リソースの並び順を示します。

URLの例："orderBy=name"、"orderBy=name%20desc"

OpenAPI の例："name desc"

スキップします

string

query

False

コレクションを一覧表示する際にスキップするリソースの数を指定します。

URLの例：「skip=1」

OpenAPI の例："1"

応答

Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
Name を入力します 必須 説明

項目

配列[いずれか："subscription_1.2_get_response_body"、配列[]]

True

メタデータ

"type_astra_metadata_list"

True
回答例 
{
  "type": "application/astra-subscriptions",
  "version": "1.2",
  "items": [
    {
      "type": "application/astra-subscription",
      "version": "1.1",
      "id": "d4c865c9-64a7-4661-ae4a-3307dffcd3da",
      "customerProfileID": "2157047189",
      "paymentProfileID": "E7CEB0A9F1BECA32A02493E1B31D5955",
      "paymentExpiry": "2022-02-01T00:00:00Z",
      "purchaseOrderNumber": "72384632",
      "marketplace": "netapp",
      "licenseSN": "278343",
      "terms": "trial",
      "status": "inactive",
      "appLimit": 0,
      "namespaceLimit": 10,
      "subscriptionPeriod": 90,
      "gracePeriod": 7,
      "reminderBeforePeriod": 30,
      "onboardStatus": "success",
      "costPerAppUnit": 0,
      "costPerNamespaceUnit": 0.005,
      "metadata": {
        "labels": [],
        "creationTimestamp": "2020-05-06T12:24:52.256624Z",
        "modificationTimestamp": "2020-05-06T12:24:52.256624Z",
        "createdBy": "11c0cfa1-4f27-4ef7-a21c-cb452fc5c9aa"
      }
    },
    {
      "type": "application/astra-subscription",
      "version": "1.1",
      "id": "4c43ed8b-078f-4fe3-b8c6-5d515f6382e6",
      "customerProfileID": "2157047189",
      "paymentProfileID": "E7CEB0A9F1BECA32A02493E1B31D5955",
      "paymentExpiry": "2022-05-01T00:00:00Z",
      "purchaseOrderNumber": "92374658",
      "marketplace": "netapp",
      "licenseSN": "374623",
      "terms": "paid",
      "status": "active",
      "appLimit": 0,
      "namespaceLimit": -1,
      "subscriptionPeriod": -1,
      "gracePeriod": -1,
      "reminderBeforePeriod": -1,
      "onboardStatus": "success",
      "costPerAppUnit": 0,
      "costPerNamespaceUnit": 0.005,
      "metadata": {
        "labels": [],
        "creationTimestamp": "2020-08-06T12:24:52.256624Z",
        "modificationTimestamp": "2020-08-06T12:24:52.256624Z",
        "createdBy": "11c0cfa1-4f27-4ef7-a21c-cb452fc5c9aa"
      }
    }
  ],
  "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
回答例 
{
  "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

invalidParams

配列["invalidParams"]

False

無効なクエリパラメータのリスト
回答例 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

応答

Status: 403, Forbidden
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
エラー応答の例 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

用語の意味

定義を参照

type_astra_label

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

subscription_1.2_get_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 は、変更なしで保持されます。

type_astra_metadata_list

Name を入力します 必須 説明

続行

string

False

カウント

番号

False

ラベル

配列["type_astra_label"]

False

作成タイムスタンプ

string

False

modificationTimestamp

string

False

作成者

string

False

modifiedBy

string

False

invalidParams

Name を入力します 必須 説明

名前

string

True

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

理由

string

True

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