Creates mappings between accelerated IP addresses and endpoints for a basic Global Accelerator (GA) instance.

Usage notes

  • CreateBasicAccelerateIpEndpointRelations 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 accelerated IP addresses or endpoints. You can check whether the mappings between the accelerated IP addresses and endpoints are created based on the returned status:
    • If the accelerated IP addresses and endpoints are in the binding state, the mappings are being created. In this case, you can perform only query operations.
    • If all accelerated IP addresses and endpoints are in the bound state and the mappings returned by the ListBasicAccelerateIpEndpointRelations API operation are in the active state, the mappings are created.
  • The CreateBasicAccelerateIpEndpointRelations 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 automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateBasicAccelerateIpEndpointRelations

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

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 make sure that it is unique among different 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.

AccelerateIpEndpointRelations.N.AccelerateIpId String No gaip-bp1****

The ID of the accelerated IP address.

You can specify up to 20 IDs.

AccelerateIpEndpointRelations.N.EndpointId String No ep-bp14sz7ftcwwjgrdm****

The ID of the endpoint.

You can specify up to 20 IDs.

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.

Examples

Sample requests

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

Sample success responses

XML format 

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

<CreateBasicAccelerateIpEndpointRelationsResponse>
    <RequestId>04F0F334-1335-436C-A1D7-6C044FE73368</RequestId>
    <AcceleratorId>ga-bp17frjjh0udz4qz****</AcceleratorId>
</CreateBasicAccelerateIpEndpointRelationsResponse>

JSON format 

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

{
  "RequestId" : "04F0F334-1335-436C-A1D7-6C044FE73368",
  "AcceleratorId" : "ga-bp17frjjh0udz4qz****"
}

Error codes

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