ListInstances - Certificate Management Service - Alibaba Cloud Documentation Center

Retrieves a list of instances.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Keyword	string	No	The keyword for fuzzy match. Matches domain names, instance names, or corresponding resource IDs.	test
Status	string	No	The instance status. Valid values: inactive: pending use. pending: under review. The latest certificate is being reviewed. willExpire: about to expire. expired: expired. refund: refunded. normal: normal. closed: closed and unavailable.	inactive
Brand	string	No	The certification authority (CA) brand. Valid values: WoSign, CFCA, DigiCert, GeoTrust, GlobalSign, vTrus, and Alibaba.	Digicert
CertificateType	string	No	The type of the certificate. Valid values: DV, OV, and EV.	DV
CertificateStatus	string	No	The status of the certificate. Valid values: issued: issued. revoked: revoked. willExpire: about to expire. expired: expired.	issued
InstanceType	string	No	The instance type. Valid values: BUY (official certificate) and TEST (test certificate).	BUY
ResourceGroupId	string	No	The resource group ID.	rg-ae******4wia
ShowSize	integer	No	The number of instances to display per page in a paged query. Default value: 10. Maximum value: 100.	10
CurrentPage	integer	No	The page number of the current page in a paged query. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	12345678-1234-1234-1234-123456789ABC
TotalCount	integer	The total number of instances.	12
ShowSize	integer	The number of records per page.	20
CurrentPage	integer	The current page number in a paged query.	1
InstanceList	array<object>	The list of instances.
	object	The instance.
InstanceId	string	The instance ID.	cas_dv-cn-123
KeyAlgorithm	string	The certificate algorithm. Default value: RSA_2048. Valid values: RSA_2048 RSA_3072 RSA_4096 ECC_256 SM2.	RSA_2048
Status	string	The instance status. Valid values: inactive: pending use. pending: under review. The latest certificate is being reviewed. willExpire: about to expire. expired: expired. refund: refunded. normal: normal. closed: closed and unavailable.	inactive
Domain	string	The domain name bound to the certificate.	test.com
CertificateDomain	string	The domain name of the latest issued certificate.	abc.com,www.abc.com
Spec	string	The purchased instance specification.	ss.dv.t
CertificateId	integer	The certificate ID.	18541349
CertificateName	string	The certificate name.	cert-13216408
UsingProductList	array	The list of cloud services to which the latest certificate is deployed.
	string	The cloud service to which the certificate is deployed.	['DCDN', 'VOD', 'CDN', 'OSS']
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: certificate ID + "-cn-hangzhou" For the China site: 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".	21795675-cn-hangzhou
Brand	string	The CA brand. Valid values: WoSign, CFCA, DigiCert, GeoTrust, GlobalSign, vTrus, and Alibaba.	DigiCert
CertificateType	string	The type of the certificate. Valid values: DV, OV, and EV.	DV
CertificateStatus	string	The status of the certificate. Valid values: issued: issued. revoked: revoked. willExpire: about to expire. expired: expired.	issued
InstanceType	string	The instance type. Valid values: BUY (official certificate) and TEST (test certificate).	BUY
OrderStartTime	integer	The start time of the instance purchase, in UNIX timestamp format. This value is used to determine the refund time limit.	1801324800000
CertificateRevokeTime	integer	The revocation time of the latest certificate, in UNIX timestamp format.	1801324800000
OrderEndTime	integer	The end time of the instance purchase, in UNIX timestamp format. This value is used to determine the purchase duration of the instance.	1801324800000
InstanceStartTime	integer	The start time of the instance, in UNIX timestamp format. If no certificate has been issued, this value is empty.	1801324800000
InstanceEndTime	integer	The expiration time of the instance, in UNIX timestamp format. If no certificate has been issued, this value is empty.	1801324800000
CertificateNotAfter	integer	The end time of the latest certificate, in UNIX timestamp format. If no certificate has been issued, this value is empty.	1801324800000
CertificateNotBefore	integer
AutoReissue	string	Indicates whether automatic managed renewal is enabled. Valid values: enable: enabled. disable: disabled.	enable
FullDomainCount	integer	The number of exact-match domain names.	1
WildcardDomainCount	integer	The number of wildcard domain names.	0
PendingResult	string	The result returned by the CA during the last certificate operation.	pending
ResourceGroupId	string	The resource group ID.	123

Examples

Success response

JSON format

{
  "RequestId": "12345678-1234-1234-1234-123456789ABC",
  "TotalCount": 12,
  "ShowSize": 20,
  "CurrentPage": 1,
  "InstanceList": [
    {
      "InstanceId": "cas_dv-cn-123",
      "KeyAlgorithm": "RSA_2048",
      "Status": "inactive",
      "Domain": "test.com",
      "CertificateDomain": "abc.com,www.abc.com",
      "Spec": "ss.dv.t",
      "CertificateId": 18541349,
      "CertificateName": "cert-13216408",
      "UsingProductList": [
        "['DCDN', 'VOD', 'CDN', 'OSS']"
      ],
      "CertIdentifier": "21795675-cn-hangzhou",
      "Brand": "DigiCert",
      "CertificateType": "DV",
      "CertificateStatus": "issued",
      "InstanceType": "BUY",
      "OrderStartTime": 1801324800000,
      "CertificateRevokeTime": 1801324800000,
      "OrderEndTime": 1801324800000,
      "InstanceStartTime": 1801324800000,
      "InstanceEndTime": 1801324800000,
      "CertificateNotAfter": 1801324800000,
      "CertificateNotBefore": 0,
      "AutoReissue": "enable",
      "FullDomainCount": 1,
      "WildcardDomainCount": 0,
      "PendingResult": "pending",
      "ResourceGroupId": "123"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.