退订席位

更新时间:
复制 MD 格式

退订单个未使用的席位。

前提条件

已获取阿里云账号或 RAM 用户的 AccessKey,并已为其授予调用 BssOpenApi 所需的 RAM 权限。建议将 AccessKey 配置为环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID 和 ALIBABA_CLOUD_ACCESS_KEY_SECRET,避免明文写入代码。

已获取待退订席位的 InstanceId。可从查询订阅席位明细返回的 InstanceCode 获取。仅未使用 Credits 的席位支持退订。

请求说明

  • HTTP 方法:POST

  • 请求地址

    地域

    Endpoint

    中国站

    POST https://business.aliyuncs.com/

  • 认证方式

    本接口属于 BssOpenApi(版本 2023-09-30),采用 AccessKey 签名(RPC 签名,HMAC-SHA1),不支持 Authorization: Bearer {API_KEY} 方式。

    推荐使用阿里云 SDK 的 CommonRequest 发起调用,SDK 会自动生成公共参数并计算签名。

请求参数

全部参数通过表单或 Query String 传递。

参数

类型

必选

描述

ProductCode

string

是

产品代码。通过 QueryProductList 获取,例如 sfm。

ProductType

string

是

产品类型。通过 QueryProductList 获取,例如 sfm_tokenplanteams_dp_cn。

SubscriptionType

string

是

订阅类型。通过 QueryProductList 获取,例如 Subscription。

ClientToken

string

是

幂等性令牌。由客户端生成,需保证不同请求间唯一,最大 64 个 ASCII 字符。

InstanceId

string

是

待退订的席位实例 ID。仅支持未使用 Credits 的席位。

返回参数

参数

类型

描述

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

站点标识。中国站返回 cn;部分响应可能不返回该字段。

AccessDeniedDetail

string

RAM 权限被拒绝时的详细错误信息。

外层 Success 表示请求是否被受理,退款结果以 Data.Success 为准。失败时查看 Data.ErrorInfo 和 Data.ErrorCode。

请求示例

本接口使用 BssOpenApi 的 RPC 签名。下例中 ${SIGNATURE} 需按签名算法计算,SignatureNonce 和 Timestamp 需替换为实际值。使用阿里云 SDK 时会自动处理公共参数和签名。

curl -X POST "https://business.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_cn" \
    --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 错误码。