Creates a mapping between an accelerated IP address and an endpoint for a basic Global Accelerator (GA) instance.

Usage notes

  • 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 endpoint. You can check whether the mapping between the accelerated IP address and endpoint is created based on the returned status:
    • If the status of the accelerated IP address and endpoint is binding, the mapping is being created. In this case, you can perform only query operations.
    • If the status of the accelerated IP address and endpoint is bound and the status of the mapping returned by the ListBasicAccelerateIpEndpointRelations API operation is active, the mapping is created.
  • 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateBasicAccelerateIpEndpointRelation

The operation that you want to perform. Set the value to CreateBasicAccelerateIpEndpointRelation.

RegionId String Yes cn-hangzhou

The ID of the region where the GA instance is deployed. Set the value to cn-hangzhou.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

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 ensure that it is unique among all requests. The token can contain only ASCII characters.

Note If you do not specify this parameter, the system uses RequestId as ClientToken. RequestId may be different for each API request.
AcceleratorId String Yes ga-bp17frjjh0udz4qz****

The ID of the basic GA instance.

EndpointId String Yes ep-bp14sz7ftcwwjgrdm****

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

AccelerateIpId String Yes gaip-bp1****

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

Response parameters

Parameter Type Example Description
RequestId String 04F0F334-1335-436C-A1D7-6C044FE73368

The ID of the request.

AcceleratorId String ga-bp17frjjh0udz4qz****

The ID of the basic GA instance.

EndpointId String ep-bp14sz7ftcwwjgrdm****

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

AccelerateIpId String gaip-bp1****

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

State String null

The status of the mapping between the accelerated IP address and endpoint.

Note This parameter returns an empty string because the parameter is not in use.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateBasicAccelerateIpEndpointRelation
&RegionId=cn-hangzhou
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&AcceleratorId=ga-bp17frjjh0udz4qz****
&EndpointId=ep-bp14sz7ftcwwjgrdm****
&AccelerateIpId=gaip-bp1****
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateBasicAccelerateIpEndpointRelationResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>
    <EndpointId>ep-bp14sz7ftcwwjgrdm****</EndpointId>
    <AccelerateIpId>gaip-bp1****</AccelerateIpId>
    <State>null</State>
</CreateBasicAccelerateIpEndpointRelationResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

For a list of error codes, see Service error codes.