调用DescribeClientCertificateStatus,通过证书的唯一识别码查询客户端证书和服务端证书的状态信息。
使用说明
本接口用于通过证书的唯一识别码,批量查询客户端证书或服务端证书的状态,例如,证书是否已被吊销。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用将会被限流,这可能影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeClientCertificateStatus |
要执行的操作。取值:DescribeClientCertificateStatus。 |
Identifier | String | 是 | 160ae6bb538d538c70c01f81dcf2**** |
要查询的客户端证书或服务端证书的唯一识别码。多个证书识别码之间使用半角逗号(,)分隔。 说明 您可以调用ListClientCertificate查询所有客户端与服务端证书的唯一识别码。
|
调用API时,除了本文中该API的请求参数,还需加入阿里云API公共请求参数。公共请求参数的详细介绍,请参见公共参数。
调用API的请求格式,请参见本文示例中的请求示例。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 15C66C7B-671A-4297-9187-2C4477247A74 |
本次请求的ID。 |
CertificateStatus | Array of CertificateStatus |
证书状态的详细信息。 |
|
SerialNumber | String | b67e53ebcea9b77d65b0c3236646d715**** |
证书的序列号。 |
Status | String | good |
证书的当前状态。取值:
|
RevokeTime | Long | 2021-01-01T00:00Z |
证书被吊销的日期。 说明 只有当Status为revoked(表示证书已被吊销)时,才会返回该参数。
|
示例
请求示例
http(s)://[Endpoint]/?Action=DescribeClientCertificateStatus
&Identifier=160ae6bb538d538c70c01f81dcf2****
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeClientCertificateStatusResponse>
<RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>
<CertificateStatus>
<SerialNumber>b67e53ebcea9b77d65b0c3236646d715****</SerialNumber>
<Status>good</Status>
</CertificateStatus>
</DescribeClientCertificateStatusResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "15C66C7B-671A-4297-9187-2C4477247A74",
"CertificateStatus" : [ {
"SerialNumber" : "b67e53ebcea9b77d65b0c3236646d715****",
"Status" : "good"
} ]
}
错误码
访问错误中心查看更多错误码。