DescribeCACertificateList - API Reference| Alibaba Cloud Documentation Center

Usage notes

You can call the DescribeCACertificateList operation to perform a paged query of the details about all CA certificates that you create. The details include the unique identifier, serial number, user information, and content of each root CA certificate or intermediate CA 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	DescribeCACertificateList	The operation that you want to perform. Set the value to DescribeCACertificateList.
CurrentPage	Integer	No	1	The number of the current page to return. Default value: 1.
ShowSize	Integer	No	20	The number of CA 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 number of the current page.
RequestId	String	15C66C7B-671A-4297-9187-2C4477247A74	The ID of the request.
TotalCount	Integer	2	The total number of root CA certificates and intermediate CA certificates that are returned.
PageCount	Integer	1	The number of returned pages.
ShowSize	Integer	20	The number of CA certificates returned per page.
CertificateList	Array of Certificate		The list of details about the CA certificate.
Years	Integer	3	The validity period of the CA certificate. Unit: years.
Status	String	ISSUE	The status of the CA certificate. Valid values: ISSUE: The CA certificate is issued. REVOKE: The CA certificate is revoked.
SerialNumber	String	70e3b2566d92805173767869727fb92e****	The serial number of the CA certificate.
CertificateType	String	SUB_ROOT	The type of the CA certificate. Valid values: ROOT: root CA certificate SUB_ROOT: intermediate CA certificate
Algorithm	String	RSA	The type of the encryption algorithm of the CA 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.
Organization	String	Alibaba Cloud Computing Co., Ltd.	The name of the organization that is associated with the CA certificate.
ParentIdentifier	String	1a83bcbb89e562885e40aa0108f5****	The unique identifier of the root CA certificate from which the CA certificate is issued. Note This parameter is returned only when the value of the CertificateType parameter is SUB_ROOT. The value SUB_ROOT indicates an intermediate CA certificate.
Locality	String	Hangzhou	The name of the city in which the organization is located.
Identifier	String	160ae6bb538d538c70c01f81dcf2****	The unique identifier of the CA certificate.
Sans	String	1	This parameter is deprecated.
KeySize	Integer	2048	The key length of the CA certificate.
X509Certificate	String	-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----	The content of the CA certificate.
SubjectDN	String	C=CN,O=Alibaba Cloud Computing Co., Ltd.,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun	The Distinguished Name (DN) attribute of the CA certificate, which indicates the user information of the certificate. The DN attribute contains the following information: C: the country code in which the organization is located O: the name of the organization OU: the name of the department or branch in the organization L: the name of the city in which the organization is located ST: the name of the province or state in which the organization is located CN: the common name or abbreviation of the organization
SignAlgorithm	String	SHA256WITHRSA	The signature algorithm of the CA certificate.
OrganizationUnit	String	Security	The name of the department in the organization that is associated with the CA certificate.
AfterDate	Long	1665819958000	The expiration date of the CA certificate. This value is a UNIX timestamp. Unit: milliseconds.
Sha2	String	14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****	The SHA-256 fingerprint of the CA certificate.
CommonName	String	Aliyun	The common name or abbreviation of the organization that is associated with the CA certificate.
Md5	String	160ae6bb538d538c70c01f81dcf2****	The MD5 fingerprint of the CA certificate.
CountryCode	String	CN	The code of the country in which the organization is located. 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 CA certificate. This value is a UNIX timestamp. Unit: milliseconds.

Examples

Sample requests

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

Sample success responses

XML format

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

