GetInstance - Identity as a Service - Alibaba Cloud Documentation Center

Queries the information of an Enterprise Identity and Access Management (EIAM) instance 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:
- For mandatory resource types, indicate with a prefix of * .
- 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:GetInstance		*Instance `acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}`	none	none

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
Instance	object	The details of the instance.
InstanceId	string	The instance ID.	idaas_abt3pfwojojcq323si6g5xxxxx
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.	test_description
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
EgressAddresses	array	The outbound public CIDR blocks of the instance. For example, when you synchronize Active Directory (AD) accounts, the IDaaS EIAM instance accesses your AD service by using the outbound public CIDR blocks.
EgressAddress	string	The outbound public CIDR block of the instance.	112.124.239.96/27
DomainConfig	object	The default domain of the instance.
InitDomainAutoRedirectStatus	string	Valid values: true false	true
DefaultDomain	string	The default domain of the instance.	example-xxx.example.com
InitDomain	string	The init domain of the instance.	example-xxx.aliyunidaas.com

Examples

Sample success responses

JSONformat

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "Instance": {
    "InstanceId": "idaas_abt3pfwojojcq323si6g5xxxxx",
    "CreateTime": 1550115455000,
    "Status": "running",
    "Description": "test_description",
    "DefaultEndpoint": {
      "Endpoint": "example-xxx.aliyunidaas.com\n",
      "Status": "resolved"
    },
    "EgressAddresses": [
      "112.124.239.96/27"
    ],
    "DomainConfig": {
      "InitDomainAutoRedirectStatus": "true",
      "DefaultDomain": "example-xxx.example.com",
      "InitDomain": "example-xxx.aliyunidaas.com"
    }
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2023-08-22	The response structure of the API has changed	View Change Details