Queries the details about all revoked client certificates and server certificates.

Usage notes

You can call the ListRevokeCertificate operation to perform a paged query of the details about all revoked client certificates and server certificates. The details include the unique identifier, serial number, and revocation date of each certificate.

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 ListRevokeCertificate

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

CurrentPage Integer No 1

The number of the current page to return. Default value: 1.

ShowSize Integer No 20

The number of revoked certificates to return on each page. Default value: 20.

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
CurrentPage Integer 1

The page number of the current page.

RequestId String 15C66C7B-671A-4297-9187-2C4477247A74

The ID of the request.

TotalCount Integer 1

The total number of revoked client certificates and server certificates that are returned.

PageCount Integer 1

The number of returned pages.

ShowSize Integer 20

The number of revoked certificates that are returned per page.

CertificateList Array of Certificate

The details about the revoked client certificate or server certificate.

SerialNumber String 168b12c42e62339f8d2340ff530f9365****

The serial number of the 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.

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.

RevokeDate String 2021-09-01T00:00Z

The date on which the certificate was revoked. The value is in the yyyy-MM-ddT00:00Z format. For example, the value 2021-09-01T00:00Z indicates September 1, 2021.

Identifier String 05e148d8d3ecc9976d9ecd2b2f25****

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 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 value of the extension. Data type: string.
KeySize Integer 4096

The key length of the certificate.

SubjectDN String C=CN,O=Alibaba Cloud Computing Co., Ltd.,OU=Security,L=ZheJiang,ST=HangZhou,CN=aliyundoc.com

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 String 2021-12-31T00:00Z

The expiration date of the certificate. The date is in the yyyy-MM-ddT00:00Z format. For example, the value 2021-12-31T00:00Z indicates December 31, 2021.

Sha2 String b60eff7e04323ff662f9ab5e6986f849f626a9c7bf2c59dcc752fa23779a****

The SHA-256 fingerprint of the CA certificate.

CommonName String aliyundoc.com

The common name of the certificate.

Md5 String 05e148d8d3ecc9976d9ecd2b2f25****

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-01-01T00:00Z

The issuance date of the certificate. The date is in the yyyy-MM-ddT00:00Z format. For example, the value 2021-01-01T00:00Z indicates January 1, 2021.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListRevokeCertificate
&CurrentPage=1
&ShowSize=20
&Common request parameters

Sample success responses

XML format 

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

<ListRevokeCertificateResponse>
    <CurrentPage>1</CurrentPage>
    <RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>
    <TotalCount>1</TotalCount>
    <PageCount>1</PageCount>
    <ShowSize>20</ShowSize>
    <CertificateList>
        <SerialNumber>168b12c42e62339f8d2340ff530f9365****</SerialNumber>
        <Algorithm>RSA</Algorithm>
        <State>Zhejiang</State>
        <Organization>Alibaba Cloud Computing Co., Ltd.</Organization>
        <Locality>Hangzhou</Locality>
        <RevokeDate>2021-09-01T00:00Z</RevokeDate>
        <Identifier>05e148d8d3ecc9976d9ecd2b2f25****</Identifier>
        <Sans>[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]</Sans>
        <KeySize>4096</KeySize>
        <SubjectDN>C=CN,O=Alibaba Cloud Computing Co., Ltd.,OU=Security,L=ZheJiang,ST=HangZhou,CN=aliyundoc.com</SubjectDN>
        <SignAlgorithm>SHA256WITHRSA</SignAlgorithm>
        <OrganizationUnit>Security</OrganizationUnit>
        <AfterDate>2021-12-31T00:00Z</AfterDate>
        <Sha2>b60eff7e04323ff662f9ab5e6986f849f626a9c7bf2c59dcc752fa23779a****</Sha2>
        <CommonName>aliyundoc.com</CommonName>
        <Md5>05e148d8d3ecc9976d9ecd2b2f25****</Md5>
        <CountryCode>CN</CountryCode>
        <BeforeDate>2021-01-01T00:00Z</BeforeDate>
    </CertificateList>
</ListRevokeCertificateResponse>

JSON format 

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

{
  "CurrentPage" : 1,
  "RequestId" : "15C66C7B-671A-4297-9187-2C4477247A74",
  "TotalCount" : 1,
  "PageCount" : 1,
  "ShowSize" : 20,
  "CertificateList" : [ {
    "SerialNumber" : "168b12c42e62339f8d2340ff530f9365****",
    "Algorithm" : "RSA",
    "State" : "Zhejiang",
    "Organization" : "Alibaba Cloud Computing Co., Ltd.",
    "Locality" : "Hangzhou",
    "RevokeDate" : "2021-09-01T00:00Z",
    "Identifier" : "05e148d8d3ecc9976d9ecd2b2f25****",
    "Sans" : "[ {\"Type\": 7, \"Value\": \"192.0.XX.XX\"}, {\"Type\": 2, \"Value\": \"www.aliyundoc.com\"}, ]",
    "KeySize" : 4096,
    "SubjectDN" : "C=CN,O=Alibaba Cloud Computing Co., Ltd.,OU=Security,L=ZheJiang,ST=HangZhou,CN=aliyundoc.com",
    "SignAlgorithm" : "SHA256WITHRSA",
    "OrganizationUnit" : "Security",
    "AfterDate" : "2021-12-31T00:00Z",
    "Sha2" : "b60eff7e04323ff662f9ab5e6986f849f626a9c7bf2c59dcc752fa23779a****",
    "CommonName" : "aliyundoc.com",
    "Md5" : "05e148d8d3ecc9976d9ecd2b2f25****",
    "CountryCode" : "CN",
    "BeforeDate" : "2021-01-01T00:00Z"
  } ]
}

Error codes

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