调用CreateCustomRoutingEndpointGroupDestinations接口创建自定义路由监听所关联终端节点组的映射信息。
接口说明
全球加速实例能够根据配置的监听端口范围、目标终端节点组的映射信息(协议和端口范围),以及终端节点(交换机 vSwitch)的 IP 地址信息,生成端口映射表,从而确定性地将流量路由到交换机中特定 IP 地址和端口。
本接口用于创建自定义路由监听所关联终端节点组的映射信息。在调用本接口时,请注意以下事项:
- CreateCustomRoutingEndpointGroupDestinations 接口属于异步接口,即系统会先返回一个请求 ID,但终端节点组的映射信息并未创建完成,系统后台的创建任务仍在进行。您可以通过调用 DescribeCustomRoutingEndpointGroup 接口查询终端节点组的状态,来确认终端节点组的映射信息是否创建完成:
当终端节点组处于 updating 状态时,表示终端节点组的映射信息正在创建中,在该状态下,您只能执行查询操作,不能执行其他操作。
当终端节点组处于 active 状态时,表示终端节点组的映射信息创建完成。
CreateCustomRoutingEndpointGroupDestinations 接口不支持在同一个全球加速实例内并发创建自定义路由监听所关联终端节点组的映射信息。
前提条件
创建自定义路由监听所关联终端节点组的映射信息前,请确保您已完成以下操作:
已创建标准型全球加速实例。具体操作,请参见 CreateAccelerator 。
已将带宽包与标准型全球加速实例绑定。具体操作,请参见 BandwidthPackageAddAccelerator 。
您已部署了相关应用,作为全球加速的后端服务接收转发的请求。自定义路由类型监听的后端服务类型仅支持交换机(vSwitch)。
您已经申请了自定义路由类型监听使用权限并创建了自定义路由类型监听。监听支持选择自定义路由类型的功能邀测中,如需使用,请联系阿里云客户经理。创建自定义路由类型监听,请参见 CreateListener 。
您已创建了自定义路由类型监听的终端节点组。具体操作,请参见 CreateCustomRoutingEndpointGroups 。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
ga:CreateCustomRoutingEndpointGroupDestinations |
create |
*CustomRoutingEndpointGroupDestination
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
是 |
全球加速实例所在的地域 ID,仅取值cn-hangzhou。 |
cn-hangzhou |
ClientToken |
string |
否 |
客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。 |
123e4567-e89b-12d3-a456-426655440000 |
DryRun |
boolean |
否 |
是否只预检此次请求。取值:
|
false |
EndpointGroupId |
string |
是 |
终端节点组 ID。 |
epg-bp14sz7ftcwwjgrdm**** |
DestinationConfigurations |
array<object> |
是 |
终端节点组的映射信息配置。 您需要输入终端节点组后端服务端口范围和协议类型,输入信息与关联的监听端口范围将形成映射关系。 单次调用本接口最多可输入 20 个映射端口范围和协议类型信息。 |
|
object |
否 |
终端节点组的映射信息配置。 您需要输入终端节点组后端服务端口范围和协议类型,输入信息与关联的监听端口范围将形成映射关系。 单次调用本接口最多可输入 20 个映射端口范围和协议类型信息。 |
||
Protocols |
array |
是 |
终端节点组后端服务协议类型。取值:
|
|
string |
是 |
终端节点组后端服务协议类型。取值:
|
TCP |
|
FromPort |
integer |
是 |
终端节点组后端服务起始端口。 取值范围:1~65499,且需满足 FromPort≤ToPort,即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。 单次调用本接口最多可输入 20 条后端服务起始端口信息。 |
80 |
ToPort |
integer |
是 |
终端节点组后端服务结束端口。 取值范围:1~65499,且需满足 FromPort≤ToPort,即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。 单次调用本接口最多可输入 20 条后端服务结束端口信息。 |
80 |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
返回信息列表。 |
||
RequestId |
string |
请求 ID。 |
04F0F334-1335-436C-A1D7-6C044FE73368 |
DestinationIds |
array |
终端节点组的映射信息配置 ID 列表。 |
|
string |
终端节点组的映射信息配置 ID 列表。 |
dst-abc123**** |
示例
正常返回示例
JSON
格式
{
"RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
"DestinationIds": [
"dst-abc123****"
]
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | StateError.EndPointGroup | endpoint group state %s is illegal | 终端节点组状态非法 |
400 | NotExist.EndPointGroup | endpoint group %s is not exist | 终端节点组%s不存在 |
400 | StateError.Accelerator | accelerator state %s is illegal | 加速实例状态%s非法 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。