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

修改訂閱

PDF

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

將整個儲存的資源替換為提供的 JSON 請求主體，同時保留使用者不可修改的鍵值。

副作用

  • 如果使用者取消訂閱，則必須使用 "status": "inactive" 呼叫 PUT 端點。

  • 當狀態設定為「非活動」時，此訂閱的待處理費用將發送給 Zuora，並且 Zuora 訂閱將以某種方式標記為「非活動」。

參數

Name 類型 在 必要 說明

account_id

字串

路徑

True

包含帳戶資源的 ID

  • 範例：{{.Account}}

subscription_id

字串

路徑

True

要列出的訂閱集合 ID

請求本文

將整個儲存的資源替換為提供的 JSON 請求主體，同時保留使用者不可修改的鍵值。

副作用

  • 如果使用者取消訂閱，則必須使用 "status": "inactive" 呼叫 PUT 端點。

  • 當狀態設定為「非活動」時，此訂閱的待處理費用將發送給 Zuora，並且 Zuora 訂閱將以某種方式標記為「非活動」。

Name 類型 必要 說明

類型

字串

True

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

  • "application/astra-subscription"

版本

字串

True

資源版本。已定義值包括：

  • "1.0"

  • "1.1"

  • "1.2"

ID

字串

錯誤

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

  • 符合 UUIDv4 架構

customerProfileID

字串

錯誤

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

  • 最短長度：0

  • 最大長度：63

paymentFirstName

字串

錯誤

包含使用者指定的用於支付帳單的完整名字的 JSON 字串。僅在重新計費訂閱時指定。已定義的值包括：

  • 最短長度：1

  • 最大長度：63

paymentLastName

字串

錯誤

包含使用者指定的用於付款帳單的完整姓氏的 JSON 字串。僅在重新計費訂閱時指定。定義的值為：

  • 最短長度：1

  • 最大長度：63

paymentAddress

"paymentAddress"

錯誤

包含一組 JSON 字串的 JSON 物件，用於指定帳單地址。僅在重新計費訂閱時指定。如果此金鑰存在，則包含的所有六個 JSON 字串都將存在。如果使用者未提供任何資訊，則該字串為空白。

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

條款

字串

錯誤

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

  • 「trial」

  • 「paid」

狀態

字串

錯誤

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

  • "active"

  • 「inactive」

appLimit

數字

錯誤

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

namespaceLimit

數字

錯誤

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

subscriptionPeriod

數字

錯誤

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

gracePeriod

數字

錯誤

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

reminderBeforePeriod

數字

錯誤

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

onboardStatus

字串

錯誤

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

  • 「未開始」

  • 「進行中」

  • 「success」

  • 「失敗」

costPerAppUnit

數字

錯誤

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

costPerNamespaceUnit

數字

錯誤

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

中繼資料

"type_astra_metadata_update"

錯誤

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

  • 遵循 Astra Metadata Schema。如果在建立時未指定，則建立的元資料物件將不帶任何標籤。如果在更新時未指定，元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。
範例請求 
{
  "type": "application/astra-subscription",
  "version": "1.2",
  "customerProfileID": "2157047189",
  "paymentProfileID": "E7CEB0A9F1BECA32A02493E1B31D5955",
  "paymentExpiry": "2022-05-01T00:00:00Z"
}

回應

Status: 204, Indicates if the subscription resource was updated.

回應

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

字串

錯誤

invalidFields

陣列["invalidFields"]

錯誤

無效請求本文欄位清單
範例回應 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

回應

Status: 409, Conflict
Name 類型 必要 說明

類型

字串

True

標題

字串

True

詳細資料

字串

True

狀態

字串

True

correlationID

字串

錯誤

invalidFields

陣列["invalidFields"]

錯誤

無效請求本文欄位清單
範例回應 
{
  "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 類型 必要 說明

類型

字串

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/1",
  "title": "Resource not found",
  "detail": "The resource specified in the request URI wasn't found.",
  "status": "404"
}

定義

請參閱定義

paymentAddress

包含一組 JSON 字串的 JSON 物件，用於指定帳單地址。僅在重新計費訂閱時指定。如果此金鑰存在，則包含的所有六個 JSON 字串都將存在。如果使用者未提供任何資訊，則該字串為空白。

Name 類型 必要 說明

addressCountry

字串

True

包含與郵政地址關聯的國家/地區名稱或國家/地區代碼的 JSON 字串，如 ISO 3166 Alpha-2 中所指定。定義的值為：

  • 最短長度：0

  • 最大長度：2

addressLocality

字串

True

包含與郵寄地址相關聯的地區（例如城市）的 JSON 字串。定義的值為：

  • 最短長度：0

  • 最大長度：63

addressRegion

字串

True

包含與郵寄地址關聯的區域（例如，州/省）的 JSON 字串。已定義的值包括：

  • 最短長度：0

  • 最大長度：63

postalCode

字串

True

包含與郵遞地址相關聯之郵遞區號的 JSON 字串。已定義的值包括：

  • 最短長度：0

  • 最大長度：63

streetAddress1

字串

True

包含與郵寄地址相關聯之街道地址的 JSON 字串。定義的值為：

  • 最短長度：0

  • 最大長度：63

streetAddress2

字串

錯誤

包含選用輔助街道地址資訊、郵政信箱等的 JSON 字串。已定義的值包括：

  • 最短長度：0

  • 最大長度：63

type_astra_label

Name 類型 必要 說明

姓名

字串

True

值

字串

True

type_astra_metadata_update

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

  • 遵循 Astra Metadata Schema。如果在建立時未指定，則建立的元資料物件將不帶任何標籤。如果在更新時未指定，元資料物件的標籤、creationTimestamp 和 createdBy 將保持不變。

Name 類型 必要 說明

標籤

陣列["type_astra_label"]

錯誤

建立時間戳記

字串

錯誤

修改時間戳記

字串

錯誤

建立者

字串

錯誤

modifiedBy

字串

錯誤

invalidParams

Name 類型 必要 說明

姓名

字串

True

無效查詢參數的名稱

原因

字串

True

查詢參數無效的原因

invalidFields

Name 類型 必要 說明

姓名

字串

True

無效請求內文欄位的名稱

原因

字串

True

請求本文欄位無效的原因