All Products
Search
Document Center

Global Accelerator:CreateBasicAccelerateIpEndpointRelation

Last Updated:Jan 10, 2024

Associates the accelerated IP address of a basic Global Accelerator (GA) instance with an endpoint.

Operation description

  • CreateBasicAccelerateIpEndpointRelation is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the GetBasicAccelerateIp or ListBasicEndpoints API operation to query the status of an accelerated IP address or an endpoint to determine the association status between the accelerated IP address and endpoint.

    • If the status of the accelerated IP address and endpoint is binding, the accelerated IP address is being associated with the endpoint. In this case, you can query the accelerated IP address and endpoint but cannot perform other operations.
    • If the status of the accelerated IP address and endpoint is bound and the status returned by the ListBasicAccelerateIpEndpointRelations API operation is active, the accelerated IP address is associated with the endpoint.
  • The CreateBasicAccelerateIpEndpointRelation API operation cannot be repeatedly called for the same basic GA instance within a 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.
OperationAccess levelResource typeCondition keyAssociated operation
ga:CreateBasicAccelerateIpEndpointRelationWrite
  • BasicAccelerateIpEndpointRelation
    acs:ga:{#regionId}:{#accountId}:ga/{#gaId}
  • BasicAccelerateIpEndpointRelation
    acs:ga:{#regionId}:{#accountId}:basicgaip/{#basicgaipId}
  • BasicAccelerateIpEndpointRelation
    acs:ga:{#regionId}:{#accountId}:basicendpoint/{#basicendpointId}
    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 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 set this parameter, ClientToken is set to the value of RequestId. The value of RequestId for each API request may be different.
123e4567-e89b-12d3-a456-426655440000
AcceleratorIdstringYes

The ID of the basic GA instance.

ga-bp17frjjh0udz4qz****
EndpointIdstringYes

The ID of the endpoint that is associated with the basic GA instance.

ep-bp14sz7ftcwwjgrdm****
AccelerateIpIdstringYes

The ID of the accelerated IP address of the basic GA instance.

gaip-bp1****

Response parameters

ParameterTypeDescriptionExample
object

A list of response parameters.

RequestIdstring

The ID of the request.

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

The ID of the basic GA instance.

ga-bp17frjjh0udz4qz****
EndpointIdstring

The ID of the endpoint that is associated with the basic GA instance.

ep-bp14sz7ftcwwjgrdm****
AccelerateIpIdstring

The ID of the accelerated IP address of the basic GA instance.

gaip-bp1****
Statestring

The association status between the accelerated IP address and endpoint.

Note This parameter is not in use and empty.
null

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400EcsCannotBind.BasicEndpointThe ECS instance has already been associated with another EIP.

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

Change history

Change timeSummary of changesOperation
2023-04-13The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Added Error Codes: 400