Skip to main content

シートの解約

未使用のシートを 1 つ解約します。

前提条件

Alibaba Cloud アカウントまたは 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} 方式はサポートされません。Alibaba Cloud SDK の CommonRequest を使用した呼び出しを推奨します。SDK が共通パラメーターと署名を自動的に処理します。

リクエストパラメーター

すべてのパラメーターはフォームまたは Query String で渡します。配列パラメーターは Flat 形式（Configs.1.Code など）を使用し、番号は 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 は実際の値に置き換えてください。Alibaba Cloud 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 エラーコードを参照してください。