ListInstances-阿里云帮助中心

Gets a list of PAIRec 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

pairec:ListInstances

none

*All Resource

*

None

Request syntax

GET /api/v1/instances HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the instance. You can use this parameter to perform a fuzzy search for instances.	pairec-test1
SortBy	string	No	The field by which to sort the results.	Type
Order	string	No	The sort order. Valid values: `Asc` (ascending) and `Desc` (descending).	Desc
PageNumber	integer	No	The number of entries per page.	1
PageSize	integer	No	The page number.	50
Type	string	No	The instance type. Valid values: `basic`: Basic edition `high-level`: High-level edition `advanced`: Advanced edition `standard`: Standard edition	basic

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	BDB621CB-A81E-5D39-8793-39A365CBCC74
Instances	array<object>	A list of instances.
	array<object>
InstanceId	string	The instance ID.	pairec-test1
Type	string	The instance type. Valid values: `basic`: Basic Edition `high-level`: High-level Edition `advanced`: Advanced Edition `standard`: Standard Edition	basic
Status	string	The instance status. Valid values: `Initializing`: The instance is initializing. `Stopped`: The instance is stopped. `Running`: The instance is running.	Initializing
RegionId	string	The region ID. Valid values: `cn-shenzhen`: China (Shenzhen) `cn-hangzhou`: China (Hangzhou) `cn-beijing`: China (Beijing) `cn-shanghai`: China (Shanghai)	cn-shenzhen
GmtCreateTime	string	The time when the instance was created.	2022-10-13 17:34:52.0
GmtModifiedTime	string	The time when the instance was last modified.	2022-11-05 09:02:30.0
ExpiredTime	string	The time when the instance expires.	2022-12-14 00:00:00.0
CommodityCode	string	The commodity code of the instance.	airec_developers_public_cn
ChargeType	string	The billing method of the instance. Only `Subscription` (prepaid) is supported.	Subscription
Config	object	The instance configuration.
Engines	array<object>	A list of service engines.
	array<object>
ComponentCode	string	The component code.	feature
Type	string	The component type.	Hologres
Meta	object	The metadata of the component.
Monitors	array<object>	A list of monitoring components.
	array<object>
ComponentCode	string	The component code.	featuresets
Type	string	The component type.	Platform
Meta	object	The metadata of the component.
DataManagements	array<object>	A list of data management configurations.
	array<object>
ComponentCode	string	The component code.	storage
Type	string	The component type.	OSS
Meta	object	The metadata of the component.
OperatingTool	object	The configuration of the operating tool.
IsEnable	boolean	Specifies whether the operating tool is enabled for the instance. Valid values: `true`: The tool is enabled. `false`: The tool is disabled.	true
TotalCount	integer	The total number of returned instances.	7

Examples

Success response

JSON format

{
  "RequestId": "BDB621CB-A81E-5D39-8793-39A365CBCC74",
  "Instances": [
    {
      "InstanceId": "pairec-test1",
      "Type": "basic",
      "Status": "Initializing",
      "RegionId": "cn-shenzhen",
      "GmtCreateTime": "2022-10-13 17:34:52.0",
      "GmtModifiedTime": "2022-11-05 09:02:30.0",
      "ExpiredTime": "2022-12-14 00:00:00.0",
      "CommodityCode": "airec_developers_public_cn",
      "ChargeType": "Subscription",
      "Config": {
        "Engines": [
          {
            "ComponentCode": "feature",
            "Type": "Hologres",
            "Meta": {
              "test": "test",
              "test2": 1
            }
          }
        ],
        "Monitors": [
          {
            "ComponentCode": "featuresets",
            "Type": "Platform",
            "Meta": {
              "test": "test",
              "test2": 1
            }
          }
        ],
        "DataManagements": [
          {
            "ComponentCode": "storage",
            "Type": "OSS",
            "Meta": {
              "test": "test",
              "test2": 1
            }
          }
        ]
      },
      "OperatingTool": {
        "IsEnable": true
      }
    }
  ],
  "TotalCount": 7
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.