调用CreateCustomRoutingEndpointGroups批量创建自定义路由类型监听的终端节点组

批量创建自定义路由类型监听的终端节点组。

接口说明

全球加速将根据监听路由类型定义的转发方式将流量分配到终端节点组内的终端节点上。

配置智能路由类型监听后，全球加速实例可以根据延时因素（主要依赖于地理位置和网络链路情况）自动选择就近且健康的终端节点组进行流量转发，最终将客户端的网络访问请求送达至运行状况良好的终端节点。
配置自定义路由类型监听后，全球加速实例能够根据配置的监听端口范围、目标终端节点组协议和端口范围，以及终端节点（交换机 vSwitch）的 IP 地址信息，生成端口映射表，从而确定性地将流量路由到交换机中特定 IP 地址和端口。

本接口用于创建自定义路由类型监听的终端节点组。配置智能路由类型监听的终端节点组的 API，请参见 CreateEndpointGroup 。

在调用本接口时，请注意以下事项：

CreateCustomRoutingEndpointGroups 接口属于异步接口，即系统会先返回一个请求 ID，但自定义路由类型监听的终端节点组并未创建完成，系统后台的创建任务仍在进行。您可以调用 DescribeCustomRoutingEndpointGroup 或 ListCustomRoutingEndpointGroups 查询自定义路由类型监听的终端节点组的状态：
- 当存在终端节点组处于 init 状态时，表示终端节点组正在批量创建中，在该状态下，您只能执行查询操作，不能执行其他操作。
- 当所有终端节点组处于 active 状态时，表示终端节点组批量创建完成。
CreateCustomRoutingEndpointGroups 接口不支持在同一个全球加速实例内并发创建自定义路由类型监听的终端节点组。

前提条件

创建自定义路由类型监听的终端节点组前，请确保您已完成以下操作：

已创建标准型全球加速实例。具体操作，请参见 CreateAccelerator 。
已将带宽包与标准型全球加速实例绑定。具体操作，请参见 BandwidthPackageAddAccelerator 。
您已部署了相关应用，作为全球加速的后端服务接收转发的请求。自定义路由类型监听的后端服务类型仅支持交换机（vSwitch）。
您已经申请了自定义路由类型监听使用权限并创建了自定义路由类型监听。监听支持选择自定义路由类型的功能邀测中，如需使用，请联系阿里云客户经理。创建自定义路由类型监听，请参见 CreateListener 。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
ga:CreateCustomRoutingEndpointGroups	Write	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	全球加速实例所在的地域 ID，仅取值cn-hangzhou。	cn-hangzhou
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	否	是否只预检此次请求。取值： true：发送检查请求，不会创建自定义路由类型终端节点组。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码`DryRunOperation`。 false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接创建自定义路由类型终端节点组。	false
AcceleratorId	string	是	全球加速实例 ID。	ga-bp1odcab8tmno0hdq****
ListenerId	string	是	自定义路由类型监听 ID。	lsr-bp1bpn0kn908w4nbw****
EndpointGroupConfigurations	object []	是	终端节点组信息。您最多可以输入 5 个终端节点组信息。
EndpointGroupRegion	string	是	终端节点组所属地域 ID。您最多可以输入 5 个终端节点组地域 ID。	cn-hangzhou
Name	string	否	终端节点组名称。名称长度为 2~128 个字符，以大小写字母或中文开头，可包含数字、下划线（_）和短划线（-）。最多可以输入 5 个终端节点组名称。	test
Description	string	否	终端节点组的描述信息。描述长度最大 256 字符，不能包含`http://`和`https://`字符。最多可以输入 5 个终端节点组的描述信息。	test
DestinationConfigurations	object []	否	终端节点组的映射信息配置。您需要输入终端节点组后端服务端口范围和协议类型，输入信息与关联的监听端口范围将形成映射关系。每个终端节点组下，最多可输入 20 条映射端口范围和协议类型信息。
Protocols	array	否	终端节点组后端服务的协议类型。每个终端节点组映射端口范围和协议类型信息中，最多可以输入 4 个后端服务协议类型。
	string	否	终端节点组后端服务协议类型。取值： TCP：TCP 协议。 UDP：UDP 协议。 TCP,UDP：TCP 和 UDP 协议。每个终端节点组映射端口范围和协议类型信息中，最多可以输入 4 个后端服务协议类型。	TCP
FromPort	integer	否	终端节点组后端服务起始端口。取值范围：1~65499，且需满足 FromPort≤ToPort，即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。每个终端节点组下，最多可输入 20 条后端服务起始端口信息。	80
ToPort	integer	否	终端节点组后端服务结束端口。取值范围：1~65499，且需满足 FromPort≤ToPort，即终端节点组后端服务起始端口需小于等于终端节点组后端服务结束端口。每个终端节点组下，最多可输入 20 条后端服务结束端口信息。	80
EndpointConfigurations	object []	否	终端节点信息。每个终端节点组下，最多可输入 10 个终端节点信息。
Type	string	否	终端节点后端服务类型。取值： PrivateSubNet（默认值）：私网 CIDR。	PrivateSubNet
Endpoint	string	否	终端节点交换机（vSwitch）实例名称。	vsw-test01
TrafficToEndpointPolicy	string	否	后端服务流量通行策略，取值： AllowAll：允许所有访问流量访问指定后端服务。 DenyAll（默认值）：拒绝所有访问流量访问指定后端服务。 AllowCustom：指定可以接收访问流量的通行目标。您需要指定该通信目标的 IP 地址和端口范围，端口范围输入为空时，表示支持该通行目标的所有端口。	DenyAll
PolicyConfigurations	object []	否	流量通行目标配置。每个终端节点下，最多可输入 20 个通行目标。
Address	string	否	指定可以接受访问流量的通行目标 IP 地址。仅当 TrafficToEndpointPolicy 取值为 AllowCustom 时，该项生效。每个终端节点下，最多可输入 20 个通行目标 IP 地址。	10.0.XX.XX
PortRanges	object []	否	指定可以接受访问流量的通行目标端口范围。该端口范围必须属于终端节点组后端服务端口范围。输入为空时，表示支持该通行目标的所有端口。仅当 TrafficToEndpointPolicy 取值为 AllowCustom 时，该项生效。每个终端节点下，最多可输入 20 个通行目标的端口范围，每个通行目标最多可输入 5 个端口范围。
FromPort	integer	否	指定可以接受访问流量的通行目标的起始端口。该端口取值必须属于终端节点组后端服务端口范围。仅当 TrafficToEndpointPolicy 取值为 AllowCustom 时，该项生效。每个终端节点下，最多可输入 20 个通行目标的端口范围，每个通行目标最多可输入 5 个起始端口。	80
ToPort	integer	否	指定可以接受访问流量的通行目标的结束端口。该端口取值必须属于终端节点组后端服务端口范围。仅当 TrafficToEndpointPolicy 取值为 AllowCustom 时，该项生效。每个终端节点下，最多可输入 20 个通行目标的端口范围，每个通行目标最多可输入 5 个结束端口。	80

返回参数

名称	类型	描述	示例值
	object	返回信息列表。
RequestId	string	请求 ID。	04F0F334-1335-436C-A1D7-6C044FE73368
EndpointGroupIds	array	终端节点组 ID 列表。
	string	终端节点组 ID 列表。	epg-bp1dmlohjjz4kqaua****

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "EndpointGroupIds": [
    "epg-bp1dmlohjjz4kqaua****"
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间

变更内容概要

操作

2023-04-20

API 内部配置变更，不影响调用

看变更集

变更项	变更内容
	API 内部配置变更，不影响调用。