ListDomains - - 阿里雲

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ListDomains	The operation that you want to perform. Set the value to ListDomains.
RegionId	String	No	cn-hangzhou	The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.
AcceleratorId	String	No	ga-bp1odcab8tmno0hdq****	The ID of the GA instance to be queried.
Domain	String	No	www.example.com	The accelerated domain name to be queried.
PageSize	Integer	No	10	The number of entries to return on each page. Maximum value: 50. Default value: 10.
PageNumber	Integer	No	1	The number of the page to return. Default value: 1.
State	String	No	active	The ICP filing status of the accelerated domain name to be queried. Valid values: illegal: The domain name is illegal. inactive: The domain name has not completed ICP filing. active: The domain name has completed ICP filing. unknown: The ICP filing status is unknown.

Response parameters


Parameter	Type	Example	Description
TotalCount	Integer	1	The total number of entries returned.
PageSize	Integer	10	The number of entries returned per page.
RequestId	String	04F0F334-1335-436C-A1D7-6C044FE73368	The ID of the request.
PageNumber	Integer	1	The page number of the returned page.
Domains	Array of Domains		The list of accelerated domain names.
Accelerators	Array of Accelerators		The list of GA instances.
AcceleratorId	String	ga-bp1odcab8tmno0hdq****	The ID of the GA instance.
Name	String	Accelerator	The name of the GA instance.
Domain	String	www.example.com	The accelerated domain name.
State	String	active	The ICP filing status of the accelerated domain name. illegal: The domain name is illegal. inactive: The domain name has not completed ICP filing. active: The domain name has completed ICP filing. unknown: The ICP filing status is unknown.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListDomains
&RegionId=cn-hangzhou
&AcceleratorId=ga-bp1odcab8tmno0hdq****
&Domain=www.example.com
&PageSize=10
&PageNumber=1
&State=active
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ListDomainsResponse>
    <TotalCount>1</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <PageNumber>1</PageNumber>
    <Domains>
        <Accelerators>
            <AcceleratorId>ga-bp1odcab8tmno0hdq****</AcceleratorId>
            <Name>Accelerator</Name>
        </Accelerators>
        <Domain>www.example.com</Domain>
        <State>active</State>
    </Domains>
</ListDomainsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "PageSize" : 10,
  "RequestId" : "04F0F334-1335-436C-A1D7-6C044FE73368",
  "PageNumber" : 1,
  "Domains" : [ {
    "Accelerators" : [ {
      "AcceleratorId" : "ga-bp1odcab8tmno0hdq****",
      "Name" : "Accelerator"
    } ],
    "Domain" : "www.example.com",
    "State" : "active"
  } ]
}

Error codes

For a list of error codes, see Service error codes.