Queries the status information about multiple client certificates or server certificates at a time by using the unique identifiers of the certificates.

Usage notes

You can call the DescribeClientCertificateStatus operation to query the status information about multiple client certificates or server certificates at a time by using the unique identifiers of the certificates. For example, you can check whether a certificate is revoked.

Limits

You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeClientCertificateStatus

The operation that you want to perform. Set the value to DescribeClientCertificateStatus.

Identifier String Yes 160ae6bb538d538c70c01f81dcf2****

The unique identifiers of the client certificates or server certificates that you want to query. Separate multiple unique identifiers with commas (,).

Note You can call the ListClientCertificate operation to query the unique identifiers of all client certificates and server certificates.

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
RequestId String 15C66C7B-671A-4297-9187-2C4477247A74

The ID of the request.

CertificateStatus Array of CertificateStatus

The details about the certificate.

SerialNumber String b67e53ebcea9b77d65b0c3236646d715****

The serial number of the certificate.

Status String good

The status of the certificate. Valid values:

  • good: The certificate is not revoked.
  • revoked: The certificate is revoked.
  • unknown: The server cannot determine the status of the certificate.
RevokeTime Long 2021-01-01T00:00Z

The date on which the certificate was revoked.

Note This parameter is returned only when the value of the Status parameter is revoked. The value revoked indicates that the certificate is revoked.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeClientCertificateStatus
&Identifier=160ae6bb538d538c70c01f81dcf2****
&Common request parameters

Sample success responses

XML format

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 format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "15C66C7B-671A-4297-9187-2C4477247A74",
  "CertificateStatus" : [ {
    "SerialNumber" : "b67e53ebcea9b77d65b0c3236646d715****",
    "Status" : "good"
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.