Call DescribeIpSet to query an acceleration region - Global Accelerator - Alibaba Cloud - Global Accelerator

Returns the configuration of a specified acceleration region, including its accelerated IP addresses.

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:DescribeIpSet

get

*IpSet

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Global Accelerator (GA) instance is deployed. Set the value to cn-hangzhou.	cn-hangzhou
IpSetId	string	Yes	The ID of the acceleration region. You can call the ListIpSets operation to query the IDs of acceleration regions of a specific GA instance.	ips-bp11ilwqjdkjeg9r7****

Response elements

Element	Type	Description	Example
	object	The response parameters.
IpSetId	string	The ID of the acceleration region.	ips-bp11ilwqjdkjeg9r7****
RequestId	string	The ID of the request.	6D2BFF54-6AF2-4679-88C4-2F2E187F16CB
IpVersion	string	The IP version. Valid values: IPv4 IPv6 DUAL_STACK	IPv4
State	string	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 GA instance is being deleted.	active
Bandwidth	integer	The bandwidth that is allocated to the acceleration region. Unit: Mbit/s.	3
IspType	string	The line type of the elastic IP address (EIP) in the acceleration region. Valid values: BGP: BGP (Multi-ISP) lines. This is the default value. BGP_PRO: BGP (Multi-ISP) Pro lines.	BGP
IpAddressList	array	The list of accelerated IP addresses in the acceleration region.
	string	The list of accelerated IP addresses in the acceleration region.	121.43.XX.XX
AccelerateRegionId	string	The ID of the acceleration region.	cn-hangzhou
AcceleratorId	string	The ID of the GA instance.	ga-bp1yeeq8yfoyszmqy****
ServiceId	string	The ID of the service that manages the instance. Note This parameter is returned only if the value of ServiceManaged is true.	ALB
ServiceManaged	boolean	Indicates whether the GA instance is managed. Valid values: true false	true
ServiceManagedInfos	array<object>	The actions that users can perform on the managed instance. Note This parameter is returned only if the value of ServiceManaged is true. Users can perform only specific actions on a managed instance.
	object	A list of action policies that users can execute on this managed instance.
Action	string	The name of the action on the managed instance. Valid values: Create Update Delete Associate UserUnmanaged CreateChild	Update
ChildType	string	The type of the child resource. Valid values: Listener: listener. IpSet: acceleration region. EndpointGroup: endpoint group. ForwardingRule: forwarding rule. Endpoint: endpoint. EndpointGroupDestination: protocol mapping of an endpoint group associated with a custom routing listener. EndpointPolicy: traffic policy of an endpoint associated with a custom routing listener. Note This parameter takes effect only if Action is set to CreateChild.	Listener
IsManaged	boolean	Indicates whether the specified actions are managed. true: The specified actions are managed, and users cannot perform the actions on the managed instance. false: The specified actions are not managed, and users can perform the actions on the managed instance.	false

Examples

Success response

JSON format

{
  "IpSetId": "ips-bp11ilwqjdkjeg9r7****",
  "RequestId": "6D2BFF54-6AF2-4679-88C4-2F2E187F16CB",
  "IpVersion": "IPv4",
  "State": "active",
  "Bandwidth": 3,
  "IspType": "BGP",
  "IpAddressList": [
    "121.43.XX.XX"
  ],
  "AccelerateRegionId": "cn-hangzhou",
  "AcceleratorId": "ga-bp1yeeq8yfoyszmqy****",
  "ServiceId": "ALB",
  "ServiceManaged": true,
  "ServiceManagedInfos": [
    {
      "Action": "Update",
      "ChildType": "Listener",
      "IsManaged": false
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	An error occurred while the request was being processed. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.