文档

CreateEndpointGroups - 创建终端节点组列表

更新时间:

调用CreateEndpointGroups接口批量创建终端节点组。

接口说明

  • 本接口用于批量创建终端节点组,但不支持同时创建默认终端节点组与虚拟终端节点组。

  • 本接口不支持为四层协议监听创建虚拟终端节点组。如需为四层协议监听创建虚拟终端节点组,请使用 CreateEndpointGroup

  • CreateEndpointGroups 接口属于异步接口,即系统会先返回一个请求 ID,但终端节点组并未批量创建完成,系统后台的创建任务仍在进行。您可以调用 DescribeEndpointGroupListEndpointGroups 查询终端节点组的状态:

    • 当存在终端节点组处于 init 状态时,表示终端节点组正在批量创建中,在该状态下,您只能执行查询操作,不能执行其他操作。

    • 当所有终端节点组处于 active 状态时,表示终端节点组批量创建完成。

  • CreateEndpointGroups 接口不支持在同一个全球加速实例内并发创建终端节点组。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ga:CreateEndpointGroupsWrite
  • EndpointGroup
    acs:ga:{#regionId}:{#accountId}:endpointgroup/*
  • Accelerator
    acs:ga:{#regionId}:{#accountId}:ga/{#acceleratorId}
  • Listener
    acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}
  • ga:AcceleratorMainland

请求参数

名称类型必填描述示例值
RegionIdstring

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

cn-hangzhou
ClientTokenstring

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

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
1F4B6A4A-C89E-489E-BAF1-52777EE148EF
DryRunboolean

是否只预检此次请求,取值:

  • true:发送检查请求,不会创建资源。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation

  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。

true
AcceleratorIdstring

全球加速实例 ID。

ga-bp1odcab8tmno0hdq****
ListenerIdstring

监听 ID。

说明 当该监听协议为 HTTPHTTPS 时,调用 CreateEndpointGroups 接口每次仅支持创建一个终端节点组。
lsr-bp1bpn0kn908w4nbw****
EndpointGroupConfigurationsobject []

终端节点组配置信息。

EndpointGroupNamestring

终端节点组名称。

名称长度为 1~128 个字符,以大小写字母或中文开头,可包含数字、半角句号(.)下划线(_)和短划线(-)。

您最多可以输入 10 个终端节点组名称。

group1
EndpointGroupDescriptionstring

终端节点组的描述信息。

描述长度最大 200 字符,不能以http://https://开头。

您最多可以输入 10 个终端节点组的描述信息。

group1
EndpointGroupRegionstring

终端节点组所属地域 ID。

您最多可以输入 10 个终端节点组的地域 ID。

cn-hangzhou
TrafficPercentagelong

流量调配值,即监听有多个终端节点组时,配置到不同终端节点组的流量比例。

取值范围:1~100。默认值:100

您最多可以输入 10 个终端节点组的流量调配值。

100
HealthCheckEnabledboolean

是否开启健康检查。取值:

  • true:开启健康检查。
  • false(默认值):关闭健康检查。

您最多可以开启 10 个终端节点组的健康检查。

false
HealthCheckIntervalSecondslong

健康检查的时间间隔,单位:秒。

您最多可以输入 10 个健康检查的时间间隔。

3
HealthCheckPathstring

健康检查路径。

您最多可以输入 10 个健康检查路径。

/healthcheck
HealthCheckPortlong

健康检查的端口。取值范围:1~65535

您最多可以输入 10 个健康检查的端口。

20
HealthCheckProtocolstring

健康检查的协议。取值:

  • tcpTCP:TCP 协议。

  • httpHTTP:HTTP 协议。

  • httpsHTTPS:HTTPS 协议。

您最多可以输入 10 个健康检查的协议。

tcp
ThresholdCountlong

针对健康检查状态变化所需要的连续健康检查次数,即从成功到失败的连续健康检查失败次数或从失败到成功的连续健康检查成功次数。 取值范围:2~10。默认值:3

您最多可以输入 10 个健康检查状态变化所需要的连续健康检查次数值。

3
EndpointConfigurationsobject []

终端节点配置信息。

Typestring

终端节点类型,取值:

  • Domain:自定义域名。
  • Ip:自定义 IP。
  • PublicIp:阿里云公网 IP。
  • ECS:阿里云 ECS 实例。
  • SLB:阿里云 SLB 实例。
  • ALB:阿里云 ALB 实例。
  • OSS:阿里云 OSS 实例。
  • ENI:阿里云弹性网卡。
  • NLB:阿里云 NLB 实例。
说明
  • 终端节点类型取值为 ECSENISLBALBNLB 时,如果服务关联角色不存在,系统会自动创建一个名称为 AliyunServiceRoleForGaVpcEndpoint 的服务关联角色。
  • 终端节点类型取值为 ALB 时,如果服务关联角色不存在,系统会自动创建一个名称为 AliyunServiceRoleForGaAlb 的服务关联角色。
  • 终端节点类型取值为 OSS 时,如果服务关联角色不存在,系统会自动创建一个名称为 AliyunServiceRoleForGaOss 的服务关联角色。
  • 终端节点类型取值为 NLB 时,如果服务关联角色不存在,系统会自动创建一个名称为 AliyunServiceRoleForGaNlb 的服务关联角色。
  • 更多信息,请参见服务关联角色

    Ip
    Weightlong

    终端节点的权重。

    取值范围:0~255

    在某个终端节点组中,您最多可以输入 100 个终端节点的权重。

    说明
  • 该参数必填。
  • 如果某个终端节点的权重设置为 0,全球加速将终止向该终端节点分发流量,请您谨慎操作。
  • 20
    Endpointstring

    根据 Type(终端节点类型)输入对应的 IP、域名或实例 ID。

    在某个终端节点组中,您最多可以输入 100 个终端节点的 IP 或域名。

    说明 该参数必填。
    47.0.XX.XX
    SubAddressstring

    弹性网卡的私网 IP 地址。

    说明 当终端节点类型为 ENI 时,可以选择配置该参数,如果不配置默认为 ENI 的主私网 IP 地址。
    172.168.XX.XX
    EndpointRequestProtocolstring

    后端服务协议。取值:

    • HTTP(默认值):HTTP 协议。
    • HTTPS:HTTPS 协议。

    您最多可以输入 10 个后端服务协议。

    说明
  • 仅为 HTTPHTTPS 协议的监听创建终端节点组时才支持配置该项。
  • 对于 HTTP 协议的监听,后端服务协议支持且仅支持 HTTP
  • HTTP
    EndpointGroupTypestring

    终端节点组类型。取值:

    • default(默认值):默认终端节点组。
    • virtual:虚拟终端节点组。

    您最多可以输入 10 个终端节点组类型。

    说明
  • 仅 HTTP 或 HTTPS 协议的监听才支持使用本接口创建虚拟终端节点组。如需为 TCP 或 UDP 协议的监听创建虚拟终端节点组,请使用 CreateEndpointGroup
  • 本接口不支持同时创建默认终端节点组和虚拟终端节点组。
  • default
    PortOverridesobject []

    端口映射关系。

    ListenerPortlong

    配置端口映射时的监听端口。

    您最多可以输入 5 个端口映射中的监听端口。

    说明
  • 仅为 HTTP 或 HTTPS 协议的监听创建终端节点组时才支持创建端口映射关系。
  • 端口映射中的监听端口必须与当前监听的监听端口一致。
  • 443
    EndpointPortlong

    配置端口映射时的终端节点端口。

    您最多可以输入 5 个端口映射中的终端节点端口。

    80
    EnableClientIPPreservationToaboolean

    是否使用 TOA 方式开启保持客户端源 IP 功能,取值:

    • true:开启保持客户端源 IP 功能。

    • false(默认值):不开启保持客户端源 IP 功能。

    您最多可以配置 10 个该功能项。

    false
    EnableClientIPPreservationProxyProtocolboolean

    是否使用 ProxyProtocol 方式保留客户端源 IP。取值:

    • true:使用 ProxyProtocol 方式保留客户端源 IP。

    • false(默认值):不使用 ProxyProtocol 方式保留客户端源 IP。

    您最多可以配置 10 个该功能项。

    false
    Tagobject []

    终端节点组的标签。

    Keystring

    用户标签的 Key。

    您最多可以输入 20 个用户标签。

    tag-key
    Valuestring

    用户标签的 Value。

    您最多可以输入 20 个用户标签。

    tag-value
    SystemTagobject []

    系统标签。

    Keystring

    系统标签的 Key。

    您最多可以输入 20 个系统标签。

    system-tag-key
    Valuestring

    系统标签的 Value。

    您最多可以输入 20 个系统标签。

    system-tag-value
    Scopestring

    系统标签的范围。取值:

    • public(默认值):该标签可见,可用于查询过滤。

    • private:该标签可不可见。

    public

    返回参数

    名称类型描述示例值
    object

    返回信息列表。

    RequestIdstring

    请求 ID。

    6FEA0CF3-D3B9-43E5-A304-D217037876A8
    EndpointGroupIdsarray

    终端节点组 ID 列表。

    string

    终端节点组 ID 列表。

    epg-bp1dmlohjjz4kqaun****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8",
      "EndpointGroupIds": [
        "epg-bp1dmlohjjz4kqaun****"
      ]
    }

    错误码

    HTTP status code错误码错误信息描述
    400Domain.NotFitThe domain is not fit the rule域名未备案
    400Resource.QuotaFullThe resource quota is exceeded.该资源数量已达配额上限
    400NoPermission.EnableHealthCheckYou do not have permission to enable health check.该账号没有启用健康检查的权限。
    400NotSupportHealthCheck.AcceleratorCurrently Accelerator does not support health check.当前加速实例不支持健康检查。
    400EndpointGroupExclusive.ListenerAll endpoint group must under the same listener.所有终端节点组必须在同一个监听下。
    400RegionConflict.EndpointGroupEndpoint group under the same listener must have different region.相同监听下的终端节点组必须配置不同的区域。
    400ListenerProtocolIllegal.EndpointGroupListener protocol is illegal, the https/http listener instance is only allowed to have one default endpoint group.协议类型为https/http的监听只允许配置一个默认终端节点组
    400QuotaExceeded.EndpointGroupThe number of endpoint group exceeds the limit.终端节点组数量超过限制额度。
    400ParamExclusive.EndpointGroupTypeAll endpoint group type group must be consistent.-
    400HealthCheckPath.IllegalHealth check path illegal.健康检查路径非法。
    400NotExist.ListenerThe listener does not exist.监听器不存在
    400NotActive.ListenerThe state of the listener is not active.监听器状态非稳态
    400NotExist.AcceleratorThe accelerated instance does not exist.加速实例不存在。
    400StateError.AcceleratorThe state of the accelerated instance is invalid.加速实例状态非法。
    400NotExist.BusinessRegionThe business region does not exist.业务region并不存在
    400NotExist.BasicBandwidthPackageYou must specify the basic bandwidth package.缺少基础带宽包
    400QuotaExceeded.EndPointThe maximum number of endpoints is exceeded.终端节点达到Quota限制
    400NoPermission.VpcEndpointYou are not authorized to perform the operation.用户没有创建服务关联角色的权限,请联系主账号或权限管理员授权当前用户AliyunGlobalAccelerationFullAccess或者创建服务关联角色的自定义权限。自定义权限策略的相关信息包含以下内容:ServiceName为vpcendpoint.ga.aliyuncs.com,服务关联角色名称为AliyunServiceRoleForGaVpcEndpoint,执行该操作所需的用户权限为ram:CreateServiceLinkedRole。
    400EndPointRequestProtocolIllegal.EndpointGroupendpoint group request protoco is illegal-
    400QuotaExceeded.PortOverrideThe number of port override exceeds the limit.端口转发数量超过限制
    400NotExist.ListenerPortlistener port %s is not exist-
    400MixedVpc.EndPointVPC Endpoint cannot be mixed with other types of Endpoints.不支持将私网终端节点和其他类型的终端节点混合配置。
    400IllegalPublicIp.EndPointThe public IP address configured for the endpoint is invalid. Only an Alibaba Cloud public IP address in the region of the endpoint can be configured.终端节点对应的公网配置不合法,仅允许配置本用户当前终端节点地域的阿里云公网IP。

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

    变更历史

    变更时间变更内容概要操作
    2023-10-27OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    2023-09-14OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    2023-04-20OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    2023-04-13OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
    • 本页导读 (1)
    文档反馈