ListInstances - Identity as a Service - Alibaba Cloud Documentation Center

Queries the information about one or more Enterprise Identity and Access Management (EIAM) instances of Identity as a Service (IDaaS).

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
eiam:ListInstances	get	Instance `acs:eiam:{#regionId}:{#accountId}:instance/`	none	none

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	long	No	The number of the page to return.	1
PageSize	long	No	The number of entries to return on each page.	20
InstanceIds	array	No	The list of instance IDs.
	string	No	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
Status	string	No	The status of the instance. Valid values: creating running	running

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	long	The total number of entries returned.	100
Instances	array<object>	The information of instances.
Instance	object	The information about the array object.
InstanceId	string	The instance ID.	idaas_eypq6ljgyeuwmlw672sulxxxxx
CreateTime	long	The time when the instance was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1550115455000
Status	string	The status of the instance. Valid values: creating running	running
Description	string	The description of the instance.
DefaultEndpoint	object	The default endpoint of the instance.
Endpoint	string	The endpoint of the instance.	example-xxx.aliyunidaas.com
Status	string	The status of the endpoint. Valid values: resolved unresolved	resolved

Examples

Sample success responses

JSONformat

{
  "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"
      }
    }
  ]
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history