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 the existing IP addresses.
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 |
Specifies the project ID. |
ipgroup_id |
Yes |
String |
Specifies the ID of the IP address group. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
Specifies the token used for IAM authentication. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ipgroup |
No |
UpdateIpListOption object |
Specifies the request parameter for updating the IP addresses of an IP address group. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Specifies the name of the IP address group. |
ip_list |
No |
Array of UpadateIpGroupIpOption objects |
Specifies the IP addresses in the IP address group. |
description |
No |
String |
Specifies supplementary information about the IP address group. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
ip |
Yes |
String |
Specifies the IP addresses in the IP address group. Both IPv4 and IPv6 are supported. If the IP address already exists, you can only update its description. |
description |
No |
String |
Provides remarks about the IP address group. Minimum: 0 Maximum: 255 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
ipgroup |
IpGroup object |
Shows IP address information. |
request_id |
String |
Specifies the request ID. The value is automatically generated. |
Parameter |
Type |
Description |
---|---|---|
created_at |
String |
Specifies the time when the IP address group was created. |
description |
String |
Provides supplementary information about the IP address group. |
id |
String |
Specifies the ID of the IP address group. |
ip_list |
Array of IpInfo objects |
Specifies the IP addresses or CIDR blocks in the IP address group. [] indicates any IP address. Array Length: 0 - 300 |
listeners |
Array of ListenerRef objects |
Lists the IDs of listeners with which the IP address group is associated. |
name |
String |
Specifies the IP address group name. |
project_id |
String |
Specifies the project ID of the IP address group. |
updated_at |
String |
Specifies the time when the IP address group was updated. |
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 |
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"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); ElbClient client = ElbClient.newBuilder() .withCredential(auth) .withRegion(ElbRegion.valueOf("<YOUR REGION>")) .build(); UpdateIpListRequest request = new UpdateIpListRequest(); UpdateIpListRequestBody body = new UpdateIpListRequestBody(); List<UpadateIpGroupIpOption> listIpgroupIpList = new ArrayList<>(); listIpgroupIpList.add( new UpadateIpGroupIpOption() .withIp("192.168.1.123") .withDescription("test") ); listIpgroupIpList.add( new UpadateIpGroupIpOption() .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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = ElbClient.new_builder() \ .with_credentials(credentials) \ .with_region(ElbRegion.value_of("<YOUR REGION>")) \ .build() try: request = UpdateIpListRequest() listIpListIpgroup = [ UpadateIpGroupIpOption( ip="192.168.1.123", description="test" ), UpadateIpGroupIpOption( 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 |
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") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := elb.NewElbClient( elb.ElbClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.UpdateIpListRequest{} descriptionIpList:= "test" descriptionIpList1:= "test update ip0" var listIpListIpgroup = []model.UpadateIpGroupIpOption{ { 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