You need to enable JavaScript to run this app.
导航

管理证书订单

最近更新时间2024.01.02 15:54:55

首次发布时间2023.10.19 10:52:38

API说明

API名称:CertificateProgressInstanceOrder
API域名:open.volcengineapi.com
API描述:调用本接口对证书订单进行以下任一操作:推进订单、吊销证书、取消订单。

  • 推进订单:请求CA机构检查域名验证配置。
  • 吊销证书:向CA机构提交SSL证书吊销请求。
  • 取消订单:取消SSL证书订单。该操作仅在以下情形下支持:(1)证书没有签发;(2)证书已经签发,但自签发证书起经过的时间不超过5个自然日。取消订单后,已签发的证书将被吊销,并且您可以获得全额退款。

请求方法

POST

使用限制

QPS 限制:同一个租户每秒最多允许请求20次。

公共参数

下方表格中的公共参数必须包含在请求头(header)中。

参数名称

数据类型

是否必选

参数说明

Region

String

服务地区。该参数的取值是cn-north-1

ServiceName

String

服务名称。该参数的取值是certificate_service

下方表格中的公共参数必须包含在查询字符串(query string)中。

参数名称

数据类型

是否必选

参数说明

Action

String

API名称。该参数的取值是CertificateProgressInstanceOrder

Version

String

API版本。该参数的取值是2021-06-01

请求参数

下方表格中参数的类型是查询参数。

参数名称

数据类型

是否必选

参数说明

示例

instance_id

String

要操作的证书实例的ID。

您可以调用CertificateGetInstance接口获取所有证书实例的ID。

cert-46d8415d27374dfc8ea6caab0141****

下方表格中参数的类型是请求体参数。

参数名称

数据类型

是否必选

参数说明

示例

action

String

对证书订单执行的操作的类型。该参数有以下取值:

  • 为空:表示推进订单。
  • revoke:表示吊销证书。
  • cancel:表示取消订单。

revoke

reason

String

吊销证书的原因。

如果action的值是revoke,该参数值不允许为空。

关联域名错误

响应正文

操作成功时,响应正文(Result)为空。

示例

请求示例

POST https://open.volcengineapi.com/?Action=CertificateProgressInstanceOrder&Version=2021-06-01&instance_id=cert-46d8415d27374dfc8ea6caab0141****&<其他公共请求参数>
{
    "action": "revoke",
    "reason": "关联域名错误"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "2023011818525862987CA4D7FB7503D0F7",
        "Action": "CertificateProgressInstanceOrder",
        "Version": "2021-06-01",
        "Service": "certificate_service",
        "Region": "cn-north-1"
    },
    "Result": null
}

错误代码

如果响应正文的ResponseMetadata字段中包含Error字段,则表示API请求失败。关于更多错误码的信息,参见错误码说明