All Products
Search
Document Center

Global Accelerator:ListDomains

Last Updated:Jul 31, 2024

Queries the information of an accelerated domain name of a GA instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
ga:ListDomainslist
  • Domain
    acs:ga:{#regionId}:{#accountId}:ga/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID of the GA instance. Set the value to cn-hangzhou.

cn-hangzhou
AcceleratorIdstringNo

The ID of the GA instance that you want to query.

ga-bp1odcab8tmno0hdq****
DomainstringNo

The accelerated domain name that you want to query.

www.example.com
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Maximum value: 50. Default value: 10.

10
StatestringNo

The ICP filing status of the accelerated domain name that you want to query. Valid values:

  • illegal: The domain name is illegal.
  • inactive: The domain name has not completed ICP filing.
  • active: The domain name has a valid ICP filing.
  • unknown: The ICP filing status is unknown.
active

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

TotalCountinteger

The number of entries returned.

1
PageSizeinteger

The number of entries returned per page.

10
RequestIdstring

The ID of the request.

04F0F334-1335-436C-A1D7-6C044FE73368
PageNumberinteger

The page number of the returned page.

1
Domainsarray<object>

A list of accelerated domain names.

object

The list of accelerated domain names.

Acceleratorsarray<object>

A list of GA instances.

object

The list of GA instances.

AcceleratorIdstring

The ID of the GA instance.

ga-bp1odcab8tmno0hdq****
Namestring

The name of the GA instance.

Accelerator
ServiceIdstring

The ID of the service that manages the GA instance.

Note This parameter takes effect only if ServiceManaged is set to True.
ALB
ServiceManagedboolean

Indicates whether the GA instance is managed. Valid values:

  • true: The GA instance is managed.
  • false: The GA instance is not managed.
true
ServiceManagedInfosarray<object>

The actions that you can perform on the managed instance.

Note This parameter takes effect only if ServiceManaged is set to True.
  • You can perform only specific actions on a managed instance.
object
Actionstring

The name of the action on the managed instance. Valid values:

  • Create: Create an instance.
  • Update: Update the current instance.
  • Delete: Delete the current instance.
  • Associate: Reference the current instance.
  • UserUnmanaged: Unmanage the instance.
  • CreateChild: Create a child resource in the current instance.
Update
ChildTypestring

The type of the child resource. Valid values:

  • Listener: listener.
  • IpSet: acceleration region.
  • EndpointGroup: endpoint group.
  • ForwardingRule: forwarding rule.
  • Endpoint: endpoint.
  • EndpointGroupDestination: protocol mapping of an endpoint group associated with a custom routing listener.
  • EndpointPolicy: traffic policy of an endpoint associated with a custom routing listener.
Note This parameter takes effect only if Action is set to CreateChild.
Listener
IsManagedboolean

Indicates whether the specified actions are managed. Valid values:

  • true: The specified actions are managed, and you cannot perform the specified actions on the managed instance.
  • false: The specified actions are not managed, and you can perform the specified actions on the managed instance.
false
Domainstring

The accelerated domain name.

www.example.com
Statestring

The ICP filing status of the accelerated domain name. Valid values:

  • illegal: The domain name is illegal.
  • inactive: The domain name has not completed ICP filing.
  • active: The domain name has a valid ICP number.
  • unknown: The ICP filing status is unknown.
active

Examples

Sample success responses

JSONformat

{
  "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

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

Change history

Change timeSummary of changesOperation
2023-07-20The internal configuration of the API is changed, but the call is not affectedView Change Details