All Products
Search

This Product

    Global Accelerator:GetBasicIpSet

    Document Center

    Global Accelerator:GetBasicIpSet

    Last Updated:Aug 27, 2026

    Queries acceleration region information for a specified basic Global Accelerator (GA) instance.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    ga:GetBasicIpSet

    get

    *BasicIpSet

    acs:ga:{#regionId}:{#accountId}:ipset/{#BasicIpSetId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

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

    cn-hangzhou
    ClientToken

    string

    No

    The client token that ensures the idempotence of the request.

    You can use the client to generate the token value, but you must ensure 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 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
    IpSetId

    string

    Yes

    The ID of the acceleration region.

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

    ips-bp11r5jb8ogp122xl****

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

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

    string

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

    cn-hangzhou
    Bandwidth

    integer

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

    2
    IpSetId

    string

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

    ips-bp11ilwqjdkjeg9r7****
    IpAddress

    string

    The accelerated IP address.

    118.31.XX.XX
    AcceleratorId

    string

    The ID of the basic GA instance.

    ga-bp17frjjh0udz4qz****
    IpVersion

    string

    The Internet protocol version. Only IPv4 may be returned.

    IPv4
    State

    string

    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 running.

    • updating: The acceleration region is being configured.

    • Deleting: The acceleration region is being deleted.

    active
    IspType

    string

    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

    Success response

    JSON format

    {
  "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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.