Queries information about the acceleration region 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListIpSets

The operation that you want to perform. Set the value to ListIpSets.

RegionId String Yes cn-hangzhou

The ID of the region where the Global Accelerator (GA) instance that you want to query is deployed. Set the value to cn-hangzhou.

PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Maximum value: 100. Default value: 10.

AcceleratorId String Yes ga-bp1yeeq8yfoyszmqy****

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

Response parameters

Parameter Type Example Description
TotalCount Integer 2

The total number of entries returned.

PageSize Integer 10

The number of entries returned per page.

RequestId String A9B4E54C-9CCD-4002-91A9-D38C6C209192

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

IpSets Array of IpSets

Details of the acceleration region.

AccelerateRegionId String cn-hangzhou

The ID of the region that is accelerated.

IpVersion String IPv4

The version of the accelerated IP address. Valid values:

  • IPv4
  • IPv6
Bandwidth Integer 2

The bandwidth that is allocated to the acceleration region. Unit: Mbit/s.

State String active

The status of the acceleration region. Valid values:

  • init: The acceleration region is being initialized.
  • active: The acceleration region is in the running state.
  • updating: The acceleration region is being configured.
  • Deleting: The acceleration region is being deleted.
IpSetId String ips-bp11r5jb8ogp122xl****

The ID of the acceleration region.

IpAddressList Array of String 121.43..XX.XX

The list of accelerated IP addresses in the acceleration region.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListIpSets
&RegionId=cn-hangzhou
&PageNumber=1
&PageSize=10
&AcceleratorId=ga-bp1yeeq8yfoyszmqy****
&<Common request parameters>

Sample responses

XML format 

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

<ListIpSetsResponse>
    <TotalCount>2</TotalCount>
    <PageSize>10</PageSize>
    <RequestId>A9B4E54C-9CCD-4002-91A9-D38C6C209192</RequestId>
    <PageNumber>1</PageNumber>
    <IpSets>
        <AccelerateRegionId>cn-hangzhou</AccelerateRegionId>
        <IpVersion>IPv4</IpVersion>
        <Bandwidth>2</Bandwidth>
        <State>active</State>
        <IpSetId>ips-bp11r5jb8ogp122xl****</IpSetId>
        <IpAddressList>121.43..XX.XX</IpAddressList>
    </IpSets>
</ListIpSetsResponse>

JSON format 

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

{
  "TotalCount" : 2,
  "PageSize" : 10,
  "RequestId" : "A9B4E54C-9CCD-4002-91A9-D38C6C209192",
  "PageNumber" : 1,
  "IpSets" : [ {
    "AccelerateRegionId" : "cn-hangzhou",
    "IpVersion" : "IPv4",
    "Bandwidth" : 2,
    "State" : "active",
    "IpSetId" : "ips-bp11r5jb8ogp122xl****",
    "IpAddressList" : [ "121.43..XX.XX" ]
  } ]
}

Error codes

For a list of error codes, visit the API Error Center.