修改ip地址组
功能介绍
修改ip地址组
调用方法
请参见如何调用API。
URI
PUT /v1/{project_id}/waf/ip-group/{id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。 约束限制: 不涉及 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及 |
id |
是 |
String |
参数解释: ip地址组id 约束限制: 不涉及 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
参数解释: 您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。 约束限制: 不涉及 取值范围:
默认取值: 0 |
action |
否 |
String |
参数解释: 增量修改ip地址组时,此为必传字段,传入“add”;删除一个或者多个ip时传入“delete”。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
Content-Type |
是 |
String |
参数解释: 内容类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json;charset=utf8 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
参数解释: 地址组名称 约束限制: 不涉及 取值范围: 只能由中文、字母、数字、下划线、连字符、冒号和英文句号组成,且不能超过128个字符长度。 默认取值: 不涉及 |
ips |
是 |
String |
参数解释: 以逗号分隔的ip或ip段 约束限制: 支持IPV4和IPV6格式 取值范围: 不涉及 默认取值: 不涉及 |
description |
否 |
String |
参数解释: 地址组描述 约束限制: 支持IPV4和IPV6格式 取值范围: 地址组描述内容不能含有字符“<”和“>”且长度不能超过128个字符。 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 地址组id 取值范围: 不涉及 |
name |
String |
参数解释: 地址组名称 取值范围: 不涉及 |
ips |
String |
参数解释: 地址组ip 取值范围: 以逗号分隔的ip或ip段 |
size |
Integer |
参数解释: 地址组长度 取值范围: 不涉及 |
rules |
Array of RuleInfo objects |
ip地址组绑定的规则列表 |
description |
String |
参数解释: 地址组描述 取值范围: 地址组描述内容不能含有字符“<”和“>”且长度不能超过128个字符。 |
参数 |
参数类型 |
描述 |
---|---|---|
rule_id |
String |
参数解释: 规则id 取值范围: 不涉及 |
rule_name |
String |
参数解释: 规则名称 取值范围: 不涉及 |
policy_id |
String |
参数解释: 策略id 取值范围: 不涉及 |
policy_name |
String |
参数解释: 策略名称 取值范围: 不涉及 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
encoded_authorization_message |
String |
编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。 |
details |
Array of IAM5ErrorDetails objects |
调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。 |
请求示例
更新项目id为project_id,地址组id为id的ip地址组。ip地址组的名称为"demo",地址为 "xx.xx.xx.xx",地址组描述为“”。
PUT https://{Endpoint}/v1/{project_id}/waf/ip-group/{id}?enterprise_project_id=0
{
"ips" : "xx.xx.xx.xx",
"name" : "demo",
"description" : ""
}
响应示例
状态码:200
请求成功
{
"description" : "",
"id" : "c36e896b18ee486a81026fce8e69fb1a",
"ips" : "xx.xx.xx.xx",
"name" : "demo",
"size" : 1,
"rules" : [ ]
}
SDK代码示例
SDK代码示例如下。
更新项目id为project_id,地址组id为id的ip地址组。ip地址组的名称为"demo",地址为 "xx.xx.xx.xx",地址组描述为“”。
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 |
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.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;
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);
WafClient client = WafClient.newBuilder()
.withCredential(auth)
.withRegion(WafRegion.valueOf("<YOUR REGION>"))
.build();
UpdateIpGroupRequest request = new UpdateIpGroupRequest();
request.withId("{id}");
UpdateIpGroupRequestBody body = new UpdateIpGroupRequestBody();
body.withDescription("");
body.withIps("xx.xx.xx.xx");
body.withName("demo");
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());
}
}
}
|
更新项目id为project_id,地址组id为id的ip地址组。ip地址组的名称为"demo",地址为 "xx.xx.xx.xx",地址组描述为“”。
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 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.v1 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 = WafClient.new_builder() \
.with_credentials(credentials) \
.with_region(WafRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = UpdateIpGroupRequest()
request.id = "{id}"
request.body = UpdateIpGroupRequestBody(
description="",
ips="xx.xx.xx.xx",
name="demo"
)
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)
|
更新项目id为project_id,地址组id为id的ip地址组。ip地址组的名称为"demo",地址为 "xx.xx.xx.xx",地址组描述为“”。
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 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/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 := waf.NewWafClient(
waf.WafClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.UpdateIpGroupRequest{}
request.Id = "{id}"
descriptionUpdateIpGroupRequestBody:= ""
request.Body = &model.UpdateIpGroupRequestBody{
Description: &descriptionUpdateIpGroupRequestBody,
Ips: "xx.xx.xx.xx",
Name: "demo",
}
response, err := client.UpdateIpGroup(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
更新项目id为project_id,地址组id为id的ip地址组。ip地址组的名称为"demo",地址为 "xx.xx.xx.xx",地址组描述为“”。
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 |
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.waf.v1.region.WafRegion;
import com.huaweicloud.sdk.waf.v1.*;
import com.huaweicloud.sdk.waf.v1.model.*;
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);
WafClient client = WafClient.newBuilder()
.withCredential(auth)
.withRegion(WafRegion.valueOf("<YOUR REGION>"))
.build();
UpdateIpGroupRequest request = new UpdateIpGroupRequest();
request.withId("{id}");
UpdateIpGroupRequestBody body = new UpdateIpGroupRequestBody();
body.withDescription("");
body.withIps("xx.xx.xx.xx");
body.withName("demo");
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());
}
}
}
|
更新项目id为project_id,地址组id为id的ip地址组。ip地址组的名称为"demo",地址为 "xx.xx.xx.xx",地址组描述为“”。
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 |
# coding: utf-8
import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkwaf.v1.region.waf_region import WafRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkwaf.v1 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 = WafClient.new_builder() \
.with_credentials(credentials) \
.with_region(WafRegion.value_of("<YOUR REGION>")) \
.build()
try:
request = UpdateIpGroupRequest()
request.id = "{id}"
request.body = UpdateIpGroupRequestBody(
description="",
ips="xx.xx.xx.xx",
name="demo"
)
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)
|
更新项目id为project_id,地址组id为id的ip地址组。ip地址组的名称为"demo",地址为 "xx.xx.xx.xx",地址组描述为“”。
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 |
package main
import (
"fmt"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
waf "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1"
"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/model"
region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/waf/v1/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 := waf.NewWafClient(
waf.WafClientBuilder().
WithRegion(region.ValueOf("<YOUR REGION>")).
WithCredential(auth).
Build())
request := &model.UpdateIpGroupRequest{}
request.Id = "{id}"
descriptionUpdateIpGroupRequestBody:= ""
request.Body = &model.UpdateIpGroupRequestBody{
Description: &descriptionUpdateIpGroupRequestBody,
Ips: "xx.xx.xx.xx",
Name: "demo",
}
response, err := client.UpdateIpGroup(request)
if err == nil {
fmt.Printf("%+v\n", response)
} else {
fmt.Println(err)
}
}
|
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
请求成功 |
400 |
请求失败 |
401 |
token权限不足 |
500 |
服务器内部错误 |
错误码
请参见错误码。