ListDomains - Identity as a Service - Alibaba Cloud Documentation Center

Queries the domain names of an EIAM instance, including the default domain name and custom domain names.

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

list

*Domain

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
BrandId	string	No	The brand ID.	brand_xxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
Domains	array<object>	The list of domain names.
	array<object>	The domain name object.
InstanceId	string	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
DomainId	string	The domain name ID.	dm_examplexxxxx
Domain	string	The domain name.	www.example.com
DomainType	string	The type of the domain name. Valid values: system_init: The default domain name that is generated during initialization. user_custom: A custom domain name.	system_init
LockMode	string	The lock status of the domain name. Valid values: unlock: Normal. lockByLicense: The domain name is unavailable due to license limitations.	unlock
DefaultDomain	boolean	Indicates whether the domain name is the default one.	false
CreateTime	integer	The time when the domain name was created. This value is a UNIX timestamp. Unit: milliseconds.	1649830226000
UpdateTime	integer	The time when the domain name was last updated. This value is a UNIX timestamp. Unit: milliseconds.	1649830226000
Filing	object	The ICP filing information about the domain name.
IcpNumber	string	The ICP filing number associated with the domain name. Both entity and website ICP filing numbers are supported.	浙xx-xxxxxx
BrandId	string	The brand ID.	brand_xxxx

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "Domains": [
    {
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "DomainId": "dm_examplexxxxx",
      "Domain": "www.example.com",
      "DomainType": "system_init",
      "LockMode": "unlock",
      "DefaultDomain": false,
      "CreateTime": 1649830226000,
      "UpdateTime": 1649830226000,
      "Filing": {
        "IcpNumber": "浙xx-xxxxxx"
      },
      "BrandId": "brand_xxxx"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.