Queries the details about multiple client certificates or server certificates at a time by using the serial numbers of the certificates.
Usage notes
You can call the DescribeClientCertificateForSerialNumber operation to query the details about multiple client certificates or server certificates at a time by using the serial numbers of the certificates. 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
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeClientCertificateForSerialNumber |
The operation that you want to perform. Set the value to DescribeClientCertificateForSerialNumber. |
SerialNumber | String | Yes | 084bde9cd233f0ddae33adc438cfbbbd**** |
The serial number of the client certificate or server certificate that you want to query. Separate multiple serial numbers with commas (,). Note You can call the ListClientCertificate operation to query the serial numbers 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. |
CertificateList | Array of Certificate |
The details about the client certificate or the server certificate. |
|
Years | Integer | 1 |
This parameter is deprecated. |
Status | String | ISSUE |
The status of the certificate. Valid values:
|
SerialNumber | String | 084bde9cd233f0ddae33adc438cfbbbd**** |
The serial number of the certificate. |
Algorithm | String | RSA |
The type of the encryption algorithm of the certificate. Valid values:
|
State | String | Zhejiang |
The name of the province or state in which the organization is located. The organization is associated with the intermediate certificate authority (CA) certificate from which the certificate is issued. |
Organization | String | Alibaba Cloud Computing Co., Ltd. |
The name of the organization. The organization is associated with the intermediate CA certificate from which the certificate is issued. |
Locality | String | Hangzhou |
The name of the city in which the organization is located. The organization is associated with the intermediate CA certificate from which the certificate is issued. |
Identifier | String | d3b95700998e47afc4d95f886579**** |
The unique identifier of the certificate. |
Sans | String | [ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ] |
The subject alternative name (SAN) extension of the certificate. The value indicates additional information, which includes 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:
|
KeySize | Integer | 4096 |
The key length of the certificate. |
X509Certificate | String | -----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE----- |
The content of the certificate. |
SubjectDN | String | C=CN,O=Alibaba Cloud Computing Co., Ltd.,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun |
The distinguished name (DN) extension of the certificate, which indicates the user of the certificate. The DN extension includes the following information:
|
SignAlgorithm | String | SHA256WITHRSA |
The signature algorithm of the certificate. |
OrganizationUnit | String | Security |
The name of the department in the organization. The organization is associated with the intermediate CA certificate from which the certificate is issued. |
AfterDate | String | 2022-08-23T16:15Z |
The expiration time of the certificate. |
Sha2 | String | 14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9**** |
The SHA-256 fingerprint of the CA certificate. |
CommonName | String | aliyun.com |
The common name of the certificate. |
Md5 | String | d3b95700998e47afc4d95f886579**** |
The MD5 fingerprint of the CA certificate. |
CountryCode | String | CN |
The code of the country in which the organization is located. The organization is associated with the intermediate CA certificate from which the certificate is issued. For more information about country codes, see the "Country codes" section of the Manage company profiles topic. |
BeforeDate | String | 2021-10-28T16:15Z |
The issuance time of the certificate. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=DescribeClientCertificateForSerialNumber
&SerialNumber=084bde9cd233f0ddae33adc438cfbbbd****
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeClientCertificateForSerialNumberResponse>
<RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>
<CertificateList>
<Status>ISSUE</Status>
<SerialNumber>084bde9cd233f0ddae33adc438cfbbbd****</SerialNumber>
<Algorithm>RSA</Algorithm>
<State>Zhejiang</State>
<Organization>Alibaba Cloud Computing Co., Ltd.</Organization>
<Locality>Hangzhou</Locality>
<Identifier>d3b95700998e47afc4d95f886579****</Identifier>
<Sans>[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]</Sans>
<KeySize>4096</KeySize>
<X509Certificate>-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----</X509Certificate>
<SubjectDN>C=CN,O=Alibaba Cloud Computing Co., Ltd.,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun</SubjectDN>
<SignAlgorithm>SHA256WITHRSA</SignAlgorithm>
<OrganizationUnit>Security</OrganizationUnit>
<AfterDate>2022-08-23T16:15Z</AfterDate>
<Sha2>14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****</Sha2>
<CommonName>aliyun.com</CommonName>
<Md5>d3b95700998e47afc4d95f886579****</Md5>
<CountryCode>CN</CountryCode>
<BeforeDate>2021-10-28T16:15Z</BeforeDate>
</CertificateList>
</DescribeClientCertificateForSerialNumberResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "15C66C7B-671A-4297-9187-2C4477247A74",
"CertificateList" : [ {
"Status" : "ISSUE",
"SerialNumber" : "084bde9cd233f0ddae33adc438cfbbbd****",
"Algorithm" : "RSA",
"State" : "Zhejiang",
"Organization" : "Alibaba Cloud Computing Co., Ltd.",
"Locality" : "Hangzhou",
"Identifier" : "d3b95700998e47afc4d95f886579****",
"Sans" : "[ {\"Type\": 7, \"Value\": \"192.0.XX.XX\"}, {\"Type\": 2, \"Value\": \"www.aliyundoc.com\"}, ]",
"KeySize" : 4096,
"X509Certificate" : "-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----",
"SubjectDN" : "C=CN,O=Alibaba Cloud Computing Co., Ltd.,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun",
"SignAlgorithm" : "SHA256WITHRSA",
"OrganizationUnit" : "Security",
"AfterDate" : "2022-08-23T16:15Z",
"Sha2" : "14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****",
"CommonName" : "aliyun.com",
"Md5" : "d3b95700998e47afc4d95f886579****",
"CountryCode" : "CN",
"BeforeDate" : "2021-10-28T16:15Z"
} ]
}
Error codes
For a list of error codes, visit the API Error Center.