ListDomains - Query accelerated domain names and ICP filing status - Global Accelerator

Queries accelerated domain names and their ICP filing status.

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

ga:ListDomains

list

*Domain

acs:ga:{#regionId}:{#accountId}:ga/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	Region ID of the GA instance. Set to cn-hangzhou.	cn-hangzhou
AcceleratorId	string	No	ID of the GA instance to query.	ga-bp1odcab8tmno0hdq****
Domain	string	No	Accelerated domain name to query.	www.example.com
PageNumber	integer	No	Page number. Default: 1.	1
PageSize	integer	No	Entries per page. Maximum: 50. Default: 10.	10
State	string	No	ICP filing status to filter by. Valid values: illegal: Illegal domain name. inactive: ICP filing incomplete. active: Valid ICP filing. unknown: Unknown.	active

Response elements

Element	Type	Description	Example
	object	Response parameters.
TotalCount	integer	Total number of entries.	1
PageSize	integer	Entries per page.	10
RequestId	string	Request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
PageNumber	integer	Page number.	1
Domains	array<object>	Accelerated domain names.
	array<object>	Accelerated domain names.
Accelerators	array<object>	Associated GA instances.
	array<object>	GA instances.
AcceleratorId	string	GA instance ID.	ga-bp1odcab8tmno0hdq****
Name	string	GA instance name.	Accelerator
ServiceId	string	Service ID managing the GA instance. Note Returned only when ServiceManaged is True.	ALB
ServiceManaged	boolean	Whether the GA instance is managed. Valid values: true: Managed. false: Not managed.	true
ServiceManagedInfos	array<object>	Allowed actions on the managed instance. Note Returned only when ServiceManaged is True.
	object
Action	string	Action name. Valid values: Create: Create an instance. Update: Update the instance. Delete: Delete the instance. Associate: Associate the instance. UserUnmanaged: Unmanage the instance. CreateChild: Create a child resource.	Update
ChildType	string	Child resource type. Valid values: Listener: Listener. IpSet: Acceleration region. EndpointGroup: Endpoint group. ForwardingRule: Forwarding rule. Endpoint: Endpoint. EndpointGroupDestination: Protocol mapping of an endpoint group for a custom routing listener. EndpointPolicy: Traffic policy of an endpoint for a custom routing listener. Note Returned only when Action is CreateChild.	Listener
IsManaged	boolean	Whether the action is managed. Valid values: true: Managed. You cannot perform this action on the instance. false: Not managed. You can perform this action on the instance.	false
Domain	string	Accelerated domain name.	www.example.com
State	string	ICP filing status. Valid values: illegal: Illegal domain name. inactive: ICP filing incomplete. active: Valid ICP filing. unknown: Unknown.	active

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "PageSize": 10,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "PageNumber": 1,
  "Domains": [
    {
      "Accelerators": [
        {
          "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
          "Name": "Accelerator",
          "ServiceId": "ALB",
          "ServiceManaged": true,
          "ServiceManagedInfos": [
            {
              "Action": "Update",
              "ChildType": "Listener",
              "IsManaged": false
            }
          ]
        }
      ],
      "Domain": "www.example.com",
      "State": "active"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.