Accelerated IP Addresses in Basic GA Instances Overview - Global Accelerator - Alibaba Cloud - Global Accelerator

Queries accelerated IP addresses in the acceleration region of a 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:ListBasicAccelerateIps

list

*BasicAccelerateIp

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the GA instance. Set the value to cn-hangzhou.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. 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 of the basic GA instance. You can call the GetBasicAccelerator operation to query the acceleration region ID.	ips-bp11r5jb8ogp122xl****
AccelerateIpAddress	string	No	The accelerated IP address of the basic GA instance.	116.132.XX.XX
AccelerateIpId	string	No	The ID of the accelerated IP address of the basic GA instance.	gaip-bp1****
NextToken	string	No	The pagination token that determines the start point of the query. Valid values: If this is your first query or no subsequent queries are to be sent, ignore this parameter. If a next query is to be sent, set the value to the NextToken value returned from the previous call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
TotalCount	integer	The total number of entries returned.	1
NextToken	string	The pagination token. Valid values: If NextToken is not returned, no additional results exist. If NextToken was returned in the previous query, specify the value to obtain the next set of results.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	The number of entries per page.	10
AccelerateIps	array<object>	The accelerated IP addresses of the basic GA instance.
	object	The accelerated IP addresses of the basic GA instance.
AcceleratorId	string	The ID of the basic GA instance.	ga-bp17frjjh0udz4qz****
IpSetId	string	The ID of the acceleration region.	ips-bp11r5jb8ogp122xl****
AccelerateIpId	string	The ID of the accelerated IP address of the basic GA instance.	gaip-bp1****
AccelerateIpAddress	string	The accelerated IP address of the basic GA instance.	116.132.XX.XX
State	string	The status of the accelerated IP address. Valid values: active: available. binding: being associated. bound: associated. unbinding: being disassociated. deleting: being deleted. Note This parameter is not returned while the accelerated IP address is being created.	active

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": 1,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 10,
  "AccelerateIps": [
    {
      "AcceleratorId": "ga-bp17frjjh0udz4qz****",
      "IpSetId": "ips-bp11r5jb8ogp122xl****",
      "AccelerateIpId": "gaip-bp1****",
      "AccelerateIpAddress": "116.132.XX.XX",
      "State": "active"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.