更新IP地址组
功能介绍
更新IP地址组。若要更新其中的IP地址列表,则只支持全量更新。即IP地址组中的ip_list将被全量覆盖,不在请求参数中的IP地址将被移除。
支持IPv4和IPv6类型地址,可以设置单个IP地址、IP地址段和连续IP地址范围。IP地址范围的格式为ip-ip,例如10.12.3.1-10.12.3.10。
注意:
-
0.0.0.0与0.0.0.0/32视为重复,0:0:0:0:0:0:0:1与::1与::1/128视为重复,只会保存其中一个。
-
更新IP地址组中的ip_list会影响所有已关联的监听器,请谨慎操作。
调用方法
请参见如何调用API。
URI
PUT /v3/{project_id}/elb/ipgroups/{ipgroup_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ipgroup_id |
是 |
String |
参数解释:待更新的IP地址组的ID。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
project_id |
是 |
String |
参数解释:项目ID。获取方式请参见获取项目ID。 约束限制:不涉及 取值范围:长度为32个字符,由小写字母和数字组成。 默认取值:不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释:IAM鉴权Token。 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
ipgroup |
是 |
UpdateIpGroupOption object |
参数解释:更新IP地址组请求参数。 约束限制:不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
description |
否 |
String |
参数解释:IP地址组的描述信息。 约束限制:不涉及 取值范围:长度为0-255个字符。 默认取值:不涉及 |
name |
否 |
String |
参数解释:IP地址组的名称 约束限制:不涉及 取值范围:长度为0-255个字符。 默认取值:不涉及 |
ip_list |
否 |
Array of UpdateIpGroupIpOption objects |
参数解释:IP地址组的IP列表。 注意:只支持全量更新,即IP地址组中的ip_list将被全量覆盖,不在请求参数中的IP地址将被移除。 约束限制:不涉及 取值范围:0-300个列表项。 默认取值:不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
ipgroup |
IpGroup object |
参数解释:IP地址组信息。 |
request_id |
String |
参数解释:请求ID。 取值范围:由数字、小写字母和中划线(-)组成的字符串,自动生成。 |
参数 |
参数类型 |
描述 |
---|---|---|
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。 取值范围:
|
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时区。 |
请求示例
更新IP地址组中的所有IP地址
PUT https://{ELB_Endpoint}/v3/45977fa2dbd7482098dd68d0d8970117/elb/ipgroups/8722e0e0-9cc9-4490-9660-8c9a5732fbb0
{
"ipgroup" : {
"name" : "test_ipg",
"ip_list" : [ {
"ip" : "192.168.1.123"
}, {
"ip" : "192.168.3.0/24",
"description" : "test_ip"
} ]
}
}
响应示例
状态码:200
操作正常返回。
{
"ipgroup" : {
"description" : "",
"id" : "8722e0e0-9cc9-4490-9660-8c9a5732fbb0",
"name" : "test_ipg",
"project_id" : "45977fa2dbd7482098dd68d0d8970117",
"ip_list" : [ {
"ip" : "192.168.1.123",
"description" : ""
}, {
"ip" : "192.168.3.0/24",
"description" : "test_ip"
} ],
"listeners" : [ {
"id" : "88f9c079-29cb-435a-b98f-0c5c0b90c2bd"
}, {
"id" : "2f4c9644-d5d2-4cf8-a3c0-944239a4f58c"
} ],
"created_at" : "2018-01-16T03:19:16",
"updated_at" : "2018-01-16T03:19:16"
}
}
SDK代码示例
SDK代码示例如下。
更新IP地址组中的所有IP地址
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 |
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 UpdateIpGroupSolution {
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();
UpdateIpGroupRequest request = new UpdateIpGroupRequest();
request.withIpgroupId("{ipgroup_id}");
UpdateIpGroupRequestBody body = new UpdateIpGroupRequestBody();
List<UpadateIpGroupIpOption> listIpgroupIpList = new ArrayList<>();
listIpgroupIpList.add(
new UpadateIpGroupIpOption()
.withIp("192.168.1.123")
);
listIpgroupIpList.add(
new UpadateIpGroupIpOption()
.withIp("192.168.3.0/24")
.withDescription("test_ip")
);
UpdateIpGroupOption ipgroupbody = new UpdateIpGroupOption();
ipgroupbody.withName("test_ipg")
.withIpList(listIpgroupIpList);
body.withIpgroup(ipgroupbody);
request.withBody(body);
try {
UpdateIpGroupResponse response = client.updateIpGroup(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());
}
}
}
|
更新IP地址组中的所有IP地址
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 |
# 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 = UpdateIpGroupRequest()
request.ipgroup_id = "{ipgroup_id}"
listIpListIpgroup = [
UpadateIpGroupIpOption(
ip="192.168.1.123"
),
UpadateIpGroupIpOption(
ip="192.168.3.0/24",
description="test_ip"
)
]
ipgroupbody = UpdateIpGroupOption(
name="test_ipg",
ip_list=listIpListIpgroup
)
request.body = UpdateIpGroupRequestBody(
ipgroup=ipgroupbody
)
response = client.update_ip_group(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
更新IP地址组中的所有IP地址
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 |
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.UpdateIpGroupRequest{}
request.IpgroupId = "{ipgroup_id}"
descriptionIpList:= "test_ip"
var listIpListIpgroup = []model.UpadateIpGroupIpOption{
{
Ip: "192.168.1.123",
},
{
Ip: "192.168.3.0/24",
Description: &descriptionIpList,
},
}
nameIpgroup:= "test_ipg"
ipgroupbody := &model.UpdateIpGroupOption{
Name: &nameIpgroup,
IpList: &listIpListIpgroup,
}
request.Body = &model.UpdateIpGroupRequestBody{
Ipgroup: ipgroupbody,
}
response, err := client.UpdateIpGroup(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
更新IP地址组中的所有IP地址
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 |
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 UpdateIpGroupSolution {
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();
UpdateIpGroupRequest request = new UpdateIpGroupRequest();
request.withIpgroupId("{ipgroup_id}");
UpdateIpGroupRequestBody body = new UpdateIpGroupRequestBody();
List<UpadateIpGroupIpOption> listIpgroupIpList = new ArrayList<>();
listIpgroupIpList.add(
new UpadateIpGroupIpOption()
.withIp("192.168.1.123")
);
listIpgroupIpList.add(
new UpadateIpGroupIpOption()
.withIp("192.168.3.0/24")
.withDescription("test_ip")
);
UpdateIpGroupOption ipgroupbody = new UpdateIpGroupOption();
ipgroupbody.withName("test_ipg")
.withIpList(listIpgroupIpList);
body.withIpgroup(ipgroupbody);
request.withBody(body);
try {
UpdateIpGroupResponse response = client.updateIpGroup(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());
}
}
}
|
更新IP地址组中的所有IP地址
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 |
# 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 = UpdateIpGroupRequest()
request.ipgroup_id = "{ipgroup_id}"
listIpListIpgroup = [
UpadateIpGroupIpOption(
ip="192.168.1.123"
),
UpadateIpGroupIpOption(
ip="192.168.3.0/24",
description="test_ip"
)
]
ipgroupbody = UpdateIpGroupOption(
name="test_ipg",
ip_list=listIpListIpgroup
)
request.body = UpdateIpGroupRequestBody(
ipgroup=ipgroupbody
)
response = client.update_ip_group(request)
print(response)
except exceptions.ClientRequestException as e:
print(e.status_code)
print(e.request_id)
print(e.error_code)
print(e.error_msg)
|
更新IP地址组中的所有IP地址
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 |
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.UpdateIpGroupRequest{}
request.IpgroupId = "{ipgroup_id}"
descriptionIpList:= "test_ip"
var listIpListIpgroup = []model.UpadateIpGroupIpOption{
{
Ip: "192.168.1.123",
},
{
Ip: "192.168.3.0/24",
Description: &descriptionIpList,
},
}
nameIpgroup:= "test_ipg"
ipgroupbody := &model.UpdateIpGroupOption{
Name: &nameIpgroup,
IpList: &listIpListIpgroup,
}
request.Body = &model.UpdateIpGroupRequestBody{
Ipgroup: ipgroupbody,
}
response, err := client.UpdateIpGroup(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
操作正常返回。 |
错误码
请参见错误码。