All Products
Search

This Product

    Identity as a Service:ListEiamInstances

    Document Center

    Identity as a Service:ListEiamInstances

    Last Updated:Mar 24, 2026

    Queries the information about Employee Identity and Access Management (EIAM) V1.0 instances or EIAM V2.0 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:ListEiamInstances

    list

    *Instance

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

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceIds

    array

    No

    The instance ID list.

    string

    No

    The instance ID.

    idaas_ue2jvisn35ea5lmthk267xxxxx
    InstanceRegionId

    string

    No

    The region in which the instance resides.

    cn-hangzhou

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    0441BD79-92F3-53AA-8657-F8CE4A2B912A
    Instances

    array<object>

    The instance list.

    object

    The instance.

    Description

    string

    The instance description.

    Production environment
    InstanceId

    string

    The instance ID.

    idaas_eypq6ljgyeuwmlw672sulxxxxx
    StartTime

    integer

    The time when the instance was created.

    1677810869300
    SSODomain

    string

    The single sign-on (SSO) domain of the instance.

    xxxx.aliyunidaas.com
    DeveloperAPIPrivateDomain

    string

    The private domain name of the instance Developer API.

    eiam-developerapi-cn.vpc-proxy.aliyuncs.com
    DeveloperAPIPublicDomain

    string

    The public domain of the instance Developer API.

    eiam-developerapi.cn-hangzhou.aliyuncs.com
    OpenAPIPrivateDomain

    string

    The private domain of the instance OpenAPI.

    eiam-cn.vpc-proxy.aliyuncs.com
    OpenAPIPublicDomain

    string

    The public domain of the instance OpenAPI.

    eiam.cn-hangzhou.aliyuncs.com
    InstanceStatus

    string

    The instance status.

    RUNNING
    InstanceVersion

    string

    The instance version.

    Valid values:

    • EIAM 2.0

    • EIAM 1.0

    Valid values:

    • EIAM 2.0 :

      EIAM 2.0

    • EIAM 1.0 :

      EIAM 1.0

    EIAM 2.0

    Examples

    Success response

    JSON format

    {
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "Instances": [
    {
      "Description": "Production environment",
      "InstanceId": "idaas_eypq6ljgyeuwmlw672sulxxxxx",
      "StartTime": 1677810869300,
      "SSODomain": "xxxx.aliyunidaas.com",
      "DeveloperAPIPrivateDomain": "eiam-developerapi-cn.vpc-proxy.aliyuncs.com",
      "DeveloperAPIPublicDomain": "eiam-developerapi.cn-hangzhou.aliyuncs.com",
      "OpenAPIPrivateDomain": "eiam-cn.vpc-proxy.aliyuncs.com",
      "OpenAPIPublicDomain": "eiam.cn-hangzhou.aliyuncs.com",
      "InstanceStatus": "RUNNING",
      "InstanceVersion": "EIAM 2.0"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.