Skip to main content
Astra Automation
此產品有較新版本可以使用。
本繁體中文版使用機器翻譯，譯文僅供參考，若與英文版本牴觸，應以英文版本為準。

擷取訂閱

PDF

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

在 JSON 回應本文中傳回已儲存的 Subscription API 資源。

參數

Name 類型 在 必要 說明

account_id

字串

路徑

True

包含帳戶資源的 ID

  • 範例：{{.Account}}

subscription_id

字串

路徑

True

要列出的訂閱集合 ID

回應

Status: 200, Returns the stored Subscription API resource in the JSON response body.
Name 類型 必要 說明

類型

字串

True

資源的媒體類型。定義的值為：

  • "application/astra-subscription"

版本

字串

True

資源版本。定義的值為：

  • "1.0"

  • "1.1"

  • "1.2"

ID

字串

True

資源的全域唯一識別碼。定義的值為：

  • 符合 UUIDv4 架構

customerProfileID

字串

True

包含客戶資料 ID 的 JSON 字串 "Authorize.net"（由 UI 呼叫）在試用期內未設定。如果未設定，則在讀取操作期間傳回空字串。定義的值為：

  • 最短長度：0

  • 最大長度：63

paymentProfileID

字串

錯誤

包含由使用者介面呼叫的 "Authorize.net"支付設定檔 ID 的 JSON 字串，未設定為試用期。如果未設定，則在讀取操作期間傳回空字串。定義的值為：

  • 最短長度：0

  • 最大長度：63

paymentExpiry

字串

錯誤

包含時間戳記的 JSON 字串，指示付款方式的到期時間。此資訊來自 authorize.net](http://authorize.net，並由使用者介面設定。定義的值為：

  • 符合 ISO-8601 日期時間架構。試用條款不會傳回此欄位。

purchaseOrderNumber

字串

錯誤

包含付款方式採購訂單號碼的 JSON 字串。定義的值為：

  • 最短長度：1

  • 最大長度：31

市集

字串

錯誤

JSON 字串，用於指示帳戶的市場，付款資訊將在該市場上記錄。定義值：

  • "netapp"

  • "azure"

  • "aws"

  • "gcp"

licenseSN

字串

錯誤

包含付款方式授權序號的 JSON 字串。定義的值為：

  • 最短長度：1

  • 最大長度：31

條款

字串

True

表示帳戶目前層級的 JSON 字串。定義的值為：

  • 「trial」

  • 「paid」

狀態

字串

True

表示訂閱目前狀態的 JSON 字串。定義的值為：

  • "active"

  • 「inactive」

appLimit

數字

True

JSON 數字表示此訂閱的應用程式限制。值為 -1 表示無限制。

namespaceLimit

數字

True

JSON 數字表示此訂閱的命名空間限制。值為 -1 表示無限制。

subscriptionPeriod

數字

True

JSON 數值，表示訂閱週期。值為 -1 表示無限制。單位：天

gracePeriod

數字

True

JSON 數值，表示試用訂閱到期或付費訂閱取消後的寬限期。單位：天

reminderBeforePeriod

數字

True

JSON 數字，表示試用訂閱結束前幾天開始向客戶發送通知。該值以天為單位，值為 -1 表示不適用。

onboardStatus

字串

True

指示客戶註冊目前狀態的 JSON 字串。有效值為 "not started"、"in progress"、"success"、"failed"。定義的值為：

  • 「未開始」

  • 「進行中」

  • 「success」

  • 「失敗」

costPerAppUnit

數字

True

JSON 數字表示每個應用程式單元的成本。試用版的值為 0。單位：美元

costPerNamespaceUnit

數字

True

JSON 數字，表示每個命名空間單位的成本。試用版的值為 0。單位：美元

中繼資料

"type_astra_metadata_update"

True

與資源相關聯的用戶端和服務指定中繼資料。定義的值為：

  • 符合 Astra Metadata Schema。如果在建立時未指定、則會建立沒有標籤的中繼資料物件。如果在更新時未指定，元資料物件的標籤、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",
  "onboardStatus": "success",
  "costPerAppUnit": 0,
  "costPerNamespaceUnit": 0.005,
  "appLimit": 0,
  "namespaceLimit": 10,
  "subscriptionPeriod": 90,
  "gracePeriod": 7,
  "reminderBeforePeriod": 30,
  "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 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

狀態

字串

True

correlationID

字串

錯誤
範例回應 
{
  "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 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

狀態

字串

True

correlationID

字串

錯誤

invalidParams

陣列["invalidParams"]

錯誤

無效查詢參數清單
範例回應 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

回應

Status: 403, Forbidden
Name 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

狀態

字串

True

correlationID

字串

錯誤
範例回應 
{
  "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 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

狀態

字串

True

correlationID

字串

錯誤
範例錯誤回應 
{
  "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 類型 必要 說明

姓名

字串

True

值

字串

True

type_astra_metadata_update

與資源相關聯的用戶端和服務指定中繼資料。定義的值為：

  • 符合 Astra Metadata Schema。如果在建立時未指定、則會建立沒有標籤的中繼資料物件。如果在更新時未指定，元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。

Name 類型 必要 說明

標籤

陣列["type_astra_label"]

錯誤

建立時間戳記

字串

錯誤

修改時間戳記

字串

錯誤

建立者

字串

錯誤

modifiedBy

字串

錯誤

invalidParams

Name 類型 必要 說明

姓名

字串

True

無效查詢參數的名稱

原因

字串

True

查詢參數無效的原因