文档首页/ 云证书管理服务 CCM/ API参考/ API说明/ 管理私有证书/ 私有证书管理/ 吊销证书
更新时间：2024-10-24 GMT+08:00
在线调试
CLI示例
查看PDF
分享

吊销证书

功能介绍

吊销证书。

注：当不想填写吊销理由时，请求body体请置为"{}"，否则将会报错。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/private-certificates/{certificate_id}/revoke

表1 路径参数

参数

是否必选

参数类型

描述

certificate_id

是

String

所要吊销的私有证书ID。

最小长度：36

最大长度：36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

最小长度：32

最大长度：2097152
表3 请求Body参数

参数

是否必选

参数类型

描述

reason

否

String

吊销理由，支持以下选项：

  • UNSPECIFIED : 吊销时未指定吊销原因，为默认值；
  • KEY_COMPROMISE : 证书密钥材料泄露；
  • CERTIFICATE_AUTHORITY_COMPROMISE : 颁发路径上，可能存在CA密钥材料泄露；
  • AFFILIATION_CHANGED : 证书中的主体或其他信息已经被改变；
  • SUPERSEDED : 此证书已被取代；
  • CESSATION_OF_OPERATION : 此证书或颁发路径中的实体已停止运营；
  • CERTIFICATE_HOLD : 该证书当前不应被视为有效，预计将来可能会生效；
  • PRIVILEGE_WITHDRAWN : 此证书不再具备其声明的属性的权限；
  • ATTRIBUTE_AUTHORITY_COMPROMISE : 担保此证书属性的机构可能已受到损害。
说明：

当不想填写吊销理由时，请求body体请置为"{}"，否则将会报异常，默认值为UNSPECIFIED。

响应参数

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度：3

最大长度：36

error_msg

String

错误请求返回的错误信息。

最小长度：0

最大长度：1024

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度：3

最大长度：36

error_msg

String

错误请求返回的错误信息。

最小长度：0

最大长度：1024

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度：3

最大长度：36

error_msg

String

错误请求返回的错误信息。

最小长度：0

最大长度：1024

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度：3

最大长度：36

error_msg

String

错误请求返回的错误信息。

最小长度：0

最大长度：1024

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误请求返回的错误码。

最小长度：3

最大长度：36

error_msg

String

错误请求返回的错误信息。

最小长度：0

最大长度：1024

请求示例

吊销证书，请求头中的X-Auth-Token字段需要填写token，且该token需要具有本API的访问权限。

POST https://{Endpoint}/v1/private-certificates/6434f74f-2d13-4e6a-89eb-93ee313f1a43/revoke

{
  "reason" : "KEY_COMPROMISE"
}

响应示例

状态码： 400

请求参数有误。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码： 401

被请求的页面需要鉴权。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码： 403

认证失败。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码： 404

资源不存在或资源未找到。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码： 500

服务内部错误。

{
  "error_code" : "PCA.XXX",
  "error_msg" : "XXX"
}

状态码

状态码

描述

204

请求已成功，无响应body

400

请求参数有误。

401

被请求的页面需要鉴权。

403

认证失败。

404

资源不存在或资源未找到。

500

服务内部错误。

错误码

请参见错误码。

父主题： 私有证书管理

相关文档