Queries information about the acceleration region of a specified basic Global Accelerator (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 GetBasicIpSet

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

RegionId String Yes cn-hangzhou

The ID of the region where the basic GA instance is deployed. Set the value to cn-hangzhou.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that the value is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId may be different for each API request.
IpSetId String Yes ips-bp11r5jb8ogp122xl****

The ID of the acceleration region of the basic GA instance.

Response parameters

Parameter Type Example Description
RequestId String 6D2BFF54-6AF2-4679-88C4-2F2E187F16CB

The ID of the request.

AccelerateRegionId String cn-hangzhou

The ID of the region where the basic GA instance is deployed.

Bandwidth Integer 2

The bandwidth of the acceleration region of the basic GA instance. Unit: Mbit/s.

IpSetId String ips-bp11ilwqjdkjeg9r7****

The ID of the acceleration region of the basic GA instance.

IpAddress String 118.31.XX.XX

The accelerated IP address.

AcceleratorId String ga-bp17frjjh0udz4qz****

The ID of the basic GA instance.

IpVersion String IPv4

The version of the accelerated IP address. Only IPv4 is returned. This indicates that an IPv4 address is used.

State String active

The status of the acceleration region of the basic GA instance. 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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetBasicIpSet
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&IpSetId=ips-bp11r5jb8ogp122xl****
&Common request parameters

Sample success responses

XML format 

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

<GetBasicIpSetResponse>
    <RequestId>6D2BFF54-6AF2-4679-88C4-2F2E187F16CB</RequestId>
    <AccelerateRegionId>cn-hangzhou</AccelerateRegionId>
    <Bandwidth>2</Bandwidth>
    <IpSetId>ips-bp11ilwqjdkjeg9r7****</IpSetId>
    <IpAddress>118.31.XX.XX</IpAddress>
    <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>
    <IpVersion>IPv4</IpVersion>
    <State>active</State>
</GetBasicIpSetResponse>

JSON format 

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

{
  "RequestId" : "6D2BFF54-6AF2-4679-88C4-2F2E187F16CB",
  "AccelerateRegionId" : "cn-hangzhou",
  "Bandwidth" : 2,
  "IpSetId" : "ips-bp11ilwqjdkjeg9r7****",
  "IpAddress" : "118.31.XX.XX",
  "AcceleratorId" : "ga-bp17frjjh0udz4qz****",
  "IpVersion" : "IPv4",
  "State" : "active"
}

Error codes

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