Updating IP Addresses in an IP Address Group
Function
This API is used to add IP addresses to an IP address group, or update the descriptions of existing IP addresses. This API cannot be used to delete IP addresses.
Note:
-
0.0.0.0 will be considered the same as 0.0.0.0/32. If you enter both 0.0.0.0 and 0.0.0.0/32, either one will be kept. 0:0:0:0:0:0:0:1 will be considered the same as ::1 and ::1/128. If you enter 0:0:0:0:0:0:0:1, ::1, and ::1/128, only one will be kept.
-
Updating the entries defined by ip_list will affect all associated listeners.
Calling Method
For details, see Calling APIs.
URI
POST /v3/{project_id}/elb/ipgroups/{ipgroup_id}/iplist/create-or-update
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID. Constraints: N/A Range: The value can contain a maximum of 32 characters, including digits and lowercase letters. Default value: N/A |
ipgroup_id |
Yes |
String |
Definition: Specifies the ID of an IP address group. Constraints: N/A Range: N/A Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
Definition: Specifies the token used for IAM authentication. Constraints: N/A Range: N/A Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ipgroup |
No |
UpdateIpListOption object |
Definition: Specifies the request parameters for updating IP entries in an IP address group. Constraints: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Definition: Specifies the name of an IP address group. Constraints: N/A Range: N/A Default value: N/A |
ip_list |
No |
Array of UpdateIpGroupIpOption objects |
Definition: Specifies IP entries in an IP address group. The specified IP entries will be added to the IP address group, or the descriptions of existing IP entries will be updated. But the existing IP entries will not be deleted or modified. Constraints: N/A |
description |
No |
String |
Definition: Specifies remarks about the IP address group. Constraints: N/A Range: 0 to 255 characters. Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ip |
Yes |
String |
Definition: Specifies the IP entries in the IP address group. Constraints: N/A Range: Each entry can be an IP address, IP address range, or CIDR block. Each IP address range must be in the format of ip-ip, for example, 192.168.1.2-192.168.2.253 or 2001:0DB8:02de::0e12-2001:0DB8:02de::0e13. Both IPv4 and IPv6 addresses are supported. Default value: N/A |
description |
No |
String |
Definition: Specifies remarks about the IP address group. Constraints: N/A Range: 0 to 255 characters. Default value: N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
ipgroup |
IpGroup object |
Definition: Specifies the IP address group information. |
request_id |
String |
Definition: Specifies the request ID. Range: The value is automatically generated, and can contain characters including digits, lowercase letters, and hyphens (-). |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Definition: Specifies the ID of an IP address group. Range: N/A |
name |
String |
Definition: Specifies the name of an IP address group. Range: N/A |
description |
String |
Definition: Provides supplementary information about an IP address group. Range: N/A |
ip_list |
Array of IpInfo objects |
Definition: Specifies IP addresses in an IP address group. [] indicates any IP address. |
listeners |
Array of ListenerRef objects |
Definition: Specifies the IDs of listeners with which the IP address group is associated. |
project_id |
String |
Definition: Specifies the project ID of the IP address group. Range: N/A |
enterprise_project_id |
String |
Definition: Specifies the ID of the enterprise project. Range:
|
created_at |
String |
Definition: Specifies the time when the IP address group was created. Range: The value must be a UTC time in the yyyy-MM-dd'T'HH:mm:ss'Z' format. |
updated_at |
String |
Definition: Specifies the time when the IP address group was updated. Range: The value must be a UTC time in the yyyy-MM-dd'T'HH:mm:ss'Z' format. |
Parameter |
Type |
Description |
---|---|---|
ip |
String |
Definition: Specifies the IP entries in the IP address group. Range: Each IP address range must be in the format of ip-ip, for example, 192.168.1.2-192.168.2.253 or 2001:0DB8:02de::0e12-2001:0DB8:02de::0e13. The end IP address must be greater than the start IP address. |
description |
String |
Definition: Provides remarks about the IP address group. Range: 0 to 255 characters. |
Example Requests
Updating IP addresses in an IP address group
PUT 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" } ] } }
Example Responses
Status code: 200
Successful request.
{ "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" } ], "created_at" : "2021-11-29T10:40:30Z", "updated_at" : "2022-12-05T13:14:01Z" } }
SDK Sample Code
The SDK sample code is as follows.
Updating IP addresses in an IP address group
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 |
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("<YOUR REGION>")) .build(); UpdateIpListRequest request = new UpdateIpListRequest(); request.withIpgroupId("{ipgroup_id}"); UpdateIpListRequestBody body = new UpdateIpListRequestBody(); List<UpdateIpGroupIpOption> 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()); } } } |
Updating IP addresses in an IP address group
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# 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("<YOUR REGION>")) \ .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) |
Updating IP addresses in an IP address group
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := elb.NewElbClient( elb.ElbClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) 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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Successful request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot