All Products
Search
Document Center

Global Accelerator:GetBasicIpSet

Last Updated:Mar 29, 2024

Queries the information about the acceleration region of a 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.

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:GetBasicIpSetRead
  • BasicIpSet
    acs:ga:{#regionId}:{#accountId}:ipset/{#BasicIpSetId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
ClientTokenstringNo

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 ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
123e4567-e89b-12d3-a456-426655440000
IpSetIdstringYes

The ID of the acceleration region.

You can call the GetBasicAccelerator operation to query the region ID.

ips-bp11r5jb8ogp122xl****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

6D2BFF54-6AF2-4679-88C4-2F2E187F16CB
AccelerateRegionIdstring

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

cn-hangzhou
Bandwidthlong

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

2
IpSetIdstring

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

ips-bp11ilwqjdkjeg9r7****
IpAddressstring

The accelerated IP address.

118.31.XX.XX
AcceleratorIdstring

The ID of the basic GA instance.

ga-bp17frjjh0udz4qz****
IpVersionstring

The Internet protocol version. Only IPv4 may be returned.

IPv4
Statestring

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.
active
IspTypestring

The line type of the elastic IP address (EIP) in the acceleration region. Valid values:

  • BGP (default): BGP (Multi-ISP) lines.
  • BGP_PRO: BGP (Multi-ISP) Pro lines.

Valid values if you are allowed to use single-ISP bandwidth:

  • ChinaTelecom
  • ChinaUnicom
  • ChinaMobile
  • ChinaTelecom_L2
  • ChinaUnicom_L2
  • ChinaMobile_L2
BGP

Examples

Sample success responses

JSONformat

{
  "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",
  "IspType": "BGP"
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history