CreateBasicAccelerateIpEndpointRelation - Map accelerated IP to endpoint - Global Accelerator

Operation description

CreateBasicAccelerateIpEndpointRelation is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. Call GetBasicAccelerateIp or ListBasicEndpoints to check the association status between the accelerated IP address and endpoint.
- If the accelerated IP address and endpoint are in the binding state, the association is in progress. You can query them but cannot perform other operations.
- If the accelerated IP address and endpoint are in the bound state and ListBasicAccelerateIpEndpointRelations returns active, the association is complete.
You cannot call CreateBasicAccelerateIpEndpointRelation repeatedly for the same basic GA instance within a short period of time.

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 GA instance. Set this to cn-hangzhou.	cn-hangzhou
ClientToken	string	No	The client token used to ensure idempotence. Generate a unique ASCII token per request. Note If not specified, the system uses the request ID as the client token. The request ID may differ for each request.	123e4567-e89b-12d3-a456-426655440000
AcceleratorId	string	Yes	The ID of the basic GA instance.	ga-bp17frjjh0udz4qz****
EndpointId	string	Yes	The endpoint ID. Call ListBasicEndpoints to obtain this value.	ep-bp14sz7ftcwwjgrdm****
AccelerateIpId	string	Yes	The accelerated IP address ID. Call ListBasicAccelerateIps to obtain this value.	gaip-bp1****

Response elements

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

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "AcceleratorId": "ga-bp17frjjh0udz4qz****",
  "EndpointId": "ep-bp14sz7ftcwwjgrdm****",
  "AccelerateIpId": "gaip-bp1****",
  "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.