# 吊销证书 - RevokeCertificate #### 功能介绍 吊销证书。 ![](https://support.huaweicloud.com/api-ccm/public_sys-resources/note_3.0-zh-cn.png) 注：当不想填写吊销理由时，请求body体请置为"**{}**"，否则将会报错。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CCM/doc?api=RevokeCertificate)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ccm/ccm_02_0039.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | pca:ca:revokeCert | Write | ca \* | g:ResourceTag/\ | pca:cert:revoke | - | | pca:ca:revokeCert | Write | - | g:EnterpriseProjectId | pca:cert:revoke | - | #### 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的值）。 | 表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。 | #### 响应参数 **状态码：204** 请求已成功，无响应body **状态码：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://ccm.cn-north-4.myhuaweicloud.com/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" } ``` #### SDK代码示例 SDK代码示例如下。 #### Java 吊销证书，请求头中的**X-Auth-Token**字段需要填写token，且该token需要具有本API的访问权限。 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.ccm.v1.region.CcmRegion; import com.huaweicloud.sdk.ccm.v1.*; import com.huaweicloud.sdk.ccm.v1.model.*; public class RevokeCertificateSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); CcmClient client = CcmClient.newBuilder() .withCredential(auth) .withRegion(CcmRegion.valueOf("")) .build(); RevokeCertificateRequest request = new RevokeCertificateRequest(); request.withCertificateId("{certificate_id}"); RevokeCertificateRequestBody body = new RevokeCertificateRequestBody(); body.withReason("KEY_COMPROMISE"); request.withBody(body); try { RevokeCertificateResponse response = client.revokeCertificate(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` #### Python 吊销证书，请求头中的**X-Auth-Token**字段需要填写token，且该token需要具有本API的访问权限。 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkccm.v1.region.ccm_region import CcmRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkccm.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = CcmClient.new_builder() \ .with_credentials(credentials) \ .with_region(CcmRegion.value_of("")) \ .build() try: request = RevokeCertificateRequest() request.certificate_id = "{certificate_id}" request.body = RevokeCertificateRequestBody( reason="KEY_COMPROMISE" ) response = client.revoke_certificate(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` #### Go 吊销证书，请求头中的**X-Auth-Token**字段需要填写token，且该token需要具有本API的访问权限。 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" ccm "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ccm/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ccm/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ccm/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := ccm.CcmClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := ccm.NewCcmClient(hcClient) request := &model.RevokeCertificateRequest{} request.CertificateId = "{certificate_id}" reasonRevokeCertificateRequestBody:= "KEY_COMPROMISE" request.Body = &model.RevokeCertificateRequestBody{ Reason: &reasonRevokeCertificateRequestBody, } response, err := client.RevokeCertificate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` #### 更多 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CCM/sdk?api=RevokeCertificate)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 204 | 请求已成功，无响应body | | 400 | 请求参数有误。 | | 401 | 被请求的页面需要鉴权。 | | 403 | 认证失败。 | | 404 | 资源不存在或资源未找到。 | | 500 | 服务内部错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ccm/ErrorCode.html)。