DescribeClientCertificateStatus - Certificate Management Service

Operation description

This operation queries the status of multiple client or server-side certificates in a batch using their unique identifiers. For example, you can check whether a certificate is revoked.

QPS limits

This operation is limited to 10 queries per second (QPS) for each user. API calls that exceed this limit are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cert:DescribeClientCertificateStatus

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Identifier	string	Yes	The unique identifier of the client or server-side certificate that you want to query. Separate multiple identifiers with commas (,). Note Call ListClientCertificate to query the unique identifiers of all client and server-side certificates.	160ae6bb538d538c70c01f81dcf2****

When you call this operation, you must also include the common request parameters for Alibaba Cloud APIs.

For the request format, see the example in the Examples section.

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The ID of the request.	15C66C7B-671A-4297-9187-2C4477247A74
CertificateStatus	array<object>	The details of the certificate status.
	object	An object.
SerialNumber	string	The serial number of the certificate.	b67e53ebcea9b77d65b0c3236646d715****
Status	string	The current 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	integer	The date when the certificate was revoked. Note This parameter is returned only when the value of Status is revoked.	2021-01-01T00:00Z

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.