调用本接口取消一个SSL证书订单。
当您成功取消一个付费证书订单时,您为该订单支付的费用将通过原付款方式退还给您。
当您的SSL证书订单满足以下任一条件时,您可以取消该订单:
请求频率:同一个租户每秒最多允许请求20次。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CancelInstance | 要执行的操作,取值:CancelInstance。 |
Version | String | 是 | 2024-10-01 | API的版本,取值:2024-10-01。 |
参数 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Reason | String | 否 | wrong information | 取消此证书订单的原因。 |
InstanceId | String | 是 | cert-5fea76da5ec54e2999819ffc9354**** | 待取消订单对应的证书实例ID。
|
本接口无特有的返回参数。更多信息请见返回结构。
POST /?Action=CancelInstance&Version=2024-10-01 HTTP/1.1 Host: open.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20241105T061409Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241105/cn-beijing/certificate_service/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f { "Reason": "wrong information", "InstanceId": "cert-5fea76da5ec54e2999819ffc9354****" }
{ "ResponseMetadata": { "RequestId": "202501091759071352441511639171A5", "Action": "CancelInstance", "Version": "2024-10-01", "Service": "certificate_service", "Region": "cn-beijing" }, "Result": {} }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
---|---|---|
400 | MalformedRequest | 请求参数格式不合法。 |
400 | MissingParameter | 缺少必填参数。 |
400 | NotFound.CertificateInstance | 未找到指定的证书。 |
400 | Expired.Certificate | 证书已过期,不支持该操作。 |
400 | InvalidStatus.Instance | 当前证书状态不支持进行该操作。 |
400 | Revoked.Certificate | 证书已吊销,不支持该操作。 |
400 | OperationDenied.InvalidCancelPeriod | 证书已签发,且超过可取消期限,不支持取消。 |
500 | InternalError | 未知错误。 |