對席位訂閱進行整體續費。
前提條件
已取得阿里雲帳號或 RAM 使用者的 AccessKey,並已為其授予呼叫 BssOpenApi 所需的 RAM 權限。建議將 AccessKey 設定為環境變數 ALIBABA_CLOUD_ACCESS_KEY_ID 和 ALIBABA_CLOUD_ACCESS_KEY_SECRET,避免以明文寫入程式碼。
已有一個有效的 Token Plan 團隊版席位訂閱,並已透過 QueryProductList 取得 ProductCode、ProductType 和 SubscriptionType。
請求說明
- HTTP 方法:POST
-
請求 URL
地域
Endpoint
新加坡
-
認證方式
本介面屬於 BssOpenApi(版本
2023-09-30),採用 AccessKey 簽名(RPC 簽名,HMAC-SHA1),不支援Authorization: Bearer {API_KEY}方式。推薦使用阿里雲 SDK 的CommonRequest發起呼叫,SDK 會自動產生公共參數並計算簽名。
請求參數
全部參數透過表單或 Query String 傳遞。陣列參數使用 Flat 格式:Configs.1.Code、Configs.1.Value,序號從 1 開始。
參數 | 類型 | 必選 | 描述 |
|---|---|---|---|
ProductCode | string | 是 | 產品代碼。透過 |
ProductType | string | 是 | 產品類型。透過 |
SubscriptionType | string | 是 | 訂閱類型。透過 |
ClientToken | string | 是 | 冪等性權杖。由客戶端產生,需保證不同請求間唯一,最大 64 個 ASCII 字元。 |
Period | integer | 是 | 付費週期數,至少為 1。 |
PeriodUnit | string | 是 | 付費週期單位。取值: |
AutoRenew | boolean | 否 | 是否開啟自動續費。 |
返回參數
參數 | 類型 | 描述 |
|---|---|---|
RequestId | string | 請求 ID。 |
Success | boolean | 是否成功。 |
Code | string | 結果碼,成功為 |
Message | string | 結果描述。 |
Data | object | 業務資料。 |
Data.OrderId | long | 訂單 ID。 |
Data.HostId | string | 站點識別碼。部分回應可能不返回該欄位。 |
AccessDeniedDetail | string | RAM 權限被拒絕時的詳細錯誤訊息。 |
請求範例
本介面使用 BssOpenApi 的 RPC 簽名。下例中 ${SIGNATURE} 需按簽名演算法計算,SignatureNonce 和 Timestamp 需替換為實際值。使用阿里雲 SDK 時會自動處理公共參數和簽名。
返回範例
錯誤碼
續費場景的常見錯誤碼:INSTANCE_HOLDING_LIMIT_EXCEEDED、MissingParameter、ResourceNotExists。
如果呼叫失敗,會返回錯誤訊息。更多錯誤碼及解決方法,請參見 BssOpenApi 錯誤碼。