Skip to main content

退訂席位

退訂單一未使用席位。

前提條件

已取得阿里雲帳號或 RAM 使用者的 AccessKey,並已為其授予呼叫 BssOpenApi 所需的 RAM 權限。建議將 AccessKey 設定為環境變數 ALIBABA_CLOUD_ACCESS_KEY_ID 和 ALIBABA_CLOUD_ACCESS_KEY_SECRET,避免以明文寫入程式碼。 已取得待退訂席位的 InstanceId。可從查詢訂閱席位明細返回的 InstanceCode 取得。僅未使用 Credits 的席位支援退訂。

請求說明

  • HTTP 方法:POST
  • 請求 URL

    地域

    Endpoint

    新加坡

    POST https://business.ap-southeast-1.aliyuncs.com/

  • 認證方式 本介面屬於 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

是

產品代碼。透過 QueryProductList 取得,例如 sfm。

ProductType

string

是

產品類型。透過 QueryProductList 取得,例如 sfm_tokenplanteams_dp_intl。

SubscriptionType

string

是

訂閱類型。透過 QueryProductList 取得,例如 Subscription。

ClientToken

string

是

冪等性權杖。由客戶端產生,需保證不同請求間唯一,最大 64 個 ASCII 字元。

InstanceId

string

是

待退訂的席位執行個體 ID。僅支援未使用 Credits 的席位。

外層 Success 表示請求是否被受理,退款結果以 Data.Success 為準。失敗時查看 Data.ErrorInfo 和 Data.ErrorCode。

返回參數

參數

類型

描述

RequestId

string

請求 ID。

Success

boolean

是否成功。

Code

string

結果碼,成功為 Success。

Message

string

結果描述。

Data

object

業務資料。

Data.InstanceId

string

執行個體 ID。

Data.Success

boolean

退款是否成功。

Data.ErrorInfo

string

失敗時的錯誤訊息。

Data.ErrorCode

string

失敗時的錯誤碼。

Data.HostId

string

站點識別碼。部分回應可能不返回該欄位。

AccessDeniedDetail

string

RAM 權限被拒絕時的詳細錯誤訊息。

請求範例

本介面使用 BssOpenApi 的 RPC 簽名。下例中 ${SIGNATURE} 需按簽名演算法計算,SignatureNonce 和 Timestamp 需替換為實際值。使用阿里雲 SDK 時會自動處理公共參數和簽名。
curl -X POST "https://business.ap-southeast-1.aliyuncs.com/" \
    --data-urlencode "Action=ReduceCreditSeats" \
    --data-urlencode "Version=2023-09-30" \
    --data-urlencode "Format=JSON" \
    --data-urlencode "AccessKeyId=${ALIBABA_CLOUD_ACCESS_KEY_ID}" \
    --data-urlencode "SignatureMethod=HMAC-SHA1" \
    --data-urlencode "SignatureVersion=1.0" \
    --data-urlencode "SignatureNonce=${SIGNATURE_NONCE}" \
    --data-urlencode "Timestamp=2026-01-01T12:00:00Z" \
    --data-urlencode "Signature=${SIGNATURE}" \
    --data-urlencode "ProductCode=sfm" \
    --data-urlencode "ProductType=sfm_tokenplanteams_dp_intl" \
    --data-urlencode "SubscriptionType=Subscription" \
    --data-urlencode "ClientToken=example-client-token-001" \
    --data-urlencode "InstanceId=subs-example0000000004"

返回範例

{
  "RequestId": "request-id-example",
  "Success": true,
  "Code": "Success",
  "Message": "Successful!",
  "Data": {
    "Success": true
  }
}

錯誤碼

如果呼叫失敗,會返回錯誤訊息。更多錯誤碼及解決方法,請參見 BssOpenApi 錯誤碼。