{"base_path":"/","components":null,"consumes":"","definitions":{"CreateWhiteBlackIpRuleRequestBody":{"description":"创建黑白名单规则body","example":{"addr":"1.1.1.0/16","description":"demo","name":"test","white":0},"properties":{"addr":{"description":"**参数解释:**\nip地址,需要输入标准的ip地址或地址段,例如:42.123.120.66或42.123.120.0/16\n**约束限制:**\n参数“addr”和“ip_group_id”必须存在一个,同时存在时以参数“addr”为准\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"string"},"description":{"description":"黑白名单规则描述","type":"string"},"ip_group_id":{"description":"**参数解释:**\nIp地址组id,可在控制台中对象管理->地址组管理中添加\n**约束限制:**\n参数“addr”和“ip_group_id”必须存在一个,同时存在时以参数“addr”为准\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"string"},"name":{"description":"**参数解释:**\n规则名称\n**约束限制:**\n长度范围:[1, 256]\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","type":"string"},"start":{"description":"规则生效开始时间,生效模式为自定义时,此字段才有效,请输入时间戳","type":"integer"},"terminal":{"description":"规则生效结束时间,生效模式为自定义时,此字段才有效,请输入时间戳","type":"integer"},"time_mode":{"default":"permanent","description":"**参数解释:**\n生效模式\n**约束限制:**\n不涉及\n**取值范围:**\n- permanent 立即生效\n- customize 自定义生效\n**默认取值:**\npermanent","enum":["permanent","customize"],"type":"string"},"white":{"description":"**参数解释:**\n防护动作\n**约束限制:**\n不涉及\n**取值范围:**\n - 0 拦截\n - 1 放行 \n - 2 仅记录\n**默认取值:**\n不涉及","enum":[0,1,2],"type":"integer"}},"required":["name","white"],"type":"object"},"CreateWhiteBlackIpRuleResponseBody":{"properties":{"addr":{"description":"黑白名单ip地址,需要输入标准的ip地址或地址段,例如:42.123.120.66或42.123.120.0/16","type":"string"},"description":{"description":"规则描述","type":"string"},"id":{"description":"规则id","type":"string"},"ip_group":{"$ref":"#/definitions/IpGroup","description":"Ip地址组"},"name":{"description":"黑白名单规则名称","type":"string"},"policyid":{"description":"策略id","type":"string"},"start":{"description":"规则生效开始时间,生效模式为自定义时,此字段才有效","format":"int64","type":"integer"},"status":{"description":"**参数解释:**\n规则状态标识,用于指定规则的启用或关闭状态\n**约束限制:**\n不涉及\n**取值范围:**\n - 0:关闭\n - 1:开启\n**默认取值:**\n不涉及","enum":[0,1],"type":"integer"},"terminal":{"description":"规则生效结束时间,生效模式为自定义时,此字段才有效","format":"int64","type":"integer"},"time_mode":{"description":"生效模式,默认为permanent(立即生效)","type":"string"},"timestamp":{"description":"创建规则的时间戳,13位毫秒时间戳","format":"int64","type":"integer"},"white":{"description":"防护动作:\n - 0 拦截\n - 1 放行\n - 2 仅记录","format":"int32","type":"integer"}},"type":"object"},"IAM5ErrorDetails":{"description":"调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此信息0。","properties":{"error_code":{"description":"下游服务错误码","type":"string"},"error_msg":{"description":"下游服务报错信息","type":"string"}}},"IpGroup":{"properties":{"id":{"description":"Ip地址组id,在新增Ip地址组时系统自动生成的唯一标识","type":"string"},"name":{"description":"Ip地址组名","type":"string"},"size":{"description":"Ip地址组中包含Ip/Ip段的数量","format":"int64","type":"integer"}},"type":"object"},"RestErrorResponse":{"properties":{"details":{"description":"调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。","items":{"$ref":"#/definitions/IAM5ErrorDetails"},"type":"array"},"encoded_authorization_message":{"description":"编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。","type":"string"},"error_code":{"description":"错误码","type":"string"},"error_msg":{"description":"错误信息","type":"string"}},"title":"RestErrorResponse","type":"object"}},"description":null,"group_id":"29975c0bd7ce463ca70ad5c074e3974b","host":"waf.cn-north-4.myhuaweicloud.com","id":"c8d3c8861b3640c0b756fc8904003970","info_version":"v1","method":"post","name":"CreateWhiteblackipRule","parameters":{},"paths":{"/v1/{project_id}/waf/policy/{policy_id}/whiteblackip":{"post":{"description":"创建黑白名单规则","operationId":"CreateWhiteblackipRule","parameters":[{"description":"**参数解释:**\n用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"header","maxLength":4096,"minLength":32,"name":"X-Auth-Token","required":true,"type":"string"},{"default":"application/json;charset=utf8","description":"**参数解释:**\n内容类型\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\napplication/json;charset=utf8","in":"header","name":"Content-Type","required":true,"type":"string"},{"description":"**参数解释:**\n项目ID,对应华为云控制台用户名->我的凭证->项目列表->项目ID\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"path","name":"project_id","required":true,"type":"string"},{"description":"**参数解释:**\n您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目ID。若需要查询当前用户所有企业项目绑定的资源信息,请传参all_granted_eps。\n**约束限制:**\n不涉及\n**取值范围:**\n - 0:代表default企业项目\n - all_granted_eps:代表所有企业项目\n - 其它企业项目ID:长度为36个字符\n**默认取值:**\n0","in":"query","name":"enterprise_project_id","required":false,"type":"string"},{"description":"**参数解释:**\n防护策略id,您可以通过调用查询防护策略列表(ListPolicy)获取策略id\n**约束限制:**\n不涉及\n**取值范围:**\n不涉及\n**默认取值:**\n不涉及","in":"path","name":"policy_id","required":true,"type":"string"},{"description":"请求体","in":"body","name":"CreateWhiteblackipRuleRequestBody","required":true,"schema":{"$ref":"#/definitions/CreateWhiteBlackIpRuleRequestBody"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","examples":{"application/json":{"addr":"x.x.x.x","description":"demo","id":"5d43af25404341058d5ab17b7ba78b56","name":"demo","policyid":"38ff0cb9a10e4d5293c642bc0350fa6d","status":1,"timestamp":1650531872900,"white":0}},"schema":{"$ref":"#/definitions/CreateWhiteBlackIpRuleResponseBody"}},"400":{"description":"请求失败","schema":{"$ref":"#/definitions/RestErrorResponse"}},"401":{"description":"token权限不足","schema":{"$ref":"#/definitions/RestErrorResponse"}},"500":{"description":"服务器内部错误","schema":{"$ref":"#/definitions/RestErrorResponse"}}},"summary":"创建黑白名单规则","tags":["策略规则管理"],"x-hybridcloud":true,"x-is-registered":"Y","x-request-examples-1":{"addr":"x.x.x.x","description":"demo","name":"demo","white":0},"x-request-examples-description-1":"在项目id为project_id,防护策略id为policy_id的防护策略下创建黑白名单规则,规则名称为\"demo\",防护动作为\"拦截\",描述为‘demo”,黑白名单ip地址为“x.x.x.x”。","x-request-examples-text-1":{"addr":"x.x.x.x","description":"demo","name":"demo","white":0},"x-request-examples-url-1":"POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/whiteblackip?enterprise_project_id=0","x-support-sdk":"Y"}}},"product_short":"WAF","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建黑白名单规则","tags":"策略规则管理","uri":null,"version":"2.0"}