All Products
Search
Document Center

Certificate Management Service:DescribeCACertificateList

Last Updated:Feb 02, 2024

Queries the details about all root certificate authority (CA) certificates and intermediate CA certificates.

Operation description

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-cert:DescribeCACertificateListRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CurrentPageintegerNo

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

1
ShowSizeintegerNo

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

20
IdentifierstringNo

The unique identifier of the client certificate or server certificate that you want to revoke.

Note You can call the ListClientCertificate operation to query the unique identifiers of all client certificates and server certificates.
160ae6bb538d538c70c01f81dcf2****

All Alibaba Cloud API operations must include common request parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

ParameterTypeDescriptionExample
object

The object.

CurrentPageinteger

The page number of the returned page.

1
RequestIdstring

The ID of the request.

15C66C7B-671A-4297-9187-2C4477247A74
TotalCountinteger

The total number of root CA certificates and intermediate CA certificates that are returned.

2
PageCountinteger

The number of returned pages.

1
ShowSizeinteger

The number of CA certificates returned per page.

20
CertificateListobject []

An array that consists of the details about the CA certificate.

Yearsinteger

The validity period of the CA certificate. Unit: years.

3
Statusstring

The status of the CA certificate. Valid values:

  • ISSUE: The CA certificate is issued.
  • REVOKE: The CA certificate is revoked.
ISSUE
SerialNumberstring

The serial number of the CA certificate.

70e3b2566d92805173767869727fb92e****
CertificateTypestring

The type of the CA certificate. Valid values:

  • ROOT: root CA certificate
  • SUB_ROOT: intermediate CA certificate
SUB_ROOT
Algorithmstring

The encryption algorithm of the CA certificate. Valid values:

  • RSA: the Rivest-Shamir-Adleman (RSA) algorithm.
  • ECC: the elliptic curve cryptography (ECC) algorithm.
  • SM2: the SM2 algorithm, which is developed and approved by the State Cryptography Administration of China.
RSA
Statestring

The name of the province, municipality, or autonomous region in which the organization is located.

Zhejiang
Organizationstring

The name of the organization that is associated with the CA certificate.

Alibaba Cloud Computing Co., Ltd.
ParentIdentifierstring

The unique identifier of the root CA certificate from which the CA certificate is issued.

Note This parameter is returned only if the value of the CertificateType parameter is SUB_ROOT. The value SUB_ROOT indicates an intermediate CA certificate.
1a83bcbb89e562885e40aa0108f5****
Localitystring

The name of the city in which the organization is located.

Hangzhou
Identifierstring

The unique identifier of the CA certificate.

160ae6bb538d538c70c01f81dcf2****
Sansstring

This parameter is deprecated.

1
KeySizeinteger

The key length of the CA certificate.

2048
X509Certificatestring

The content of the CA certificate.

-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----
SubjectDNstring

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
  • CN: the common name or abbreviation of the organization
C=CN,O=Alibaba Cloud Computing Co., Ltd.,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun
SignAlgorithmstring

The signature algorithm of the CA certificate.

SHA256WITHRSA
OrganizationUnitstring

The name of the department or branch in the organization that is associated with the CA certificate.

Security
AfterDatelong

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

1665819958000
Sha2string

The SHA-256 fingerprint of the CA certificate.

14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****
CommonNamestring

The common name or abbreviation of the organization that is associated with the CA certificate.

Aliyun
Md5string

The MD5 fingerprint of the CA certificate.

160ae6bb538d538c70c01f81dcf2****
CountryCodestring

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.

CN
BeforeDatelong

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

1634283958000

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-08-30The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Identifier