ListCert - Certificate Management Service - Alibaba Cloud Documentation Center

This API queries certificates in the certificate store.

Operation description

The single-user QPS limit for this API is 10. Calls exceeding this limit are throttled, which may impact your business. Plan your API calls accordingly.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
KeyWord	string	No	The keyword for a fuzzy search by name, domain name, or subject alternative name.	test_name
WarehouseId	integer	No	The warehouse ID. You can obtain this ID by calling the ListCertWarehouse API.	12
Status	string	No	The certificate status. Valid values: ISSUE: issued REVOKE: revoked	ISSUE
SourceType	string	No	The source of the certificate. Valid values: upload: uploaded certificate aliyun: Alibaba Cloud certificate	aliyun
CertType	string	No	The certificate type. Valid values: CA: CA certificate CERT: issued certificate	CERT
CurrentPage	integer	No	The page number to return. The default value is 1.	1
ShowSize	integer	No	The number of entries per page. The default value is 50.	50
Identifiers	string	No	A comma-separated list of certificate identifiers.	aaa,bbb

Response elements

Element	Type	Description	Example
	object	A container for the response data.
ShowSize	integer	The page size. Default value: 50.	50
CurrentPage	integer	The current page number. Default value: 1.	1
TotalCount	integer	The total number of entries.	10
CertList	array<object>	The list of certificates.
	object	The details of a certificate.
WhId	integer	The warehouse ID.	2
Identifier	string	The unique identifier of the certificate.	14dcc8afc7578e
WhInstanceId	string	The warehouse instance ID.	test_whInstanceId
Status	string	The status of the certificate. Valid values: ISSUE: The certificate is issued. REVOKE: The certificate is revoked.	ISSUE
SourceType	string	The source of the certificate. Valid values: upload: The certificate is uploaded. aliyun: The certificate is from Alibaba Cloud.	aliyun
CertType	string	The type of the certificate. Valid values: CA: a Certificate Authority (CA) certificate CERT: an issued certificate	CERT
CommonName	string	The common name of the certificate. This is typically the primary domain name associated with the certificate.	aliyun.alibaba.com
BeforeDate	integer	The start date of the certificate's validity period. This value is a UNIX timestamp in milliseconds.	1665819958000
Issuer	string	The issuer of the certificate.	mySSL
AfterDate	integer	The expiration date of the certificate. This value is a UNIX timestamp in milliseconds.	1634283958000
ExistPrivateKey	boolean	Indicates whether a private key is available for the certificate. Valid values: true false	false
Sans	string	The Subject Alternative Names (SANs) associated with the certificate. Multiple domain names are separated by commas (,).	*.alibaba.com,aliyun.alibaba.com
SerialNo	string	The serial number of the certificate. This parameter is returned only if the `OrderType` request parameter is set to `CERT` or `UPLOAD`.
Algorithm	string	The encryption algorithm of the certificate. Valid values: RSA: the RSA algorithm ECC: the ECC algorithm SM2: the SM2 algorithm
SignAlgorithm	string	The signature algorithm of the certificate.
RequestId	string	The ID of the request.	15C66C7B-671A-4297-9187-2C4477247A74

Examples

Success response

JSON format

{
  "ShowSize": 50,
  "CurrentPage": 1,
  "TotalCount": 10,
  "CertList": [
    {
      "WhId": 2,
      "Identifier": "14dcc8afc7578e",
      "WhInstanceId": "test_whInstanceId",
      "Status": "ISSUE",
      "SourceType": "aliyun",
      "CertType": "CERT",
      "CommonName": "aliyun.alibaba.com",
      "BeforeDate": 1665819958000,
      "Issuer": "mySSL",
      "AfterDate": 1634283958000,
      "ExistPrivateKey": false,
      "Sans": "*.alibaba.com,aliyun.alibaba.com",
      "SerialNo": "",
      "Algorithm": "",
      "SignAlgorithm": ""
    }
  ],
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.