<DescribeCACertificateListResponse>
    <CurrentPage>1</CurrentPage>
    <RequestId>15C66C7B-671A-4297-9187-2C4477247A74</RequestId>
    <TotalCount>2</TotalCount>
    <PageCount>1</PageCount>
    <ShowSize>20</ShowSize>
    <CertificateList>
        <Years>1</Years>
        <Status>ISSUE</Status>
        <SerialNumber>70e3b2566d92805173767869727fb92e****</SerialNumber>
        <CertificateType>SUB_ROOT</CertificateType>
        <Algorithm>RSA</Algorithm>
        <State>Zhejiang</State>
        <Organization>Alibaba Cloud Computing Co., Ltd.</Organization>
        <ParentIdentifier>1a83bcbb89e562885e40aa0108f5****</ParentIdentifier>
        <Locality>Hangzhou</Locality>
        <Identifier>160ae6bb538d538c70c01f81dcf2****</Identifier>
        <KeySize>2048</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</CommonName>
        <Md5>160ae6bb538d538c70c01f81dcf2****</Md5>
        <CountryCode>CN</CountryCode>
        <BeforeDate>1634283958000</BeforeDate>
    </CertificateList>
    <CertificateList>
        <Years>1</Years>
        <Status>ISSUE</Status>
        <SerialNumber>566d70e3b292805173767869727fb92e****</SerialNumber>
        <CertificateType>ROOT</CertificateType>
        <Algorithm>RSA</Algorithm>
        <State>Zhejiang</State>
        <Organization>Alibaba</Organization>
        <Locality>Hangzhou</Locality>
        <Identifier>1a83bcbb89e562885e40aa0108f5****</Identifier>
        <KeySize>2048</KeySize>
        <X509Certificate>-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----</X509Certificate>
        <SubjectDN>C=CN,O=Alibaba,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Alibaba</SubjectDN>
        <SignAlgorithm>SHA256WITHRSA</SignAlgorithm>
        <OrganizationUnit>Security</OrganizationUnit>
        <AfterDate>1665819958000</AfterDate>
        <Sha2>1fcec36d65814dcc8afc7578ef7e20de18f6957bbac42b373a66bc9de4e9****</Sha2>
        <CommonName>Aliyun</CommonName>
        <Md5>1a83bcbb89e562885e40aa0108f5****</Md5>
        <CountryCode>CN</CountryCode>
        <BeforeDate>1634283958000</BeforeDate>
    </CertificateList>
</DescribeCACertificateListResponse>

JSON format

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

{
  "CurrentPage" : 1,
  "RequestId" : "15C66C7B-671A-4297-9187-2C4477247A74",
  "TotalCount" : 2,
  "PageCount" : 1,
  "ShowSize" : 20,
  "CertificateList" : [ {
    "Years" : 1,
    "Status" : "ISSUE",
    "SerialNumber" : "70e3b2566d92805173767869727fb92e****",
    "CertificateType" : "SUB_ROOT",
    "Algorithm" : "RSA",
    "State" : "Zhejiang",
    "Organization" : "Alibaba Cloud Computing Co., Ltd.",
    "ParentIdentifier" : "1a83bcbb89e562885e40aa0108f5****",
    "Locality" : "Hangzhou",
    "Identifier" : "160ae6bb538d538c70c01f81dcf2****",
    "KeySize" : 2048,
    "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",
    "Md5" : "160ae6bb538d538c70c01f81dcf2****",
    "CountryCode" : "CN",
    "BeforeDate" : 1634283958000
  }, {
    "Years" : 1,
    "Status" : "ISSUE",
    "SerialNumber" : "566d70e3b292805173767869727fb92e****",
    "CertificateType" : "ROOT",
    "Algorithm" : "RSA",
    "State" : "Zhejiang",
    "Organization" : "Alibaba",
    "Locality" : "Hangzhou",
    "Identifier" : "1a83bcbb89e562885e40aa0108f5****",
    "KeySize" : 2048,
    "X509Certificate" : "-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----",
    "SubjectDN" : "C=CN,O=Alibaba,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Alibaba",
    "SignAlgorithm" : "SHA256WITHRSA",
    "OrganizationUnit" : "Security",
    "AfterDate" : 1665819958000,
    "Sha2" : "1fcec36d65814dcc8afc7578ef7e20de18f6957bbac42b373a66bc9de4e9****",
    "CommonName" : "Aliyun",
    "Md5" : "1a83bcbb89e562885e40aa0108f5****",
    "CountryCode" : "CN",
    "BeforeDate" : 1634283958000
  } ]
}

Error codes

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