功能介绍
更新 终端节点 组。
调用方法
请参见如何调用API。
URI
PUT /v1/endpoint-groups/{endpoint_group_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
endpoint_group_id |
是 |
String |
终端节点组ID。 最小长度:1 最大长度:36 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
终端节点组ID。 |
name |
String |
终端节点组名称,取值范围:1~64个字符之间,只能由数字、字母、中划线和中文组成。 最小长度:1 最大长度:64 |
description |
String |
终端节点组描述信息,取值范围:0~255个字符之间,禁止输入字符:<>。 最小长度:0 最大长度:255 |
status |
String |
配置状态,取值:
枚举值:
|
traffic_dial_percentage |
Integer |
流量拨分到此组的百分比。 最小值:0 最大值:100 |
region_id |
String |
终端节点组所属区域ID。 最小长度:1 最大长度:36 |
listeners |
关联监听器列表。 数组长度:1 - 1 |
|
created_at |
String |
创建时间。 |
updated_at |
String |
更新时间。 |
domain_id |
String |
租户ID。 |
frozen_info |
云服务 或资源实例冻结信息。 |
参数 |
参数类型 |
描述 |
---|---|---|
status |
Integer |
云服务或资源实例状态,取值:
最小值:0 最大值:2 |
effect |
Integer |
在冻结/解冻操作下,取值:
最小值:1 最大值:3 缺省值:1 |
scene |
Array of strings |
更新云服务状态的业务场景列表,取值:
最大长度:16 |
请求示例
更新终端节点组,修改流量调度占比为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"
}
状态码
状态码 |
描述 |
---|---|
200 |
操作成功 |
错误码
请参见错误码。