You need to enable JavaScript to run this app.
导航
证书中心
  • 文档首页
    • /证书中心/SSL证书/API参考/SSL证书接口/管理证书订单
管理证书订单
最近更新时间：2024.06.24 15:32:01首次发布时间：2023.10.19 10:52:38
我的收藏

调用本接口对证书订单进行以下任一操作：推进订单、吊销证书、取消订单。

使用说明

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

注意事项

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

请求说明

  • 接口名称：CertificateProgressInstanceOrder
  • 请求方式：POST
  • 请求地址：open.volcengineapi.com

调试

暂不支持。

请求参数

下方表格中的参数包含在请求头（header）中。

参数类型是否必选描述示例值
Regionstring是服务地区。该参数的取值是cn-north-1。cn-north-1
ServiceNamestring是服务名称。该参数的取值是certificate_service。certificate_service

Query

下方表格中的参数包含在查询字符串（query string）中。

参数类型是否必选描述示例值
Actionstring是API名称。该参数的取值是CertificateProgressInstanceOrder。CertificateProgressInstanceOrder
Versionstring是API版本。该参数的取值是2021-06-01。2021-06-01

instance_id

String

是

要操作的证书实例的ID。

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

cert-46d8415d27374dfc8ea6caab0141****

Body

下方表格中的参数包含在请求体（request body）中。

参数类型是否必选描述示例值

action

String

否

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

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

revoke

reason

String

否

吊销证书的原因。

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

关联域名错误

返回参数

本接口无特有的返回参数。更多信息，请参见返回结构。

请求示例

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请求失败。您可访问公共错误码，获取更多错误码信息。