调用UpdateEndpointGroups批量修改某个监听下的终端节点组

调用UpdateEndpointGroups接口批量修改某个监听下的终端节点组。

接口说明

使用说明

UpdateEndpointGroups 接口属于异步接口，即系统会先返回一个请求 ID，但终端节点组配置信息并未修改完成，系统后台的修改任务仍在进行。您可以调用 DescribeEndpointGroup 或 ListEndpointGroups 查询终端节点组的状态：
- 当终端节点组处于 updating 状态时，表示终端节点组配置信息正在修改中，在该状态下，您只能执行查询操作，不能执行其他操作。
- 当终端节点组处于 active 状态时，表示终端节点组配置信息修改完成。
UpdateEndpointGroups 接口不支持在同一个全球加速实例内并发修改终端节点组配置信息。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ga:UpdateEndpointGroups	update	EndpointGroup acs:ga:{#regionId}:{#accountId}:endpointgroup/{#endpointgroupId}	无	无

请求参数

名称	类型	必填	描述	示例值
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 状态码并直接进行操作。	true
EndpointGroupConfigurations	array<object>	是	终端节点组配置信息。
	object	是	终端节点组配置信息。
EndpointGroupName	string	否	终端节点组的名称。名称长度为 1~128 个字符，以大小写字母或中文开头，可包含数字、半角句号（.）下划线（_）和短划线（-）。	group1
EndpointGroupDescription	string	否	终端节点组描述信息。描述长度最大 200 字符，不能以 http://和 https://开头。	group1
TrafficPercentage	long	否	监听实例有多个终端节点组时，配置到不同终端节点组的流量比例。取值范围：1~100。	20
HealthCheckEnabled	boolean	否	是否开启健康检查。 true：开启健康检查。 false（默认值）：关闭健康检查。	true
HealthCheckIntervalSeconds	long	否	健康检查的时间间隔。单位：秒。取值范围：1-50。	3
HealthCheckPath	string	否	健康检查路径。	/healthcheck
HealthCheckPort	long	否	健康检查的端口。取值范围：1~65535。	20
HealthCheckProtocol	string	否	健康检查的协议。 tcp 或 TCP：TCP 协议。 http 或 HTTP：HTTP 协议。 https 或 HTTPS：HTTPS 协议。	tcp
ThresholdCount	long	否	针对健康检查状态变化所需要的连续健康检查次数，即从成功到失败的连续健康检查失败次数或从失败到成功的连续健康检查成功次数。取值范围：2~10。	3
EndpointConfigurations	array<object>	否	终端节点配置信息。
	object	是	终端节点配置信息。
Type	string	是	终端节点类型。 Domain：自定义域名。 Ip：自定义 IP。 PublicIp：阿里云公网 IP。 ECS：阿里云 ECS 实例。 SLB：阿里云 SLB 实例。 ALB：阿里云 ALB 实例。 OSS：阿里云 OSS 实例。 ENI：阿里云弹性网卡。 NLB：阿里云 NLB 实例。说明终端节点类型取值为 ECS 或 SLB 时，如果服务关联角色不存在，系统会自动创建一个名称为 AliyunServiceRoleForGaVpcEndpoint 的服务关联角色。终端节点类型取值为 ALB 时，如果服务关联角色不存在，系统会自动创建一个名称为 AliyunServiceRoleForGaAlb 的服务关联角色。终端节点类型取值为 OSS 时，如果服务关联角色不存在，系统会自动创建一个名称为 AliyunServiceRoleForGaOss 的服务关联角色。更多信息，请参见服务关联角色。	Ip
Weight	long	是	终端节点的权重。取值范围：0~255。说明如果某个终端节点的权重设置为 0，全球加速将终止向该终端节点分发流量，请您谨慎操作。	20
Endpoint	string	是	根据 Type（终端节点类型）输入对应的 IP、域名或实例 ID。	47.0.XX.XX
SubAddress	string	否	弹性网卡的私网 IP 地址。说明当终端节点类型为 ENI 时，可以选择配置该参数，如果不配置默认为 ENI 的主私网 IP 地址。	172.168.XX.XX
EndpointRequestProtocol	string	否	后端服务协议。取值： HTTP：HTTP 协议。 HTTPS：HTTPS 协议。说明仅为 HTTP 或 HTTPS 协议的监听实例创建终端节点组时才支持配置该项。对于 HTTP 协议的监听实例，后端服务协议支持且仅支持 HTTP。	HTTP
EndpointProtocolVersion	string	否	智能路由类型监听的终端节点后端服务协议版本。取值： HTTP1.1（默认值）：HTTP1.1 版本。 HTTP2：HTTP2 版本。说明仅当 EndpointRequestProtocol（终端节点后端服务协议）值为 HTTPS 时，支持配置终端节点后端服务协议版本。	HTTP1.1
PortOverrides	array<object>	否	端口映射关系。
	object	否	端口映射关系。
ListenerPort	long	否	监听端口。取值范围：1~65499。说明仅为 HTTP 或 HTTPS 协议的监听实例配置终端节点组时才支持配置端口映射关系。端口映射中的监听端口必须与当前监听的端口一致。	443
EndpointPort	long	否	终端节点端口。取值范围：1~65499。	80
EnableClientIPPreservationToa	boolean	否	是否使用 TOA 方式保留客户端源 IP。取值： true：是。 false：否。	false
EnableClientIPPreservationProxyProtocol	boolean	否	是否使用 ProxyProtocol 方式保留客户端源 IP。取值： true：是。 false：否。	false
EndpointGroupId	string	是	终端节点 ID。	ep-bp1d2utp8qqe2a44t****
ListenerId	string	是	监听实例 ID。	lsr-bp1bpn0kn908w4nbw****

返回参数

名称	类型	描述	示例值
	object	返回信息列表。
RequestId	string	请求 ID。	6FEA0CF3-D3B9-43E5-A304-D217037876A8
EndpointGroupIds	array	终端节点组 ID 列表。
	string	终端节点组 ID。	epg-bp1dmlohjjz4kqaun****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	NoPermission.EnableHealthCheck	You do not have permission to enable health check.	该账号没有启用健康检查的权限。
400	NotExist.EndPointGroup	The endpoint group does not exist.	终端节点组不存在
400	StateError.EndPointGroup	The specified state of endpoint group is invalid.	终端节点组状态非法
400	NotExist.Listener	The listener does not exist.	监听器不存在
400	NotActive.Listener	The state of the listener is not active.	监听器状态非稳态
400	NotExist.Accelerator	The accelerated instance does not exist.	加速实例不存在。
400	StateError.Accelerator	The state of the accelerated instance is invalid.	加速实例状态非法。
400	QuotaExceeded.EndPoint	The maximum number of endpoints is exceeded.	终端节点达到Quota限制
400	NoPermission.VpcEndpoint	You are not authorized to perform the operation.	用户没有创建服务关联角色的权限，请联系主账号或权限管理员授权当前用户AliyunGlobalAccelerationFullAccess或者创建服务关联角色的自定义权限。自定义权限策略的相关信息包含以下内容：ServiceName为vpcendpoint.ga.aliyuncs.com，服务关联角色名称为AliyunServiceRoleForGaVpcEndpoint，执行该操作所需的用户权限为ram:CreateServiceLinkedRole。
400	EndPointRequestProtocolIllegal.EndpointGroup	endpoint group request protoco is illegal	-
400	QuotaExceeded.PortOverride	The number of port override exceeds the limit.	端口转发数量超过限制
400	NotExist.ListenerPort	listener port %s is not exist	-

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

变更历史

变更时间	变更内容概要	操作
2024-07-20	OpenAPI 错误码发生变更	查看变更详情
2023-11-22	OpenAPI 错误码发生变更	查看变更详情
2023-09-14	OpenAPI 错误码发生变更	查看变更详情