更新终端节点组 - UpdateEndpointGroup

功能介绍

更新终端节点组。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
ga:endpointgroup:update
Write
endpointgroup *
ga:RegionId
-
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
ga:endpointgroup:update	Write	endpointgroup *	ga:RegionId	-	-

URI

PUT /v1/endpoint-groups/{endpoint_group_id}

表1 路径参数
参数	是否必选	参数类型	描述
endpoint_group_id	是	String	终端节点组ID。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数
参数	是否必选	参数类型	描述
endpoint_group	是	UpdateEndpointGroupOption object	更新终端节点组的详细信息。

表4 UpdateEndpointGroupOption
参数	是否必选	参数类型	描述
name	否	String	终端节点组名称，取值范围：1~64个字符之间，只能由数字、字母、中划线和中文组成。
description	否	String	终端节点组描述信息，取值范围：0~255个字符之间，禁止输入字符：<>。
traffic_dial_percentage	否	Integer	流量拨分到此组的百分比。

响应参数

状态码：200

表5 响应Body参数
参数	参数类型	描述
endpoint_group	EndpointGroupDetail object	终端节点组实例。
request_id	String	请求ID。

表6 EndpointGroupDetail
参数	参数类型	描述
id	String	终端节点组ID。
name	String	终端节点组名称，取值范围：1~64个字符之间，只能由数字、字母、中划线和中文组成。
description	String	终端节点组描述信息，取值范围：0~255个字符之间，禁止输入字符：<>。
status	String	配置状态，取值： ACTIVE：运行中 PENDING：待定 ERROR：错误 DELETING：正在删除
traffic_dial_percentage	Integer	流量拨分到此组的百分比。
region_id	String	终端节点组所属区域ID。
listeners	Array of Id objects	关联监听器列表。
created_at	String	创建时间。
updated_at	String	更新时间。
domain_id	String	租户ID。
frozen_info	FrozenInfo object	云服务或资源实例冻结信息。

表7 Id
参数	参数类型	描述
id	String	关联监听器ID。

表8 FrozenInfo
参数	参数类型	描述
status	Integer	云服务或资源实例状态，取值： 0：解冻/正常（云服务恢复正常）。 1：冻结（资源和数据会保留，但租户无法再正常使用云服务）。 2：删除/终止（资源和数据将清除）。
effect	Integer	在冻结/解冻操作下，取值： 1（默认值）：冻结可释放。 2：冻结不可释放。 3：冻结后不可续费。
scene	Array of strings	更新云服务状态的业务场景列表，取值： ARREAR（默认值）：欠费场景。为正常的运营业务场景，包括包周期资源到期、按需资源扣费失败。 POLICE：公安冻结场景。 ILLEGAL：违规冻结场景。 VERIFY：客户未实名认证冻结场景。 PARTNER：合作伙伴冻结（合作伙伴冻结子客户资源）。

请求示例

更新终端节点组，修改流量调度占比为5%，并更新名称和描述信息。

PUT https://{ga_endpoint}/v1/endpoint-groups/3a9f50bb-f041-4eac-a117-82472d8a0007

{
  "endpoint_group" : {
    "name" : "endpoint-group-name-new",
    "description" : "endpoint-group description new",
    "traffic_dial_percentage" : 5
  }
}

响应示例

状态码：200

操作成功

{
  "endpoint_group" : {
    "id" : "3a9f50bb-f041-4eac-a117-82472d8a0007",
    "name" : "endpoint-group-name-new",
    "description" : "endpoint-group description new",
    "status" : "ACTIVE",
    "traffic_dial_percentage" : 5,
    "region_id" : "ap-southeast-1",
    "listeners" : [ {
      "id" : "1b11747a-b139-492f-9692-2df0b1c87193"
    } ],
    "created_at" : "2019-01-08T01:21:37.151Z",
    "updated_at" : "2019-01-08T01:21:37.151Z",
    "domain_id" : "99a3fff0d03c428eac3678da6a7d0f24",
    "frozen_info" : {
      "status" : 2,
      "effect" : 1,
      "scene" : [ "ARREAR", "POLICE" ]
    }
  },
  "request_id" : "915a14a6-867b-4af7-83d1-70efceb146f9"
}