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

参数解释:

功能介绍

参数解释:

批量修改地理位置访问控制规则

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/waf/rule/geoip/batch-update

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

project_id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

auth token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

Content-Type

String

参数解释:

内容类型

约束限制:

不涉及

取值范围:

不涉及

默认取值:

application/json;charset=utf8

表3 请求Body参数

参数

是否必选

参数类型

描述

policy_rule_ids

Object

参数解释:

策略和规则id数组,关联防护策略与对应的规则集合

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

status

Integer

参数解释:

规则状态,控制地理位置访问控制规则的启用/禁用(如1表示启用,0表示禁用)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

name

String

参数解释:

规则名称,标识地理位置访问控制规则的名称

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

geoip

String

参数解释:

地理位置,指定需要控制的地域(如省份、城市编码,多个用|分隔)

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

white

Integer

参数解释:

放行或者拦截,1表示放行指定地理位置,2表示拦截指定地理位置

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表4 policy_rule_ids

参数

是否必选

参数类型

描述

policy_id

String

参数解释:

策略id,唯一标识一条防护策略

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

rule_ids

AnyType

参数解释:

规则id数组,包含当前防护策略下的多条规则ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

policy_rule_ids

Object

参数解释:

策略和规则id数组,返回防护策略与对应规则的ID关联关系

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表6 policy_rule_ids

参数

参数类型

描述

policy_id

String

参数解释:

策略id,唯一标识一条防护策略

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

rule_ids

AnyType

参数解释:

规则id数组,返回当前防护策略下的多条规则ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表8 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表10 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

状态码:500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

encoded_authorization_message

String

编码 (加密) 后的详细拒绝原因,用户可以自行调用 STS 服务的decode-authorization-message接口进行解码,可参考STS5联调自验证。IAM5鉴权错误时才会返回此字段。

details

Array of IAM5ErrorDetails objects

调用下游服务的报错信息集合,IAM5鉴权错误时才会返回此字段。

表12 IAM5ErrorDetails

参数

参数类型

描述

error_code

String

下游服务错误码

error_msg

String

下游服务报错信息

请求示例

响应示例

状态码

状态码

描述

200

参数解释:

OK

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

400

参数解释:

请求失败

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

401

参数解释:

token权限不足

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

500

参数解释:

服务器内部错误

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

错误码

请参见错误码

相关文档