查询策略列表
更新时间 2026-11-09 15:17:47
最近更新时间: 2026-11-09 15:17:47
接口功能介绍
翼甲-查询策略列表
接口约束
无
URI
GET /echa/v3/firewall/policy/list
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| pageNum | 否 | Integer | 页码，至少1，默认1 | 1 | |
| pageSize | 否 | Integer | 每页数量，最大100，默认10 | 10 | |
| search | 否 | String | 搜索关键字 | ||
| ids | 否 | String | 策略ID列表，可通过本接口查询后获取，用于按ID过滤。多个ID使用逗号分隔。 |
请求参数
请求头header参数 无
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 | 800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回数据对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Long | 总记录数 | ||
| pageNum | Integer | 页码 | ||
| pageSize | Integer | 每页数量 | ||
| list | Array of Objects | 策略列表 | list |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | Integer | 策略ID，可用于ACL规则、资源组、策略分配等接口 | ||
| type | String | 策略类型，network网络策略 | ||
| name | String | 策略名称 | ||
| description | String | 策略描述 | ||
| status | String | 启用状态，enabled启用，disabled停用 | ||
| version | Long | 策略版本号 | ||
| allocate | Array of Integers | 已分配的防火墙分组ID列表 | ||
| groupInfo | Array of Objects | 已分配的防火墙分组信息列表 | groupInfo | |
| operator | String | 操作人 | ||
| updatedAt | String | 更新时间，格式：2026-01-01 12:00:00 | ||
| createdAt | String | 创建时间，格式：2026-01-01 12:00:00 |
表 groupInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | Integer | 分组ID | ||
| name | String | 分组名称 |
枚举参数
无
请求示例
请求url
https://{host}?regionId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&pageNum=1&pageSize=10&search=xxx&ids=xxx
请求头header
无
请求体body
无
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"total":1,
"pageNum":1,
"pageSize":10,
"list":[{
"id":1,
"type":"network",
"name":"默认策略",
"description":"办公区默认策略",
"status":"enabled",
"version":3,
"allocate":[1],
"groupInfo":[{
"id":1,
"name":"办公区分组"
}],
"operator":"admin",
"updatedAt":"2026-01-01 12:00:00",
"createdAt":"2025-12-01 12:00:00"
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
