功能介绍
更新IP地址组。
调用方法
请参见如何调用API。
URI
PUT /v1/ip-groups/{ip_group_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ip_group_id |
是 |
String |
IP地址组ID。 最小长度:1 最大长度:36 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
IP地址组ID。 |
name |
String |
IP地址组名称。 最小长度:1 最大长度:64 |
description |
String |
IP地址组描述。 最小长度:0 最大长度:255 |
status |
String |
配置状态,取值:
枚举值:
|
ip_list |
IP地址组中的IP网段列表。 |
|
associated_listeners |
监听器的访问控制策略。 |
|
created_at |
String |
创建时间。 |
updated_at |
String |
更新时间。 |
请求示例
更新IP地址组的名称和描述信息
PUT https://{ga_endpoint}/v1/ip-groups/e8996cd6-28cf-4ff2-951e-fa8ac895a6cd { "ip_group" : { "name" : "ip-group-name", "description" : "ip-group description" } }
响应示例
状态码: 200
操作成功
{ "request_id" : "ac1bf54f-6a23-4074-af77-800648d25bc8", "ip_group" : { "id" : "e8996cd6-28cf-4ff2-951e-fa8ac895a6cd", "name" : "ip-group-name", "description" : "ip-group description", "status" : "ACTIVE", "ip_list" : [ { "cidr" : "127.0.0.0/24", "description" : "cidr description", "created_at" : "2019-01-08T01:21:37.151Z" } ], "associated_listeners" : [ { "listener_id" : "1b11747a-b139-492f-9692-2df0b1c87193", "type" : "BLACK" } ], "created_at" : "2019-01-08T01:21:37.151Z", "updated_at" : "2019-01-08T01:21:37.151Z" } }
状态码
状态码 |
描述 |
---|---|
200 |
操作成功 |
错误码
请参见错误码。