All Products
Search
Document Center

Global Accelerator:GetBasicAccelerateIp

Last Updated:May 16, 2024

Queries the status of an accelerated IP address 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:GetBasicAccelerateIpRead
  • BasicAccelerateIp
    acs:ga:{#regionId}:{#accountId}:basicgaip/{#basicgaipId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the 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 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
AccelerateIpIdstringYes

The ID of the basic GA instance that you want to query.

You can call the ListBasicAccelerateIps operation to query the ID of the accelerated IP address.

gaip-bp1****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

04F0F334-1335-436C-A1D7-6C044FE73368
AcceleratorIdstring

The ID of the basic GA instance to which the queried accelerated IP address belongs.

ga-bp17frjjh0udz4qz****
IpSetIdstring

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

ips-bp11r5jb8ogp122xl****
AccelerateIpIdstring

The ID of the accelerated IP address.

gaip-bp1****
AccelerateIpAddressstring

The accelerated IP address of the basic GA instance.

116.132.XX.XX
Statestring

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 GA instance is being deleted.
Note If the accelerated IP address is being created, this parameter is not returned.
active

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "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 timeSummary of changesOperation
No change history