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

Usage notes

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 the 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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeClientCertificate

The operation that you want to perform. Set the value to DescribeClientCertificate.

Identifier String Yes d3b95700998e47afc4d95f886579****

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.

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.

Certificate Object

The details about the client certificate or the server certificate.

Status String ISSUE

The status of the certificate. Valid values:

  • ISSUE: The certificate is issued.
  • REVOKE: The certificate is revoked.
SerialNumber String 62b2b943a32d96883a6650e672ea0276****

The serial number of the certificate.

CertificateType String SERVER

The type of the certificate. Valid values:

  • CLIENT: a client certificate
  • SERVER: a server certificate
Algorithm String RSA

The type of the encryption algorithm of the certificate. Valid values:

  • RSA: the RSA algorithm.
  • ECC: the ECC algorithm.
  • SM2: the SM2 algorithm, which is developed and approved by the State Cryptography Administration of China.
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.

ParentIdentifier String 160ae6bb538d538c70c01f81dcf2****

The unique identifier of 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:

  • 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 content of the extension. Data type: string.
Days Integer 365

The validity period of the certificate. Unit: days.

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:

  • C: the country
  • O: the organization
  • OU: the department
  • L: the city

  • ST: the province or state
  • CN: the common name
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 Long 1665819958000

The expiration date of the certificate. This value is a UNIX timestamp. Unit: milliseconds.

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 Long 1634283958000

The issuance date of the certificate. This value is a UNIX timestamp. Unit: milliseconds.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeClientCertificate
&Identifier=d3b95700998e47afc4d95f886579****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeClientCertificateResponse>
    <RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>
    <Certificate>
        <Status>ISSUE</Status>
        <SerialNumber>62b2b943a32d96883a6650e672ea0276****</SerialNumber>
        <CertificateType>SERVER</CertificateType>
        <Algorithm>RSA</Algorithm>
        <State>Zhejiang</State>
        <Organization>Alibaba Cloud Computing Co., Ltd.</Organization>
        <ParentIdentifier>160ae6bb538d538c70c01f81dcf2****</ParentIdentifier>
        <Locality>Hangzhou</Locality>
        <Identifier>d3b95700998e47afc4d95f886579****</Identifier>
        <Sans>[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]</Sans>
        <Days>365</Days>
        <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>1665819958000</AfterDate>
        <Sha2>14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****</Sha2>
        <CommonName>aliyun.com</CommonName>
        <Md5>d3b95700998e47afc4d95f886579****</Md5>
        <CountryCode>CN</CountryCode>
        <BeforeDate>1634283958000</BeforeDate>
    </Certificate>
</DescribeClientCertificateResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "15C66C7B-671A-4297-9187-2C4477247A74",
  "Certificate" : {
    "Status" : "ISSUE",
    "SerialNumber" : "62b2b943a32d96883a6650e672ea0276****",
    "CertificateType" : "SERVER",
    "Algorithm" : "RSA",
    "State" : "Zhejiang",
    "Organization" : "Alibaba Cloud Computing Co., Ltd.",
    "ParentIdentifier" : "160ae6bb538d538c70c01f81dcf2****",
    "Locality" : "Hangzhou",
    "Identifier" : "d3b95700998e47afc4d95f886579****",
    "Sans" : "[ {\"Type\": 7, \"Value\": \"192.0.XX.XX\"}, {\"Type\": 2, \"Value\": \"www.aliyundoc.com\"}, ]",
    "Days" : 365,
    "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" : 1665819958000,
    "Sha2" : "14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****",
    "CommonName" : "aliyun.com",
    "Md5" : "d3b95700998e47afc4d95f886579****",
    "CountryCode" : "CN",
    "BeforeDate" : 1634283958000
  }
}

Error codes

For a list of error codes, visit the API Error Center.