ListCertificates - Certificate Management Service - Alibaba Cloud Documentation Center

Queries the certificates managed by Certificate Management Service.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	A keyword for a fuzzy query. The keyword can be a domain name, a certificate name, or a resource ID.	test
InstanceId	string	No	The ID of the instance.	cas-ivauto-hqito6
CertificateStatus	string	No	The status of the certificate. issued: The certificate is issued. revoked: The certificate is revoked. willExpire: The certificate is about to expire. expired: The certificate has expired.	issued
CertificateSource	string	No	The source of the certificate. BUY: A purchased 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 to return on each page. Default value: 10. Maximum value: 100.	10
CurrentPage	integer	No	The page number. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request. Alibaba Cloud generates a unique ID for each request. You can use the ID to troubleshoot issues.	CBF1E9B7-D6A0-4E9E-AD3E-2B47E6C2837D
TotalCount	integer	The total number of entries.	10
ShowSize	integer	The number of entries returned on each page.	10
CurrentPage	integer	The current page number. Default value: 1.	1
CertificateList	array<object>	The list of certificates.
	object	The certificate information.
InstanceId	string	The ID of the certificate instance.	cas-cn-v***
Algorithm	string	The encryption algorithm of the certificate. Valid values: RSA ECC SM2	RSA
CertificateStatus	string	The status of the certificate. issued: The certificate is issued. revoked: The certificate is revoked. willExpire: The certificate is about to expire. expired: The certificate has expired.	issued
Domain	string	The domain names that are bound to the certificate. Multiple domain names are separated by commas.	test.com
CertificateId	string	The ID of the certificate.	17281539
CertificateName	string	The name of the certificate.	test
CertIdentifier	string	The global ID of the certificate. This ID is used across Alibaba Cloud services and is in the `Certificate ID-Region ID` format. For example, if a certificate ID is `123`, the `CertIdentifier` is `123-cn-hangzhou` for the Alibaba Cloud China site and `123-ap-southeast-1` for the Alibaba Cloud International site (www.alibabacloud.com). For the Alibaba Cloud China website, the format is certificate ID + "-cn-hangzhou". For the Alibaba Cloud International website (www.alibabacloud.com), the format is certificate ID + "-ap-southeast-1". For example, if the certificate ID is 123, the CertIdentifier is "123-cn-hangzhou" for the China site and "123-ap-southeast-1" for the International site.	21589515-cn-hangzhou
CommonName	string	The common name of the certificate.	aliyun.com
SubjectAlternativeNames	array	An array that contains the alternative domain names of the certificate. This parameter corresponds to the `Subject Alternative Name` field of the certificate.
	string	An alternative domain name of the certificate.	test.com
CertificateSource	string	The source of the certificate. BUY: A purchased certificate. TEST: A test certificate. UPLOAD: An uploaded certificate.	BUY
NotBefore	integer	The beginning of the certificate validity period.	1760745600000
NotAfter	integer	The end of the certificate validity period.	1749580567000
KeySize	integer	The key size, in bits. For RSA keys, typical sizes are 2048, 3072, or 4096. For ECC or SM2 keys, the typical size is 256.	2048
FingerPrint	string	The fingerprint of the public key.	123
Serial	string	The serial number of the certificate.	123
Issuer	string	The certification authority.	DigiCert
ExistPrivateKey	boolean	Indicates whether a private key is available. Valid values: true: A private key is available. false: A private key is not available.	true
UsingProductList	array	The list of Alibaba Cloud products in which the certificate is deployed.
	string	An Alibaba Cloud product.	CDN

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.