Queries the details of client certificates or server certificates in batch by certificate serial number.
This API has been deprecated. We recommend migrating to cas(2020-06-30) - DescribeClientCertificate for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.
Operation description
Description
This operation allows you to query the details of client certificates or server certificates in batch by certificate serial number. The details include the serial number, subject information, content, and status of the certificates.
Before you call this operation, you must have created client certificates or server certificates.
For information about how to call an API operation to create a client certificate, see:
For information about how to call an API operation to create a server certificate, see:
QPS limit
The single-user QPS limit for this operation is 10 calls per second. If the limit is exceeded, the API calls are throttled, which may affect your business. Call this operation as appropriate.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
yundun-cert:DescribeClientCertificateForSerialNumber |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| SerialNumber |
string |
Yes |
The serial numbers of the client certificates or server certificates that you want to query. Separate multiple serial numbers with commas (,). Note
You can call ListClientCertificate to query the serial numbers of all client certificates and server certificates. |
084bde9cd233f0ddae33adc438cfbbbd**** |
When you call this operation, you must include the Alibaba Cloud API common request parameters in addition to the request parameters described in this topic. For more information about common request parameters, see Common parameters.
For the request format, see the request examples in the Examples section of this topic.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
ListCertificateResponse |
||
| CertificateList |
array<object> |
The details of the client certificates or server certificates. |
|
|
object |
The certificate information. |
||
| 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. |
084bde9cd233f0ddae33adc438cfbbbd**** |
| SubjectDN |
string |
The distinguished name (DN) attribute of the certificate, which indicates the subject of the certificate. The DN contains the following information:
|
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 associated with the subordinate CA certificate that issued this certificate. |
Security |
| Organization |
string |
The name of the organization associated with the subordinate CA certificate that issued this certificate. |
Alibaba Cloud Computing Co., Ltd |
| Locality |
string |
The name of the city where the organization associated with the subordinate CA certificate that issued this certificate is located. |
Hangzhou |
| State |
string |
The name of the province or state where the organization associated with the subordinate CA certificate that issued this certificate is located. |
Zhejiang |
| CountryCode |
string |
The code of the country where the organization associated with the subordinate CA certificate that issued this certificate is located. For more information about country codes, see the International codes section in Manage company information. |
CN |
| Sans |
string |
The Subject Alternative Name (SAN) extension of the certificate, which indicates other domain names or IP addresses associated with the certificate. This parameter is represented as a string converted from a JSON array. Each element in the JSON array is a structure that corresponds to a SAN extension. Each SAN extension structure contains the following parameters:
|
[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ] |
| Status |
string |
The status of the certificate. Valid values:
|
ISSUE |
| BeforeDate |
string |
The issuance date of the certificate. The format is YYYY-MM-DD. |
2021-10-28T16:15Z |
| AfterDate |
string |
The expiration date of the certificate. The format is YYYY-MM-DD. |
2022-08-23T16:15Z |
| Algorithm |
string |
The encryption algorithm type of the certificate. Valid values:
|
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. |
SUB_ROOT |
| ParentIdentifier |
string |
If this parameter is not empty, the client certificate is issued by Alibaba Cloud. |
1a83bcbb89e562885e40aa0108f5**** |
| Sha2 |
string |
The SHA-256 fingerprint of the certificate. |
14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9**** |
| Md5 |
string |
The MD5 fingerprint of the certificate. |
d3b95700998e47afc4d95f886579**** |
| Years |
integer |
The validity period of the certificate. Unit: years. |
1 |
| RequestId |
string |
The request ID. |
15C66C7B-671A-4297-9187-2C4477247A74 |
Examples
Success response
JSON format
{
"CertificateList": [
{
"X509Certificate": "-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----",
"Identifier": "d3b95700998e47afc4d95f886579****",
"SerialNumber": "084bde9cd233f0ddae33adc438cfbbbd****",
"SubjectDN": "C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun",
"CommonName": "aliyun.com",
"OrganizationUnit": "Security",
"Organization": "阿里云计算有限公司",
"Locality": "Hangzhou",
"State": "Zhejiang",
"CountryCode": "CN",
"Sans": "[ {\"Type\": 7, \"Value\": \"192.0.XX.XX\"}, {\"Type\": 2, \"Value\": \"www.aliyundoc.com\"}, ]",
"Status": "ISSUE",
"BeforeDate": "2021-10-28T16:15Z",
"AfterDate": "2022-08-23T16:15Z",
"Algorithm": "RSA",
"KeySize": 4096,
"SignAlgorithm": "SHA256WITHRSA",
"CertificateType": "SUB_ROOT",
"ParentIdentifier": "1a83bcbb89e562885e40aa0108f5****",
"Sha2": "14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****",
"Md5": "d3b95700998e47afc4d95f886579****",
"Years": 1
}
],
"RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.