DescribePcaAndExternalCACertificateList-阿里云帮助中心

Returns all your certification authority (CA) certificates. These include certificates generated by Private CA and imported external certificates.

Operation description

This operation performs a paged query to retrieve the details of all your CA certificates, including root and subordinate CA certificates. These details include the unique identifier, serial number, subject information, and certificate content.

QPS limit

The queries per second (QPS) limit for a single user is 10. The system throttles API calls that exceed this limit, which may affect your business. To prevent throttling, call this operation within the stated limit.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CurrentPage	integer	No	The current page number.	1
ShowSize	integer	No	The number of entries to return per page. The default value is 50.	50
Identifiers	string	No	One or more certificate identifiers, separated by commas.	aaa,bbb
KeyWord	string	No	The keyword for a fuzzy search on the name, domain name, and SAN fields.	test_name

Response elements

Element	Type	Description	Example
	object
CurrentPage	integer	The current page number.	1
RequestId	string	The request ID.	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
TotalCount	integer	The total number of entries.	10
PageCount	integer	The number of entries on the current page.	1
ShowSize	integer	The number of entries to return on each page. Default value: 50.	10
CertificateList	array<object>	The list of certificates.
	object	The details of the certificate.
Years	integer	The validity period of the certificate, in years.	3
Status	string	The status of the certificate. Valid values:	ISSUE
SerialNumber	string	The serial number of the certificate.	62b2b943a32d96883a6650e672ea0276****
CertificateType	string	The type of the certificate.	SUB_ROOT
Algorithm	string	The algorithm of the certificate.	RSA
State	string	The status of the certificate. Valid values:	Zhejiang
Organization	string	The organization to which the certificate belongs.	阿里云计算有限公司
ParentIdentifier	string	The ID of the parent certificate.	1a83bcbb89e562885e40aa0108f5****
Locality	string	The city in which the organization is located.	Hangzhou
Identifier	string	The ID of the certificate.	05e148d8d3ecc9976d9ecd2b2f25****
Sans	string	All domain names that are bound to the certificate.	[ {"Type": 7, "Value": "192.0.XX.XX"}, {"Type": 2, "Value": "www.aliyundoc.com"}, ]
KeySize	integer	The key size of the certificate. Unit: bits.	2048
X509Certificate	string	The content of the X.509 certificate.	-----BEGIN CERTIFICATE----- …… -----END CERTIFICATE-----
SubjectDN	string	The subject of the certificate.	C=CN,O=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun
SignAlgorithm	string	The signature algorithm of the certificate. Valid values:	SHA256WITHRSA
OrganizationUnit	string	The certificate authority (CA) that issued the certificate.	Security
AfterDate	integer	The expiration time of the certificate.	2022-08-23T16:15Z
Sha2	string	The primary domain name that is bound to the certificate.	14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****
CommonName	string	The primary domain name that is bound to the certificate.	aliyun.com
Md5	string	The MD5 value of the certificate.	05e148d8d3ecc9976d9ecd2b2f25****
CountryCode	string	The country code of the certificate.	CN
BeforeDate	integer	The time at which the certificate is issued.	2021-01-01T00:00Z

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": "阿里云计算有限公司",
      "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=阿里云计算有限公司,OU=Security,L=Hangzhou,ST=Zhejiang,CN=Aliyun",
      "SignAlgorithm": "SHA256WITHRSA",
      "OrganizationUnit": "Security",
      "AfterDate": 0,
      "Sha2": "14dcc8afc7578e1fcec36d658f7e20de18f6957bbac42b373a66bc9de4e9****",
      "CommonName": "aliyun.com",
      "Md5": "05e148d8d3ecc9976d9ecd2b2f25****",
      "CountryCode": "CN",
      "BeforeDate": 0
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.