全部产品
Search
文档中心

全球加速:CreateEndpointGroups - 创建终端节点组列表

更新时间:Apr 22, 2024

调用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****

返回参数

名称类型描述示例值
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。

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

变更历史

变更时间变更内容概要操作
2024-04-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-10-27OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-09-14OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-04-20OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
2023-04-13OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更