Queries information about an acceleration region.

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 DescribeIpSet

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

RegionId String Yes cn-hangzhou

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

IpSetId String Yes ips-bp11ilwqjdkjeg9r7****

The ID of the acceleration region.

You can call the ListIpSets operation to query IDs of acceleration regions of a specified GA instance.

Response parameters

Parameter Type Example Description
IpSetId String ips-bp11ilwqjdkjeg9r7****

The ID of the acceleration region.

RequestId String 6D2BFF54-6AF2-4679-88C4-2F2E187F16CB

The ID of the request.

IpVersion String IPv4

The version of the accelerated IP address. Valid values:

  • IPv4
  • IPv6
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.
Bandwidth Integer 3

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

IpAddressList Array of String 121.43..XX.XX

The list of accelerated IP addresses in the acceleration region.

AccelerateRegionId String cn-hangzhou

The ID of the region that is accelerated.

AcceleratorId String ga-bp1yeeq8yfoyszmqy****

The ID of the GA instance.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeIpSet
&RegionId=cn-hangzhou
&IpSetId=ips-bp11ilwqjdkjeg9r7****
&Common request parameters

Sample success responses

XML format

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

<DescribeIpSetResponse>
    <IpSetId>ips-bp11ilwqjdkjeg9r7****</IpSetId>
    <RequestId>6D2BFF54-6AF2-4679-88C4-2F2E187F16CB</RequestId>
    <IpVersion>IPv4</IpVersion>
    <State>active</State>
    <Bandwidth>3</Bandwidth>
    <IpAddressList>121.43..XX.XX</IpAddressList>
    <AccelerateRegionId>cn-hangzhou</AccelerateRegionId>
    <AcceleratorId>ga-bp1yeeq8yfoyszmqy****</AcceleratorId>
</DescribeIpSetResponse>

JSON format

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

{
  "IpSetId" : "ips-bp11ilwqjdkjeg9r7****",
  "RequestId" : "6D2BFF54-6AF2-4679-88C4-2F2E187F16CB",
  "IpVersion" : "IPv4",
  "State" : "active",
  "Bandwidth" : 3,
  "IpAddressList" : [ "121.43..XX.XX" ],
  "AccelerateRegionId" : "cn-hangzhou",
  "AcceleratorId" : "ga-bp1yeeq8yfoyszmqy****"
}

Error codes

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