DescribePolicys

1. 接口描述

本接口(DescribePolicys)用于获取防护策略列表

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称	必选	类型	描述
policyIds	否	Array of String	根据防护策略ID列表进行筛选。 最大不能超过100个。
policyName	否	String	根据防护策略名称过滤。 该字段支持模糊搜索。
pageSize	否	Integer	返回的分页大小。 默认值：20。
pageNum	否	Integer	返回的分页数。
tagKeys	否	Array of String	根据标签键进行搜索。 最长不得超过20个标签键。
tags	否	Array of Tag	根据标签进行搜索。 最长不得超过20个标签。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。
totalCount	Integer	符合条件的数据总数。
dataSet	Array of PolicyInfo	防护策略列表的数据。

4. 代码示例

示例

1. 获取防护策略列表

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribePolicys
<Common Request Params>

Request：
{
    "policyIds": ["policyId1","policyId2"],
    "name": "xxxx",
    "pageSize": 10,
    "pageNum": 1
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
    "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
    "totalCount": 1,
    "dataSet": [
        {
            "policyId": "<policyId>",
            "policyName": "policyName",
            "resourceGroupId": "<resourceGroupId>",
            "resourceGroupName": "Default Resource Group",
            "createTime": "2025-05-01T01:01:01Z",
            "tags":null
          }
      ]
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码	错误码	说明