更新时间:2022-09-08 GMT+08:00
分享

创建地理位置控制规则

功能介绍

创建地理位置控制规则

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/waf/policy/{policy_id}/geoip

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID

policy_id

String

防护策略id,您可以通过调用查询防护策略列表(ListPolicy)获取策略id

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

内容类型

缺省值:application/json;charset=utf8

表4 请求Body参数

参数

是否必选

参数类型

描述

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

防护动作:

  • 0 拦截

  • 1 放行

  • 2 仅记录

status

Integer

规则状态,0:关闭,1:开启

description

String

规则描述

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

id

String

规则id

name

String

地理位置控制规则名称

policyid

String

策略id

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

防护动作:

  • 0 拦截

  • 1 放行

  • 2 仅记录

status

Integer

规则状态,0:关闭,1:开启

timestamp

Long

创建规则时间戳

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip?enterprise_project_id=0

{
  "white" : 0,
  "description" : "demo",
  "name" : "demo",
  "geoip" : "SH|Afghanistan"
}

响应示例

状态码: 200

OK

{
  "id" : "02dafa406c4941368a1037b020f15a53",
  "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d",
  "name" : "demo",
  "timestamp" : 1650534513775,
  "description" : "demo",
  "status" : 1,
  "geoip" : "SH|Afghanistan",
  "white" : 0,
  "geoTagList" : [ "SH", "Afghanistan" ]
}

状态码

状态码

描述

200

OK

400

请求失败

401

token权限不足

500

服务器内部错误

错误码

请参见错误码

分享:

    相关文档

    相关产品

close