DescribeClientCertificateForSerialNumber
Queries the details of one or more client certificates or server certificates by 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
Usage notes
This operation queries the details of one or more client certificates or server certificates by serial number, such as the serial number, subject information, content, and status of the certificates.
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 API operation to create a client certificate, see:
For more information about how to call an API operation to create a server certificate, see:
QPS limit
The QPS limit on this operation is 10 queries per second per account. If the number of queries per second exceeds the limit, throttling is triggered, which may affect your business. Call this operation as needed.
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 the ListClientCertificate operation to query the serial numbers of all client certificates and server certificates. |
084bde9cd233f0ddae33adc438cfbbbd**** |
When you call this operation, you must add the common request parameters of Alibaba Cloud API in addition to the request parameters described in this topic. For more information about common request parameters, see Common parameters.
For more information about the request format, see the Examples section in 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 attribute includes the following information:
|
C=CN,O=Alibaba Cloud Computing 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 under the organization that is associated with the subordinate CA certificate that issued the certificate. |
Security |
| Organization |
string |
The name of the organization that is associated with the subordinate CA certificate that issued the certificate. |
Alibaba Cloud Computing Ltd |
| Locality |
string |
The name of the city where the organization that is associated with the subordinate CA certificate that issued the certificate is located. |
Hangzhou |
| State |
string |
The name of the province, municipality, or autonomous region where the organization that is associated with the subordinate CA certificate that issued the certificate is located. |
Zhejiang |
| CountryCode |
string |
The code of the country where the organization that is associated with the subordinate CA certificate that issued the certificate is located. For more information about country codes, see the Country codes section in Manage company information. |
CN |
| Sans |
string |
The Subject Alternative Name (SAN) extension attribute of the certificate, which indicates other domain names and IP addresses that are associated with the certificate. The value of this parameter is a string that is converted from a JSON array. Each element in the JSON array is a struct that corresponds to a SAN extension. Each SAN extension struct includes 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 time when the certificate was issued. Format: YYYY-MM-DD. |
2021-10-28T16:15Z |
| AfterDate |
string |
The time when the certificate expires. Format: YYYY-MM-DD. |
2022-08-23T16:15Z |
| Algorithm |
string |
The type of the encryption algorithm used for 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, it indicates that 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 ID of the request. |
15C66C7B-671A-4297-9187-2C4477247A74 |
Examples
Success response
JSON format
{
"CertificateList": [
{
"X509Certificate": "-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----",
"Identifier": "d3b95700998e47afc4d95f886579****",
"SerialNumber": "084bde9cd233f0ddae33adc438cfbbbd****",
"SubjectDN": "C=CN,O=Alibaba Cloud Computing Co., Ltd.,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun",
"CommonName": "aliyun.com",
"OrganizationUnit": "Security",
"Organization": "Alibaba Cloud Computing Co., Ltd",
"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.