ListCertificates - Certificate Management Service - Alibaba Cloud Documentation Center

Retrieves a list of certificates.

Operation description

Queries the operation logs of CA certificates, including root CA certificates and subordinate CA certificates. For example, you can query the creation logs and status change logs of CA certificates.

The per-user queries per second (QPS) limit for this operation is 10. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation at an appropriate frequency.

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:ListCertificates

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The keyword for fuzzy match. The keyword is matched against domain names, names, and corresponding resource IDs.	test
InstanceId	string	No	The ID of the instance.	cas-ivauto-hqito6
CertificateStatus	string	No	The status of the certificate. Valid values: issued: Issued. revoked: Revoked. willExpire: About to expire. expired: Expired.	issued
CertificateSource	string	No	The source of the certificate. Valid values: BUY: a formal certificate. TEST: a test certificate. UPLOAD: an uploaded certificate.	BUY
ResourceGroupId	string	No	The ID of the resource group.	rg-aek****wia
ShowSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
CurrentPage	integer	No	The page number of the current page.	1

Response elements

Element	Type	Description	Example
	object
CertificateList	array<object>	The list of certificates.
	object	The certificate information.
Algorithm	string	The encryption algorithm type of the certificate. Valid values: RSA: RSA algorithm. ECC: ECC algorithm. SM2: SM2 (Chinese national cryptographic) algorithm.	RSA
CertIdentifier	string	The global certificate ID, in the format of certificate ID + "-" + site region ID. This ID is commonly used across Alibaba Cloud services. For the China site, the value is certificate ID + "-cn-hangzhou". For the China site, the value is certificate ID + "-ap-southeast-1". For example, if the certificate ID is 123, the CertIdentifier on the China site is "123-cn-hangzhou", and the CertIdentifier on the China site is "123-ap-southeast-1".	21589515-cn-hangzhou
CertificateId	string	The certificate ID.	17281539
CertificateName	string	The certificate name.	test
CertificateSource	string	The source of the certificate. Valid values: BUY: a formal certificate. TEST: a test certificate. UPLOAD: an uploaded certificate.	BUY
CertificateStatus	string	The status of the certificate. Valid values: issued: Issued. revoked: Revoked. willExpire: About to expire. expired: Expired.	issued
CommonName	string	The common name of the certificate.	aliyun.com
DeploymentDesc	string	The deployment information in JSON format: --Scope: valid values are all/server. If the certificate has a private key, the value is all. If the certificate does not have a private key, the value is server. --ServerName: the name of the server associated with the certificate instance. --ResourceInstanceId: the resource identifier of the server associated with the certificate instance.	{ "Scope": "all", "ServerName": "acmeServerName", "ResourceInstanceId": "cas_dv-cn-XXX" }
Domain	string	The domain names bound to the certificate. Multiple domain names are separated by commas (,).	test.com
ExistPrivateKey	boolean	Indicates whether the certificate has a private key. Valid values: true false	true
FingerPrint	string	The fingerprint of the public key.	123
InstanceId	string	The certificate instance ID.	cas-cn-v***
Issuer	string	The certificate issuer.	DigiCert
KeySize	integer	The key algorithm length. The RSA algorithm length is typically 2048, 3072, or 4096. The ECC and SM2 algorithm length is typically 256.	2048
NotAfter	integer	The end time of the certificate validity period.	1749580567000
NotBefore	integer	The start time of the certificate validity period.	1760745600000
Serial	string	The certificate serial number.	123
SubjectAlternativeNames	array	The list of subject alternative names (SANs) of the certificate, returned as an array. This corresponds to the `Subject Alternative Name` field of the certificate.
	string	The subject alternative name of the certificate.	test.com
UsingProductList	array	The list of Alibaba Cloud services to which the certificate is currently deployed.
	string	The Alibaba Cloud service.	CDN
CurrentPage	integer	The current page number. Default value: 1.	1
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
ShowSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of entries returned.	10

Examples

Success response

JSON format

{
  "CertificateList": [
    {
      "Algorithm": "RSA",
      "CertIdentifier": "21589515-cn-hangzhou",
      "CertificateId": "17281539",
      "CertificateName": "test",
      "CertificateSource": "BUY",
      "CertificateStatus": "issued",
      "CommonName": "aliyun.com",
      "DeploymentDesc": "{\n      \"Scope\": \"all\",\n       \"ServerName\": \"acmeServerName\",\n       \"ResourceInstanceId\": \"cas_dv-cn-XXX\"\n}",
      "Domain": "test.com",
      "ExistPrivateKey": true,
      "FingerPrint": "123",
      "InstanceId": " cas-cn-v***",
      "Issuer": "DigiCert",
      "KeySize": 2048,
      "NotAfter": 1749580567000,
      "NotBefore": 1760745600000,
      "Serial": "123",
      "SubjectAlternativeNames": [
        "test.com"
      ],
      "UsingProductList": [
        "CDN"
      ]
    }
  ],
  "CurrentPage": 1,
  "RequestId": "CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D",
  "ShowSize": 10,
  "TotalCount": 10
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.