ListBasicAccelerateIps - Global Accelerator - Alibaba Cloud Documentation Center

Queries the accelerated IP addresses in 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ga:ListBasicAccelerateIps	list	BasicAccelerateIp acs:ga:{#regionId}:{#accountId}:ipset/{#IpSetId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the GA instance is deployed. 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. You can call the GetBasicAccelerator operation to query the ID of the acceleration region.	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 token that determines the start point of the query. Valid values: If this is your first query and no next queries are to be sent, ignore this parameter. If a subsequent query is to be sent, set the parameter to the value of NextToken that is returned from the last call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object	A list of response parameters.
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE73368
TotalCount	integer	The number of entries returned.	1
NextToken	string	The token that determines the start point of the query. Valid values: If NextToken was not returned, it indicates that 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 returned on each 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: The accelerated IP address is available. binding: The accelerated IP address is being associated. bound: The accelerated IP address is associated. unbinding: The accelerated IP address is being disassociated. deleting: The accelerated IP address is being deleted. Note This parameter is unavailable when the accelerated IP address is being created.	active

Examples

Sample success responses

JSONformat

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

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

Change history

Change time	Summary of changes	Operation

No change history