DescribePcaAndExternalCACertificateList

Updated at:

Retrieves all CA certificates for the user, including internally generated PCA certificates and imported external certificates.

Operation description

This operation performs a paged query to retrieve the details of all CA certificates that you have created, including root CA certificates and subordinate CA certificates. The details include the unique identifier, serial number, subject information, and certificate content of each CA certificate.

QPS limits

The QPS limit per user is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your services. Call the API at a reasonable rate.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cert:DescribePcaAndExternalCACertificateList

list

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

CurrentPage

integer

No

The current page number.

1

ShowSize

integer

No

Specifies the number of records to display on each page. Default value: 50.

50

Identifiers

string

No

The certificate identifiers. Separate multiple identifiers with commas.

aaa,bbb

KeyWord

string

No

The search keyword. Supports fuzzy search by name, domain name, and SANs.

test_name

Response elements

Element

Type

Description

Example

object

CurrentPage

integer

The current page number.

1

RequestId

string

The ID of the request.

CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D

TotalCount

integer

The total number of records.

10

PageCount

integer

The number of entries in the list.

1

ShowSize

integer

Specifies the number of records to display on each page. Default value: 50.

10

CertificateList

array<object>

The list of certificates.

object

The list of certificates.

Years

integer

The purchase duration of the certificate in years.

3

Status

string

The certificate status. Valid values:

  • payed: Paid.

  • checking: Under review.

  • issued: Issued.

  • revoked: Revoked.

  • checked_fail: Review failed.

ISSUE

SerialNumber

string

The certificate serial number.

62b2b943a32d96883a6650e672ea0276****

CertificateType

string

The type of the certificate.

SUB_ROOT

Algorithm

string

The ID of the certificate.

RSA

State

string

The certificate state. Valid values:

  • success: Active.

  • checking: Checking whether the domain name is in Alibaba Cloud DCDN.

  • cname_error: The domain name is not switched to a Global Accelerator instance.

  • domain_invalid: The domain name contains invalid characters.

  • unsupport_wildcard: Wildcard domain names are not supported.

Zhejiang

Organization

string

The organization of the certificate.

Alibaba Cloud Computing Ltd

ParentIdentifier

string

The ID of the parent certificate.

1a83bcbb89e562885e40aa0108f5****

Locality

string

The primary domain name bound to the certificate.

Hangzhou

Identifier

string

The ID of the certificate.

05e148d8d3ecc9976d9ecd2b2f25****

Sans

string

All domain names bound to the certificate.

[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]

KeySize

integer

The size of the certificate key, in GB.

2048

X509Certificate

string

The x.509 certificate.

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

SubjectDN

string

The subject (owner) of the certificate, identified by a DN.

C=CN,O=Alibaba Cloud Computing Ltd.,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun

SignAlgorithm

string

The signature algorithm of the certificate. Valid values:

  • prefix: Prefix verification.

  • match: Exact match.

  • any: Match all.

SHA256WITHRSA

OrganizationUnit

string

The certification authority responsible for the issue of the certificate.

Security

AfterDate

integer

The expiration time of the certificate. The value is a timestamp in milliseconds.

1787539908871

Sha2

string

The primary domain name bound to the certificate.

14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****

CommonName

string

The primary domain name bound to the certificate.

aliyun.com

Md5

string

The MD5 value bound to the certificate.

05e148d8d3ecc9976d9ecd2b2f25****

CountryCode

string

The country code of the certificate.

CN

BeforeDate

integer

The issuance time of the certificate. The value is a timestamp in milliseconds.

1787539908871

Examples

Success response

JSON format

{
  "CurrentPage": 1,
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
  "TotalCount": 10,
  "PageCount": 1,
  "ShowSize": 10,
  "CertificateList": [
    {
      "Years": 3,
      "Status": "ISSUE",
      "SerialNumber": "62b2b943a32d96883a6650e672ea0276****",
      "CertificateType": "SUB_ROOT",
      "Algorithm": "RSA",
      "State": "Zhejiang",
      "Organization": "Alibaba Cloud Computing Co., Ltd",
      "ParentIdentifier": "1a83bcbb89e562885e40aa0108f5****",
      "Locality": "Hangzhou",
      "Identifier": "05e148d8d3ecc9976d9ecd2b2f25****",
      "Sans": "[ {\"Type\": 7, \"Value\": \"192.0.XX.XX\"}, {\"Type\": 2, \"Value\": \"www.aliyundoc.com\"}, ]",
      "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": 1787539908871,
      "Sha2": "14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****",
      "CommonName": "aliyun.com",
      "Md5": "05e148d8d3ecc9976d9ecd2b2f25****",
      "CountryCode": "CN",
      "BeforeDate": 1787539908871
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.