查询地理位置访问控制规则列表
功能介绍
查询地理位置访问控制规则列表
URI
GET /v1/{project_id}/waf/policy/{policy_id}/geoip
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，对应控制台用户名->我的凭证->项目列表->项目ID |
|
policy_id |
是 |
String |
防护策略id，您可以通过调用查询防护策略列表（ListPolicy）获取策略id |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
您可以通过调用企业项目管理服务（EPS）的查询企业项目列表接口（ListEnterpriseProject）查询企业项目id |
|
page |
否 |
Integer |
分页查询时，返回第几页数据。默认值为1，表示返回第1页数据。 缺省值：1 |
|
pagesize |
否 |
Integer |
分页查询时，每页包含多少条结果。默认值为10，表示每页包含10条结果。 缺省值：10 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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： 巴西,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 |
错误信息 |
状态码： 401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误信息 |
请求示例
GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip?enterprise_project_id=0
响应示例
状态码： 200
OK
{
"total" : 1,
"items" : [ {
"id" : "06f07f6c229141b9a4a78614751bb687",
"policyid" : "2abeeecefb9840e6bf05efbd80d0fcd7",
"timestamp" : 1636340038062,
"status" : 1,
"geoip" : "GD",
"white" : 1,
"name" : "demo"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
请求失败 |
|
401 |
token权限不足 |
|
500 |
服务器内部错误 |
错误码
请参见错误码。
