CreateCustomRoutingEndpoints_全球加速_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

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

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

前提条件

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

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

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

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

请求参数

字段名称字段详情
RegionIdstring

全球加速实例所在的地域 ID,仅取值cn-hangzhou

示例值:cn-hangzhou
ClientTokenstring

客户端 Token,用于保证请求的幂等性。展开详情

示例值:123e4567-e89b-12d3-a456-426655440000
EndpointGroupIdstring

待创建终端节点的终端节点组 ID。

示例值:epg-bp1bpn0kn908w4nb****参考取值来源:
    UpdateEndpointGroups
    ListEndpointGroups
    CreateEndpointGroup
    GetBasicEndpoint
    DescribeCustomRoutingEndpoint
EndpointConfigurationsarray<object>

终端节点信息。展开详情

子级条数 <= 20

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:04F0F334-1335-436C-A1D7-6C044FE73368
EndpointIdsarray<string>

终端节点 ID 列表。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
NotExist.EndPointGroup
endpoint group %s is not exist诊断
400
StateError.Accelerator
accelerator state %s is illegal诊断
400
StateError.EndPointGroup
endpoint group state %s is illegal诊断

变更历史

变更时间变更内容概要操作
2024-07-23
新增错误码400
2022-08-11
新增OpenAPI,创建自定义路由类型监听的终端节点

相关示例

自定义路由终端节点
2022-12-23