ListInstance - - Alibaba Cloud Documentation Center

Queries the details of one or more instances.

Operation description

This operation returns a list of instances sorted by creation time (GmtCreate) in descending order. The request parameters are used as filters and are combined with a logical AND. Empty parameters are not used for filtering.

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 syntax

GET /v2/openapi/instances HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
page	integer	No	The page number. Default value: 1.	1
size	integer	No	The number of entries to return on each page. Default value: 10. Valid values: 1 to 50.	10
status	string	No	The running status of the instances to filter. Valid values: Initializing: The instance is being initialized. Ready: The instance is ready for data import. Running: The instance is running.	Running
name	string	No	The name of the instances to filter. Fuzzy matching is supported.	实例1
expiredTime	string	No	A UNIX timestamp in seconds. Use this parameter to filter for instances that are about to expire. Specify a time that is later than the current time. Expired instances are not included in the results.	1608533404
instanceId	string	No	The ID of the instances to filter. Fuzzy matching is supported.	airec-cn-****

Response elements

Element	Type	Description	Example
	object	The response parameters.
result	array<object>	The parameters that are returned.
	object	The returned parameters.
regionId	string	The region ID of the instance.	cn-beijing
type	string	The type of the instance. Valid values: Algorithm_configuration: Algorithm Configuration Edition. Industry_operation: Industry Operation Edition. Cold_start: Cold Start Edition.	Standard
lockMode	string	The lock status of the instance. Valid values: Unlock: Not locked. ManualLock: Manually locked. LockByExpiration: Locked due to an overdue payment.	Unlock
expiredTime	string	The expiration time of the instance. The time is in UTC.	2019-01-06T16:00:00.000Z
status	string	The running status of the instance. Valid values: Initializing: The instance is being initialized. Ready: The instance is ready for data import. Running: The instance is running.	Running
gmtCreate	string	The creation time of the instance. The time is in UTC.	2018-12-06T06:14:01.000Z
chargeType	string	The billing method of the instance. Valid values: PREPAY: Subscription. POSTPAY: Pay-as-you-go.	PrePaid
industry	string	The industry type of the instance. Valid values: content: Content-based. item: E-commerce. news: News.	news
commodityCode	string	The commodity code for the Airec service.	airecpre
gmtModified	string	The last update time of the instance. The time is in UTC.	2018-12-06T11:17:49.000Z
dataSetVersion	string	The dataset version used by the online service.	20181206170353
name	string	The name of the instance.	实例1
instanceId	string	The ID of the instance.	airec-cn-****
code	string	The error code returned if the request fails.	InternalServerError
requestId	string	The ID of the request.	8F81A922-6C81-46D6-B78C-CC35E16B1691
message	string	The error message returned if the request fails.	An internal server error occurred

Examples

Success response

JSON format

{
  "result": [
    {
      "regionId": "cn-beijing",
      "type": "Standard",
      "lockMode": "Unlock",
      "expiredTime": "2019-01-06T16:00:00.000Z",
      "status": "Running",
      "gmtCreate": "2018-12-06T06:14:01.000Z",
      "chargeType": "PrePaid",
      "industry": "news",
      "commodityCode": "airecpre",
      "gmtModified": "2018-12-06T11:17:49.000Z",
      "dataSetVersion": "20181206170353",
      "name": "实例1",
      "instanceId": "airec-cn-****"
    }
  ],
  "code": "InternalServerError",
  "requestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
  "message": "An internal server error occurred"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.