CreateBasicAccelerateIpEndpointRelation - Map accelerated IP to endpoint - Global Accelerator

Operation description

The CreateBasicAccelerateIpEndpointRelation operation is asynchronous. After you call this operation, the system returns a request ID, but the association between the accelerated IP address and the endpoint for the basic Global Accelerator (GA) instance is not immediately created. The creation task is still running in the background. You can call GetBasicAccelerateIp or ListBasicEndpoints to query the status of the accelerated IP address and the endpoint to confirm whether the association is created:
- If the status of the accelerated IP address and the endpoint is binding, the association is being created. In this state, you can only perform query operations.
- If the status of the accelerated IP address and the endpoint is bound, and the association status queried by calling ListBasicAccelerateIpEndpointRelations is active, the association is created.
You cannot concurrently create associations between accelerated IP addresses and endpoints for the same basic Global Accelerator (GA) instance by calling the CreateBasicAccelerateIpEndpointRelation operation.

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

update

*BasicAccelerateIpEndpointRelation

acs:ga:{#regionId}:{#accountId}:ga/{#gaId}

*BasicAccelerateIpEndpointRelation

acs:ga:{#regionId}:{#accountId}:basicgaip/{#basicgaipId}

*BasicAccelerateIpEndpointRelation

acs:ga:{#regionId}:{#accountId}:basicendpoint/{#basicendpointId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the Global Accelerator 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 value, but you must make sure that it is unique among different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request is unique.	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	Yes	The instance ID of the basic Global Accelerator (GA) instance.	ga-bp17frjjh0udz4qz****
EndpointId	string	Yes	The endpoint ID of the basic Global Accelerator (GA) instance. You can call ListBasicEndpoints to query the endpoint ID.	ep-bp14sz7ftcwwjgrdm****
AccelerateIpId	string	Yes	The accelerated IP address ID of the basic Global Accelerator (GA) instance. You can call ListBasicAccelerateIps to query the accelerated IP address ID.	gaip-bp1****

Response elements

Element	Type	Description	Example
	object	The response parameters.
AccelerateIpId	string	The accelerated IP address ID of the basic Global Accelerator (GA) instance.	gaip-bp1****
AcceleratorId	string	The instance ID of the basic Global Accelerator (GA) instance.	ga-bp17frjjh0udz4qz****
EndpointId	string	The endpoint ID of the basic Global Accelerator (GA) instance.	ep-bp14sz7ftcwwjgrdm****
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
State	string	The association status between the accelerated IP address and the endpoint of the basic Global Accelerator (GA) instance. Note This parameter is currently not used.	null

Examples

Success response

JSON format

{
  "AccelerateIpId": "gaip-bp1****",
  "AcceleratorId": "ga-bp17frjjh0udz4qz****",
  "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "State": "null"
}

Error codes

HTTP status code	Error code	Error message	Description
400	EcsCannotBind.BasicEndpoint	The ECS instance has already been associated with another EIP.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.