GetInstance - Identity as a Service - Alibaba Cloud Documentation Center

Queries the details of a specified EIAM instance.

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:GetInstance

get

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
Instance	object	The instance information.
InstanceId	string	The instance ID.	idaas_abt3pfwojojcq323si6g5xxxxx
CreateTime	integer	The time when the instance was created. The value is a UNIX timestamp in milliseconds.	1550115455000
Status	string	The status of the instance. 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. This parameter is deprecated. Use the fields in the DomainConfig object or call the operation that queries the list of domain names.
Endpoint	string	The domain name of the instance.	example-xxx.aliyunidaas.com
Status	string	The status of the domain name. Valid values: resolved: The domain name is resolved. unresolved: The domain name is not resolved.	resolved
EgressAddresses	array	The public IP address CIDR blocks for instance egress. For example, during Active Directory (AD) account synchronization, the EIAM instance uses these CIDR blocks to access your AD service.
	string	The public egress IP address.	出口公网地址，具体以接口实际返回为准。示例：203.0.XX.XX/27
DomainConfig	object	The configurations of the instance domain name.
InitDomainAutoRedirectStatus	string	The status of automatic redirection for the initial domain name. Valid values: enabled: enabled. disabled: disabled.	disabled
DefaultDomain	string	The default domain name of the instance.	login.example.com
InitDomain	string	The initial domain name of the instance.	rx72nxxx.example.com
ServiceManaged	boolean
ManagedServiceCode	string		sase

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "Instance": {
    "InstanceId": "idaas_abt3pfwojojcq323si6g5xxxxx",
    "CreateTime": 1550115455000,
    "Status": "running",
    "Description": "线上环境使用",
    "DefaultEndpoint": {
      "Endpoint": "example-xxx.aliyunidaas.com\n",
      "Status": "resolved"
    },
    "EgressAddresses": [
      "出口公网地址，具体以接口实际返回为准。\n示例：203.0.XX.XX/27"
    ],
    "DomainConfig": {
      "InitDomainAutoRedirectStatus": "disabled",
      "DefaultDomain": "login.example.com",
      "InitDomain": "rx72nxxx.example.com"
    },
    "ServiceManaged": false,
    "ManagedServiceCode": "sase"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.