首页 全球加速 开发参考 API参考 API目录 终端节点组(智能路由类型监听) UpdateEndpointGroup - 修改终端节点组的业务配置

UpdateEndpointGroup - 修改终端节点组的业务配置

更新时间: 2023-09-15 18:35:17

修改终端节点组配置信息。

接口说明

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

调试

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

调试

授权信息

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

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

请求参数

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

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

cn-hangzhou
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
123e4567-e89b-12d3-a456-426655440000
EndpointGroupIdstring

终端节点组ID。

epg-bp1dmlohjjz4kqaun****
Namestring

终端节点组的名称。

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

group1
Descriptionstring

终端节点组描述信息。

描述长度最大256字符,不能包含http://https://字符。

EndpointGroup
EndpointGroupRegionstring

终端节点组所属的地域ID。

cn-hangzhou
TrafficPercentageinteger

监听有多个终端节点组时的权重。

20
HealthCheckIntervalSecondsinteger

健康检查的时间间隔。单位:秒。取值范围:1-50

3
HealthCheckPathstring

健康检查路径。

/healthcheck
HealthCheckPortinteger

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

20
HealthCheckProtocolstring

健康检查的协议。取值:

  • tcp:TCP协议。

  • http:HTTP协议。

  • https:HTTPS协议。

tcp
ThresholdCountinteger

针对健康检查状态变化所需要的连续健康检查次数,即从成功到失败的连续健康检查失败次数或从失败到成功的连续健康检查成功次数。

取值范围:2~10

3
EndpointConfigurationsobject []

终端节点配置信息。

Typestring

终端节点类型,取值:

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

    Ip
    EnableClientIPPreservationboolean

    是否开启保持客户端源IP功能,取值:

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

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

    false
    Weightinteger

    终端节点的权重。

    取值范围:0~255

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

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

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

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

    Endpointstring

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

    120.XX.XX.21
    SubAddressstring

    弹性网卡的私网IP地址。

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

    后端服务协议。取值:

    • HTTP
    • HTTPS
    说明
  • 仅为HTTP或HTTPS协议的监听实例创建终端节点组时才支持配置该项。
  • 对于HTTP协议的监听实例,后端服务协议支持且仅支持HTTP。
  • HTTP
    PortOverridesobject []

    端口映射关系。

    ListenerPortinteger

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

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

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

    80
    HealthCheckEnabledboolean

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

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

    返回参数

    名称类型描述示例值
    object

    返回信息列表。

    RequestIdstring

    请求ID。

    6FEA0CF3-D3B9-43E5-A304-D217037876A8

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t"
    }

    错误码

    HTTP status code错误码错误信息描述
    400NoPermission.EnableHealthCheckYou do not have permission to enable health check.该账号没有启用健康检查的权限。
    400NotExist.EndPointGroupThe endpoint group does not exist.终端节点组不存在
    400StateError.EndPointGroupThe specified state of endpoint group is invalid.终端节点组状态非法
    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.加速实例状态非法。
    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-

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

    变更历史

    变更时间变更内容概要操作
    2023-09-14OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    2023-06-20OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    阿里云首页 全球加速 相关技术圈