查询所有策略地理位置访问控制 - ListGeoIpPolicyRules
功能介绍
查询所有策略地理位置访问控制
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/waf/rule/geoip
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,对应控制台用户名->我的凭证->项目列表->项目ID。 约束限制: 不涉及 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
policyids |
否 |
String |
参数解释: 策略id列表。策略id从"查询防护策略列表"(ListPolicy)接口获取,多个策略之间用“,”隔开 约束限制: 不涉及 取值范围: 策略id只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及 |
|
enterprise_project_id |
否 |
String |
参数解释: 您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。 约束限制: 不涉及 取值范围:
默认取值: 0 |
|
page |
否 |
Integer |
参数解释: 分页查询的起始位置,表示从第几条记录开始返回(从1开始计数)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 1 |
|
pagesize |
否 |
Integer |
参数解释: 分页查询时,每页包含多少条结果。 约束限制: 不涉及 默认取值: 1000 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
Content-Type |
是 |
String |
参数解释: 内容类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: application/json;charset=utf8 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
该策略下地理位置控制规则数量 |
|
items |
Array of GeOIpItem objects |
地理位置控制规则数组 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
规则id |
|
policyid |
String |
策略id |
|
name |
String |
地理位置控制规则名称 |
|
geoip |
String |
地理位置封禁区域: (CN: 中国,CA: 加拿大,US: 美国,AU: 澳大利亚,IN: 印度,JP: 日本,UK: 英国,FR: 法国,DE: 德国,BR: 巴西,Ukraine: 乌克兰,North Korea: 朝鲜,The Republic of Korea: 韩国,Iran: 伊朗,Cuba: 古巴,Sultan: 苏丹,Syria: 叙利亚,Pakistan: 巴基斯坦,Palestine: 巴勒斯坦,Israel: 以色列,Iraq: 伊拉克,Afghanistan: 阿富汗,Libya: 利比亚,Turkey: 土耳其,Thailand: 泰国,Singapore: 新加坡,South Africa: 南非,Mexico: 墨西哥,Peru: 秘鲁,Indonesia: 印度尼西亚,GD: 广东,FJ: 福建,JL: 吉林,LN: 辽宁,TW: 台湾,GZ: 贵州,AH: 安徽,HL: 黑龙江,HA: 河南,SC: 四川,HE: 河北,YN: 云南,HB: 湖北,HI: 海南,QH: 青海,HN: 湖南,JX: 江西,SX: 山西,SN: 陕西,ZJ: 浙江,GS: 甘肃,JS: 江苏,SD: 山东,BJ: 北京,SH: 上海,TJ: 天津,CQ: 重庆,MO: 澳门,HK: 香港,NX: 宁夏,GX: 广西,XJ: 新疆,XZ: 西藏,NM: 内蒙古) |
|
white |
Integer |
防护动作:
|
|
status |
Integer |
规则状态,0:关闭,1:开启 |
|
timestamp |
Long |
创建规则时间戳 |
状态码: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鉴权错误时才会返回此字段。 |
请求示例
查询所有策略地理位置访问控制
GET https://{endpoint}/v1/{project_id}/waf/rule/geoip?enterprise_project_id=0
响应示例
状态码:200
参数解释:
OK
约束限制:
不涉及
取值范围:
不涉及
默认取值:
不涉及
{
"total" : 5,
"items" : [ {
"id" : "rule-20240601-001",
"policyid" : "policy-geo-007",
"name" : "北京地区IP拦截规则",
"geoip" : "BJ",
"white" : 0,
"status" : 1,
"timestamp" : 1717248000000
} ]
}
SDK代码示例
SDK代码示例如下。
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 |
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 ListGeoIpPolicyRulesSolution { 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(); ListGeoIpPolicyRulesRequest request = new ListGeoIpPolicyRulesRequest(); try { ListGeoIpPolicyRulesResponse response = client.listGeoIpPolicyRules(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()); } } } |
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 |
# 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 = ListGeoIpPolicyRulesRequest() response = client.list_geo_ip_policy_rules(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
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.ListGeoIpPolicyRulesRequest{} response, err := client.ListGeoIpPolicyRules(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
参数解释: OK 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
400 |
参数解释: 请求失败 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
401 |
参数解释: token权限不足 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
500 |
参数解释: 服务器内部错误 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
错误码
请参见错误码。