CreateCustomRoutingEndpoints - 创建自定义路由类型监听的终端节点 - 全球加速

调用CreateCustomRoutingEndpoints接口创建自定义路由类型监听的终端节点。

接口说明

配置自定义路由类型监听后，全球加速实例能够根据配置的监听端口范围、目标终端节点组协议和端口范围，以及终端节点（交换机 vSwitch）的 IP 地址信息，生成端口映射表，从而确定性地将流量路由到交换机中特定 IP 地址和端口。

本接口用于创建自定义路由类型监听的终端节点。在调用本接口时，请注意以下事项：

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

前提条件

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

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ga:CreateCustomRoutingEndpoints	create	CustomRoutingEndpointGroup acs:ga:{#regionId}:{#accountId}:customroutingendpointgroup/{#customroutingendpointgroupId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	全球加速实例所在的地域 ID，仅取值cn-hangzhou。	cn-hangzhou
ClientToken	string	否	客户端 Token，用于保证请求的幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。说明若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。	123e4567-e89b-12d3-a456-426655440000
EndpointGroupId	string	是	待创建终端节点的终端节点组 ID。	epg-bp1bpn0kn908w4nb****
EndpointConfigurations	array<object>	是	终端节点信息。您最多可输入 20 个终端节点信息。
	object	是	终端节点信息。您最多可输入 20 个终端节点信息。
Type	string	否	终端节点后端服务类型。取值： PrivateSubNet（默认值）：私网 CIDR。	PrivateSubNet
Endpoint	string	否	终端节点交换机（vSwitch）实例 ID。	vsw-test01
TrafficToEndpointPolicy	string	否	后端服务流量通行策略，取值： DenyAll（默认值）：拒绝所有访问流量访问指定后端服务。 AllowAll：允许所有访问流量访问指定后端服务。 AllowCustom：指定可以接收访问流量的通行目标。您需要指定该通信目标的 IP 地址和端口范围，端口范围输入为空时，表示支持该通行目标的所有端口。	DenyAll
PolicyConfigurations	array<object>	否	流量通行目标配置。每个终端节点下，最多可输入 20 个通行目标。
	object	是	流量通行目标配置。每个终端节点下，最多可输入 20 个通行目标。
Address	string	是	指定可以接受访问流量的通行目标 IP 地址。仅当 TrafficToEndpointPolicy 取值为 AllowCustom 时，该项生效。每个终端节点下，最多可输入 20 个通行目标 IP 地址。	10.0.XX.XX
PortRanges	array<object>	否	指定可以接受访问流量的通行目标端口范围。该端口范围必须属于终端节点组后端服务端口范围。输入为空时，表示支持该通行目标的所有端口。仅当 TrafficToEndpointPolicy 取值为 AllowCustom 时，该项生效。每个终端节点下，最多可输入 20 个通行目标的端口范围，每个通行目标最多可输入 20 个端口范围。
	object	否	指定可以接受访问流量的通行目标端口范围。该端口范围必须属于终端节点组后端服务端口范围。输入为空时，表示支持该通行目标的所有端口。仅当 TrafficToEndpointPolicy 取值为 AllowCustom 时，该项生效。每个终端节点下，最多可输入 20 个通行目标的端口范围，每个通行目标最多可输入 20 个端口范围。
FromPort	integer	否	指定可以接受访问流量的通行目标的起始端口。该端口取值必须属于终端节点组后端服务端口范围。仅当 TrafficToEndpointPolicy 取值为 AllowCustom 时，该项生效。每个终端节点下，最多可输入 20 个通行目标的端口范围，每个通行目标最多可输入 20 个起始端口。	80
ToPort	integer	否	指定可以接受访问流量的通行目标的结束端口。该端口取值必须属于终端节点组后端服务端口范围。仅当 TrafficToEndpointPolicy 取值为 AllowCustom 时，该项生效。每个终端节点下，最多可输入 20 个通行目标的端口范围，每个通行目标最多可输入 20 个结束端口。	80

返回参数

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	NotExist.EndPointGroup	endpoint group %s is not exist	终端节点组%s不存在
400	StateError.Accelerator	accelerator state %s is illegal	加速实例状态%s非法
400	StateError.EndPointGroup	endpoint group state %s is illegal	终端节点组状态非法

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

变更历史

变更时间	变更内容概要	操作
2024-07-23	OpenAPI 错误码发生变更	查看变更详情
2023-04-20	API 内部配置变更，不影响调用	查看变更详情