DescribeClientCertificateStatus - Certificate Management Service

Queries the status information about client certificates and server certificates by using the unique identifiers of the certificates.

Operation description

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-cert:DescribeClientCertificateStatus	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Identifier	string	Yes	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.	160ae6bb538d538c70c01f81dcf2****

All Alibaba Cloud API requests must include common request parameters.

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

Response parameters

Parameter	Type	Description	Example
	object	The object.
RequestId	string	The ID of the request.	15C66C7B-671A-4297-9187-2C4477247A74
CertificateStatus	array<object>	An array that consists of the status information about the certificates.
CertificateStatus	object	The object.
SerialNumber	string	The serial number of the certificate.	b67e53ebcea9b77d65b0c3236646d715****
Status	string	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.	good
RevokeTime	long	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.	2021-01-01T00:00Z

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-20	API Description Update. The API operation is not deprecated.	View Change Details