CreateBasicAccelerateIp - Global Accelerator - Alibaba Cloud Documentation Center

Creates an accelerated IP address for a basic Global Accelerator (GA) instance.

Operation description

CreateBasicAccelerateIp is an asynchronous operation. After you send a request, the system returns a request ID, but the operation is still being performed in the system background. You can call the GetBasicAccelerateIp operation to query the status of an accelerated IP address:
- If no status information is returned, the accelerated IP address is being created. In this case, you can perform only query operations.
- If the accelerated IP address is in the active state, the accelerated IP address is created.
The CreateBasicAccelerateIp operation cannot be repeatedly called for the same GA instance within a specific period of time.

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:CreateBasicAccelerateIp	create	BasicAccelerateIp acs:ga:{#regionId}:{#accountId}:ga/{#gaId} BasicAccelerateIp acs:ga:{#regionId}:{#accountId}:ipset/*	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
AcceleratorId	string	Yes	The ID of the basic GA instance.	ga-bp17frjjh0udz4qz****
IpSetId	string	Yes	The ID of the acceleration region. You can call the GetBasicAccelerator operation to query the region ID.	ips-bp11r5jb8ogp122xl****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	04F0F334-1335-436C-A1D7-6C044FE73368
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.	gaip-bp1****
AccelerateIpAddress	string	The accelerated IP address.	116.132.XX.XX
State	string	The status of the accelerated IP address. Note This parameter returns an empty string because the parameter is not in use.	null

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": "null"
}

Error codes

HTTP status code	Error code	Error message	Description
400	NotExist.Accelerator	The accelerated instance does not exist.	The GA instance does not exist.
400	StateError.Accelerator	accelerator state configuring is illegal	The status of the GA instance is invalid.
400	NotExist.IpSet	The IpSet does not exist.	The acceleration region does not exist.
400	NotActive.IpSet	The state of IpSet is not active.	The accelerated IP address is in an unstable state.

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

Change history

Change time	Summary of changes	Operation
2023-04-20	The Error code has changed	View Change Details