DescribeClientCertificate - Certificate Management Service

Queries the details about a client certificate or a server certificate by using the unique identifier of the certificate.

Operation Description

You can call the DescribeClientCertificate operation to query the details about a client certificate or a server certificate by using the unique identifier of the certificate. The details include the serial number, user information, content, and status of each certificate.

Before you call this operation, make sure that you have created a client certificate or a server certificate.

For more information about how to call an operation to create a client certificate, see the following topics:

For more information about how to call an operation to create a server certificate, see the following topics:

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

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:DescribeClientCertificate	Read	All Resources acs:yundun-cert::{#accountId}:	none	none

Request parameters

Parameter	Type	Required	Description	Example
Identifier	string	Yes	The unique identifier of the client certificate or the server certificate that you want to query. Note You can call the ListClientCertificate operation to query the unique identifiers of all client certificates and server certificates.	d3b95700998e47afc4d95f886579****

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	DescribeCertificateResponse
Certificate	object	The details about the client certificate or the server certificate.
X509Certificate	string	The content of the certificate.	-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----
Identifier	string	The unique identifier of the certificate.	d3b95700998e47afc4d95f886579****
SerialNumber	string	The serial number of the certificate.	62b2b943a32d96883a6650e672ea0276****
SubjectDN	string	The distinguished name (DN) extension of the certificate, which indicates the user of the certificate. The DN extension includes the following information: C: the country O: the organization OU: the department L: the city ST: the province, municipality, or autonomous region CN: the common name	C=CN,O=Alibaba Cloud Computing Co., Ltd.,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun
CommonName	string	The common name of the certificate.	aliyun.com
OrganizationUnit	string	The name of the department in the organization. The organization is associated with the intermediate certificate authority (CA) certificate from which the certificate is issued.	Security
Organization	string	The name of the organization. The organization is associated with the intermediate certificate from which the certificate is issued.	Alibaba Cloud Computing Co., Ltd.
Locality	string	The name of the city in which the organization is located. The organization is associated with the intermediate certificate from which the certificate is issued.	Hangzhou
State	string	The name of the province, municipality, or autonomous region in which the organization is located. The organization is associated with the intermediate certificate from which the certificate is issued.	Zhejiang
CountryCode	string	The code of the country in which the organization is located. The organization is associated with the intermediate certificate from which the certificate is issued. For more information about country codes, see the "Country codes" section of the Manage company profiles topic.	CN
Sans	string	The subject alternative name (SAN) extension of the certificate. The value indicates additional information, including the additional domain names or IP addresses that are associated with the certificate. The value is a string that consists of JSON arrays. Each element in a JSON array is a JSON struct that corresponds to a SAN extension. A SAN extension struct contains the following parameters: Type: the type of the extension. Data type: integer. Valid values: 1: an email address 2: a domain name 6: a Uniform Resource Identifier (URI) 7: an IP address Value: the value of the extension. Data type: string.	[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]
Status	string	The status of the certificate. Valid values: ISSUE: issued REVOKE: revoked	ISSUE
BeforeDate	long	The issuance date of the certificate. This value is a UNIX timestamp. Unit: milliseconds.	1634283958000
AfterDate	long	The expiration date of the certificate. This value is a UNIX timestamp. Unit: milliseconds.	1665819958000
Algorithm	string	The type of the encryption algorithm of the certificate. Valid values: RSA: the Rivest-Shamir-Adleman (RSA) algorithm. ECC: the elliptic curve cryptography (ECC) algorithm. SM2: the SM2 algorithm, which is developed and approved by the State Cryptography Administration of China.	RSA
KeySize	integer	The key length of the certificate.	4096
SignAlgorithm	string	The signature algorithm of the certificate.	SHA256WITHRSA
CertificateType	string	The type of the certificate. Valid values: CLIENT: client certificate SERVER: server certificate	SERVER
ParentIdentifier	string	The unique identifier of the intermediate certificate from which the client certificate is issued.	160ae6bb538d538c70c01f81dcf2****
Sha2	string	The SHA-256 fingerprint of the certificate.	14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****
Md5	string	The MD5 fingerprint of the certificate.	d3b95700998e47afc4d95f886579****
Days	integer	The validity period of the certificate. Unit: days.	365
RequestId	string	The ID of the request.	15C66C7B-671A-4297-9187-2C4477247A74

Examples

Sample success responses

JSONformat

{
  "Certificate": {
    "X509Certificate": "-----BEGIN CERTIFICATE-----  ...... -----END CERTIFICATE-----",
    "Identifier": "d3b95700998e47afc4d95f886579****",
    "SerialNumber": "62b2b943a32d96883a6650e672ea0276****",
    "SubjectDN": "C=CN,O=Alibaba Cloud Computing Co., Ltd.,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun\n",
    "CommonName": "aliyun.com",
    "OrganizationUnit": "Security",
    "Organization": "Alibaba Cloud Computing Co., Ltd.\n",
    "Locality": "Hangzhou",
    "State": "Zhejiang",
    "CountryCode": "CN",
    "Sans": "[ {\"Type\": 7, \"Value\": \"192.0.XX.XX\"}, {\"Type\": 2, \"Value\": \"www.aliyundoc.com\"}, ]",
    "Status": "ISSUE",
    "BeforeDate": 1634283958000,
    "AfterDate": 1665819958000,
    "Algorithm": "RSA",
    "KeySize": 4096,
    "SignAlgorithm": "SHA256WITHRSA",
    "CertificateType": "SERVER",
    "ParentIdentifier": "160ae6bb538d538c70c01f81dcf2****",
    "Sha2": "14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****",
    "Md5": "d3b95700998e47afc4d95f886579****",
    "Days": 365
  },
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
}

Error codes

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