DescribeClientCertificate
Queries the details of a single client certificate or server certificate by using the unique identifier of the certificate.
Operation description
Queries the details of a single client certificate or server certificate by using the unique identifier of the certificate. The details include the serial number, subject information, content, and status of the certificate.
Before you call this operation, you must create 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 queries per second (QPS) limit for a single user is 10. If the limit is exceeded, API calls are throttled, which may affect your services. Call this operation at a reasonable rate.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
yundun-cert:DescribeClientCertificate |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Identifier |
string |
Yes |
The unique identifier of the client certificate or 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**** |
When you call this API operation, you must include the common request parameters of Alibaba Cloud APIs in addition to the request parameters specific to this operation.
For more information about the request format, see the request example in the Examples section of this topic.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
DescribeCertificateResponse |
||
| Certificate |
object |
The details of the client certificate or 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) attribute of the certificate, which indicates the subject of the certificate. The attribute includes the following information:
|
C=CN,O=Aliyun,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 intermediate CA certificate that issued the certificate. |
Security |
| Organization |
string |
The name of the organization that is associated with the intermediate CA certificate that issued the certificate. |
Aliyun |
| Locality |
string |
The name of the city where the organization that is associated with the intermediate 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 intermediate CA certificate that issued the certificate is located. |
Zhejiang |
| CountryCode |
string |
The code of the country where the organization that is associated with the intermediate CA certificate that issued the certificate is located. For more information about country codes, see the Country code 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 |
integer |
The issuance date of the certificate. The value is a timestamp in milliseconds. |
1634283958000 |
| AfterDate |
integer |
The expiration date of the certificate. The value is a timestamp in milliseconds. |
1665819958000 |
| 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. Valid values:
|
SERVER |
| ParentIdentifier |
string |
The unique identifier of the intermediate CA certificate that issued the certificate. |
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 |
| ResourceGroupId |
string |
The ID of the resource group to which the certificate belongs. |
rg-acfmxllajdpw3fi |
| CertChain |
string |
The complete certificate chain. |
-----BEGIN CERTIFICATE----- cert -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- subCA -----END CERTIFICATE----- -----BEGIN CERTIFICATE----- rootCA -----END CERTIFICATE----- |
| CustomIdentifier |
string |
The custom identifier, which serves as a unique key. |
***3a32d96883a6650e672ea0276**** |
| UploadFlag |
integer |
Indicates whether the synchronization of the digital certificate to the Certificate Service is complete. |
1 |
| FullAlgorithm |
string |
The algorithm that includes the key length. |
RSA_2048 |
| AliasName |
string |
The name of the issued certificate. |
rsa_root_2048 |
| Id |
integer |
The ID of the data source to which the certificate order belongs. |
1137354 |
| Tags |
array<object> |
The list of tags. |
mtls |
|
object |
The tag value. |
||
| TagKey |
string |
The tag key. |
testKey |
| TagValue |
string |
The tag value. |
[{\"tag\":\"PROPERTY_TYPE\",\"values\":[]}] |
| RequestId |
string |
The ID of the request. |
15C66C7B-671A-4297-9187-2C4477247A74 |
Examples
Success response
JSON format
{
"Certificate": {
"X509Certificate": "-----BEGIN CERTIFICATE----- ...... -----END CERTIFICATE-----",
"Identifier": "d3b95700998e47afc4d95f886579****",
"SerialNumber": "62b2b943a32d96883a6650e672ea0276****",
"SubjectDN": "C=CN,O=Aliyun,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun",
"CommonName": "aliyun.com",
"OrganizationUnit": "Security",
"Organization": "Aliyun",
"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,
"ResourceGroupId": "rg-acfmxllajdpw3fi",
"CertChain": "-----BEGIN CERTIFICATE-----\ncert\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nsubCA\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nrootCA\n-----END CERTIFICATE-----",
"CustomIdentifier": "***3a32d96883a6650e672ea0276****",
"UploadFlag": 1,
"FullAlgorithm": "RSA_2048",
"AliasName": "rsa_root_2048",
"Id": 1137354,
"Tags": [
{
"TagKey": "testKey",
"TagValue": "[{\\\"tag\\\":\\\"PROPERTY_TYPE\\\",\\\"values\\\":[]}]"
}
]
},
"RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.