UpdateEndpointGroup_全球加速_API文档

2019-11-20

获取元数据获取 SDK

找不到 API ? 点击反馈吧

插件下载了解更多

VS Code 插件反馈

安装插件之前，确保已安装 VS Code

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.

JetBrains 插件反馈

安装插件之前，确保已安装 JetBrains IDE

Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI

The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

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

流控信息

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

授权信息

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

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

ga:UpdateEndpointGroup	Update	EndpointGroup acs:ga:{#regionId}:{#accountId}:endpointgroup/{#endpointGroupId}	无	无

请求参数

字段名称	字段详情
RegionIdstring	全球加速实例所在的地域 ID，仅取值cn-hangzhou。示例值:cn-hangzhou
ClientTokenstring	客户端 Token，用于保证请求的幂等性。展开详情示例值:123e4567-e89b-12d3-a456-426655440000
EndpointGroupIdstring	终端节点组 ID。示例值:epg-bp1dmlohjjz4kqaun****参考取值来源: UpdateEndpointGroups ListEndpointGroups CreateEndpointGroup GetBasicEndpoint DescribeCustomRoutingEndpoint
Namestring	终端节点组的名称。展开详情示例值:group1
Descriptionstring	终端节点组描述信息。展开详情示例值:EndpointGroup
EndpointGroupRegionstring	终端节点组所属的地域 ID。示例值:cn-hangzhou参考取值来源: ListEndpointGroups DescribeEndpointGroup GetBasicEndpointGroup CreateEndpointGroup
TrafficPercentageinteger<int32>	监听有多个终端节点组时的权重。示例值:20
HealthCheckIntervalSecondsinteger<int32>	健康检查的时间间隔。单位：秒。取值范围：1-50。示例值:3
HealthCheckPathstring	健康检查路径。示例值:/healthcheck
HealthCheckPortinteger<int32>	健康检查的端口。取值范围：1~65535。示例值:20
HealthCheckProtocolstring	健康检查的协议。取值：展开详情示例值:HTTPS
ThresholdCountinteger<int32>	针对健康检查状态变化所需要的连续健康检查次数，即从成功到失败的连续健康检查失败次数或从失败到成功的连续健康检查成功次数。展开详情示例值:3
EndpointConfigurationsarray<object>	终端节点配置信息。
EndpointRequestProtocolstring	后端服务协议。取值：展开详情示例值:HTTP参考取值来源: DescribeEndpointGroup ListEndpointGroups
EndpointProtocolVersionstring	后端服务协议版本。取值：展开详情示例值:HTTP1.1参考取值来源: DescribeEndpointGroup ListEndpointGroups
PortOverridesarray<object>	端口映射关系。子级条数 <= 200
HealthCheckEnabledboolean	是否开启健康检查。取值：展开详情示例值:true

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:6FEA0CF3-D3B9-43E5-A304-D217037876A8

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

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.	诊断
400	NoPermission.VpcEndpoint	You are not authorized to perform the operation.	诊断
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-12-23	变更请求参数EndpointConfigurations 变更请求参数PortOverrides
	2024-07-19	新增请求参数EndpointProtocolVersion
	2023-11-22	变更请求参数EndpointConfigurations
	2023-09-14	变更请求参数EndpointConfigurations
	2023-06-20	变更请求参数EndpointConfigurations

相关示例

创建删除更新终端节点组

创建删除更新终端节点组

2022-12-26