# 更新IP地址组的IP列表项 - UpdateIpList #### 功能介绍 添加新的IP地址到IP地址组的IP列表中，或更新已有IP地址的描述。不支持通过该接口删除ip_list中已有的IP地址。 注意： - 0.0.0.0与0.0.0.0/32视为重复，0:0:0:0:0:0:0:1与::1与::1/128视为重复，只会保存其中一个。 - 更新IP地址组中的ip_list会影响所有已关联的监听器，请谨慎操作。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-elb/elb_dy_0000.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-elb/elb_sq_0001.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | elb:ipgroups:update | Write | ipgroup \* | - | elb:ipgroups:put | - | #### URI POST /v3/{project_id}/elb/ipgroups/{ipgroup_id}/iplist/create-or-update 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：项目ID。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-elb/elb_fl_0008.html)。 **约束限制**：不涉及 **取值范围**：长度为32个字符，由小写字母和数字组成。 **默认取值**：不涉及 | | ipgroup_id | 是 | String | **参数解释**：IP地址组ID。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 否 | String | **参数解释**：IAM鉴权Token。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | ipgroup | 否 | [UpdateIpListOption] object | **参数解释**：更新IP地址组IP列表的请求参数。 **约束限制**：不涉及 | 表4UpdateIpListOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**：IP地址组的名称。 **约束限制**：不涉及 **取值范围**：不涉及 **默认取值**：不涉及 | | ip_list | 否 | Array of [UpdateIpGroupIpOption] objects | **参数解释**：IP地址组中包含的IP列表。 只支持添加新的IP地址到IP地址组的IP列表中，或更新已有IP地址的描述。不会删除或修改ip_list中已有的IP地址。 **约束限制**：不涉及 | | description | 否 | String | **参数解释**：备注信息。 **约束限制**：不涉及 **取值范围**：长度为0-255个字符。 **默认取值**：不涉及 | 表5UpdateIpGroupIpOption | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | ip | 是 | String | **参数解释**：IP地址组中的IP信息。 **约束限制**：不涉及 **取值范围**：支持IPv4和IPv6地址类型，格式为IP地址、IP地址段或IP地址范围，IP地址范围格式为ip-ip，例如192.168.1.2-192.168.2.253或者2001:0DB8:02de::0e12-2001:0DB8:02de::0e13，终止IP需要大于起始IP。 **默认取值**：不涉及 | | description | 否 | String | **参数解释**：备注信息。 **约束限制**：不涉及 **取值范围**：长度为0-255个字符。 **默认取值**：不涉及 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ipgroup | [IpGroup] object | **参数解释**：IP地址组信息。 | | request_id | String | **参数解释**：请求ID。 **取值范围**：由数字、小写字母和中划线（-）组成的字符串，自动生成。 | 表7IpGroup | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：IP地址组的ID。 **取值范围**：不涉及 | | name | String | **参数解释**：IP地址组的名称。 **取值范围**：不涉及 | | description | String | **参数解释**：IP地址组的描述信息。 **取值范围**：不涉及 | | ip_list | Array of [IpInfo] objects | **参数解释**：IP地址组中包含的IP地址列表。\[\]表示任意IP。 | | listeners | Array of [ListenerRef] objects | **参数解释**：与IP地址组关联的监听器的ID列表。 | | project_id | String | **参数解释**：IP地址组的项目ID。 **取值范围**：不涉及 | | enterprise_project_id | String | **参数解释**：资源所属的企业项目ID。 **取值范围**： - "0"：表示资源属于default企业项目。 - UUID格式的字符串，表示非默认企业项目。 | | created_at | String | **参数解释**：IP地址组的创建时间。 **取值范围**：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 | | updated_at | String | **参数解释**：IP地址组的更新时间。 **取值范围**：格式：yyyy-MM-dd'T'HH:mm:ss'Z'，UTC时区。 | 表8IpInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ip | String | **参数解释**：IP地址组中的IP地址。 **取值范围**：IP地址段格式为ip-ip，例如192.168.1.2-192.168.2.253或者2001:0DB8:02de::0e12-2001:0DB8:02de::0e13，终止IP需要大于起始IP。 | | description | String | **参数解释**：IP地址组中ip的备注信息。 **取值范围**：长度为0-255个字符。 | 表9ListenerRef | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释**：监听器ID。 **取值范围**：不涉及 | #### 请求示例 更新IP地址组的IP列表 ``` POST https://{ELB_Endpoint}/v3/45977fa2dbd7482098dd68d0d8970117/elb/ipgroups/8722e0e0-9cc9-4490-9660-8c9a5732fbb0/iplist/create-or-update { "ipgroup" : { "name" : "test_ipg", "ip_list" : [ { "ip" : "192.168.1.123", "description" : "test" }, { "ip" : "192.168.1.120", "description" : "test update ip0" } ] } } ``` #### 响应示例 **状态码：200** 操作正常返回。 ``` { "request_id" : "46d0dcbec23987f1429491731dce0feb", "ipgroup" : { "id" : "353d6c3b-aca0-40b7-a059-fad8b20419e7", "name" : "test_ipg", "project_id" : "060576798a80d5762fafc01a9b5eedc7", "description" : "", "ip_list" : [ { "ip" : "192.168.1.120", "description" : "test update ip0" }, { "ip" : "192.168.1.122", "description" : "test update ip2" }, { "ip" : "192.168.1.123", "description" : "test" } ], "listeners" : [ { "id" : "acef0c4d-3bd5-4cd0-8d83-c53e5b1fd652" }, { "id" : "edb23879-5511-4412-8b7b-9574de7a1295" } ], "enterprise_project_id" : "0", "created_at" : "2021-11-29T10:40:30Z", "updated_at" : "2022-12-05T13:14:01Z" } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] 更新IP地址组的IP列表 ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.elb.v3.region.ElbRegion; import com.huaweicloud.sdk.elb.v3.*; import com.huaweicloud.sdk.elb.v3.model.*; import java.util.List; import java.util.ArrayList; public class UpdateIpListSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); ElbClient client = ElbClient.newBuilder() .withCredential(auth) .withRegion(ElbRegion.valueOf("")) .build(); UpdateIpListRequest request = new UpdateIpListRequest(); request.withIpgroupId("{ipgroup_id}"); UpdateIpListRequestBody body = new UpdateIpListRequestBody(); List listIpgroupIpList = new ArrayList<>(); listIpgroupIpList.add( new UpdateIpGroupIpOption() .withIp("192.168.1.123") .withDescription("test") ); listIpgroupIpList.add( new UpdateIpGroupIpOption() .withIp("192.168.1.120") .withDescription("test update ip0") ); UpdateIpListOption ipgroupbody = new UpdateIpListOption(); ipgroupbody.withName("test_ipg") .withIpList(listIpgroupIpList); body.withIpgroup(ipgroupbody); request.withBody(body); try { UpdateIpListResponse response = client.updateIpList(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] 更新IP地址组的IP列表 ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkelb.v3.region.elb_region import ElbRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkelb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = ElbClient.new_builder() \ .with_credentials(credentials) \ .with_region(ElbRegion.value_of("")) \ .build() try: request = UpdateIpListRequest() request.ipgroup_id = "{ipgroup_id}" listIpListIpgroup = [ UpdateIpGroupIpOption( ip="192.168.1.123", description="test" ), UpdateIpGroupIpOption( ip="192.168.1.120", description="test update ip0" ) ] ipgroupbody = UpdateIpListOption( name="test_ipg", ip_list=listIpListIpgroup ) request.body = UpdateIpListRequestBody( ipgroup=ipgroupbody ) response = client.update_ip_list(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] 更新IP地址组的IP列表 ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := elb.ElbClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := elb.NewElbClient(hcClient) request := &model.UpdateIpListRequest{} request.IpgroupId = "{ipgroup_id}" descriptionIpList:= "test" descriptionIpList1:= "test update ip0" var listIpListIpgroup = []model.UpdateIpGroupIpOption{ { Ip: "192.168.1.123", Description: &descriptionIpList, }, { Ip: "192.168.1.120", Description: &descriptionIpList1, }, } nameIpgroup:= "test_ipg" ipgroupbody := &model.UpdateIpListOption{ Name: &nameIpgroup, IpList: &listIpListIpgroup, } request.Body = &model.UpdateIpListRequestBody{ Ipgroup: ipgroupbody, } response, err := client.UpdateIpList(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ELB/sdk?api=UpdateIpList&version=v3)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 操作正常返回。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-elb/ErrorCode.html)。