ListInstances - Identity as a Service - Alibaba Cloud Documentation Center

Queries information about one or more EIAM 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

eiam:ListInstances

get

*Instance

acs:eiam:{#regionId}:{#accountId}:instance/*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	20
InstanceIds	array	No	A list of instance IDs.
	string	No	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
Status	string	No	The instance status. Valid values: creating: The instance is being created. running: The instance is running.	running

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	The total number of entries.	100
Instances	array<object>	The list of instances.
	array<object>	An array that contains information about the instances.
InstanceId	string	The instance ID.	idaas_eypq6ljgyeuwmlw672sulxxxxx
CreateTime	integer	The time when the instance was created. This is a UNIX timestamp. Unit: milliseconds.	1550115455000
Status	string	The instance status. Valid values: creating: The instance is being created. running: The instance is running.	running
Description	string	The description of the instance.	正式环境
DefaultEndpoint	object	The default domain name of the instance.
Endpoint	string	The endpoint of the instance.	example-xxx.aliyunidaas.com
Status	string	The status of the instance domain name. Valid values: resolved: The domain name is resolved. unresolved: The domain name is not resolved.	resolved
ServiceManaged	boolean	Indicates whether the instance is managed by an Alibaba Cloud service.	true
ManagedServiceCode	string	The service code of the Alibaba Cloud service that manages the instance.	sase

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "Instances": [
    {
      "InstanceId": "idaas_eypq6ljgyeuwmlw672sulxxxxx",
      "CreateTime": 1550115455000,
      "Status": "running",
      "Description": "正式环境",
      "DefaultEndpoint": {
        "Endpoint": "example-xxx.aliyunidaas.com\n",
        "Status": "resolved"
      },
      "ServiceManaged": true,
      "ManagedServiceCode": "sase"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.