You need to enable JavaScript to run this app.
导航
CancelInstance - 取消证书订单
最近更新时间:2025.01.10 11:55:54首次发布时间:2024.11.13 19:44:18

调用本接口取消一个SSL证书订单。

使用说明

当您成功取消一个付费证书订单时,您为该订单支付的费用将通过原付款方式退还给您。

注意事项

当您的SSL证书订单满足以下任一条件时,您可以取消该订单:

  • 您尚未提交证书请求。
  • 证书尚未签发。
  • 自证书签发以来不超过5个自然日。

请求说明

请求频率:同一个租户每秒最多允许请求20次。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数
类型
是否必填
示例值
描述
Action
String

CancelInstance

要执行的操作,取值:CancelInstance。

Version
String

2024-10-01

API的版本,取值:2024-10-01。

Body

参数
类型
是否必填
示例值
描述
Reason
String

wrong information

取消此证书订单的原因。

InstanceId
String

cert-5fea76da5ec54e2999819ffc9354****

待取消订单对应的证书实例ID。

您可以调用CertificateGetInstanceList接口获取所有证书实例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
The request is malformed

请求参数格式不合法。

400
MissingParameter
The required parameter %s is missing.

缺少必填参数。

400
NotFound.CertificateInstance
The specified certificate was not found.

未找到指定的证书。

400
Expired.Certificate
Unable to do this operation because the certificate has expired.

证书已过期,不支持该操作。

400
InvalidStatus.Instance
Unable to do this operation because the certificate status not meeting the requirements.

当前证书状态不支持进行该操作。

400
Revoked.Certificate
Unable to do this operation because the certificate has been revoked.

证书已吊销,不支持该操作。

400
OperationDenied.InvalidCancelPeriod
Unable to cancel this order because more than 5 calendar days have passed since the certificate was successfully issued.

证书已签发,且超过可取消期限,不支持取消。

500
InternalError
The request has failed due to an unknown error.

未知错误。