All Products
Search
Document Center

Global Accelerator:CreateCustomRoutingEndpointGroupDestinations

Last Updated:Jul 31, 2024

Creates mappings for an endpoint group that is associated with a custom routing listener.

Operation description

readAndWrite

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:CreateCustomRoutingEndpointGroupDestinationscreate
  • CustomRoutingEndpointGroupDestination
    acs:ga:{#regionId}:{#accountId}:customroutingendpointgroup/{#customroutingendpointgroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the token, but you must make sure that the token is unique among all requests. The token can contain only ASCII characters.

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
cn-hangzhou
ClientTokenstringNo

Specifies whether to perform only a dry run, without performing the actual request. Valid values:

  • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
  • false: performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.
123e4567-e89b-12d3-a456-426655440000
DryRunbooleanNo

The endpoint group ID.

false
EndpointGroupIdstringYes

The mappings of the endpoint group.

You need to specify the backend service ports and protocols for the endpoint group. The ports are mapped to listener ports.

You can specify up to 20 mappings in each call.

epg-bp14sz7ftcwwjgrdm****
DestinationConfigurationsarray<object>Yes

The mapping configuration of the endpoint group.

You need to specify the backend service ports and protocols for the endpoint group. The ports are mapped to listener ports.

You can specify up to 20 mappings in each call.

objectYes

The backend service protocol of the endpoint group. Valid values:

  • TCP
  • UDP
  • TCP+UDP: the TCP and UDP protocols.

You can specify up to four protocols for each mapping configuration.

ProtocolsarrayYes

The backend service protocol of the endpoint group. Valid values:

  • TCP
  • UDP
  • TCP+UDP: the TCP and UDP protocols.

You can specify up to four backend service protocols for each endpoint group mapping.

stringYes

The first port of the backend service port range.

Valid values: 1 to 65499. The value of FromPort must be smaller than or equal to the value of ToPort.

You can specify up to 20 first ports in each call.

TCP
FromPortintegerYes

The last port of the backend service port range.

Valid values: 1 to 65499. The value of FromPort must be equal to or smaller than the value of ToPort.

You can specify up to 20 last ports in each call.

80
ToPortintegerYes

The response parameters.

80

Response parameters

ParameterTypeDescriptionExample
object

The request ID.

RequestIdstring

The IDs of the endpoint group mappings.

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

The IDs of the endpoint group mappings.

string
dst-abc123****

Examples

Sample success responses

JSONformat

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "DestinationIds": [
    "dst-abc123****"
  ]
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-07-23The Error code has changedView Change Details
2023-04-20The internal configuration of the API is changed, but the call is not affectedView Change Details