# DescribePolicys

## 1. 接口描述

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

## 2. 请求参数

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

| 参数名称       | 必选 | 类型                                                                                           | 描述                                       |
| ---------- | -- | -------------------------------------------------------------------------------------------- | ---------------------------------------- |
| policyIds  | 否  | Array of String                                                                              | <p>根据防护策略ID列表进行筛选。</p><p>最大不能超过100个。</p> |
| policyName | 否  | String                                                                                       | <p>根据防护策略名称过滤。</p><p>该字段支持模糊搜索。</p>      |
| pageSize   | 否  | Integer                                                                                      | <p>返回的分页大小。</p><p>默认值：20</p>             |
| pageNum    | 否  | Integer                                                                                      | <p>返回的分页数。</p><p>默认值：1</p>               |
| tagKeys    | 否  | Array of String                                                                              | <p>根据标签键进行搜索。</p><p>最长不得超过20个标签键。</p>    |
| tags       | 否  | Array of [Tag](https://docs.console.zenlayer.com/api-reference/cn/compute/datastructure#tag) | <p>根据标签进行搜索。</p><p>最长不得超过20个标签。</p>      |

## 3. 响应结果

| 参数名称       | 类型                                                                                                         | 描述                                                       |
| ---------- | ---------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| requestId  | String                                                                                                     | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |
| totalCount | Integer                                                                                                    | 符合条件的数据总数。                                               |
| dataSet    | Array of [PolicyInfo](https://docs.console.zenlayer.com/api-reference/cn/compute/datastructure#policyinfo) | 防护策略列表的数据。                                               |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 获取防护策略列表**

```json
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
          }
      ]
  }
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的[开发工具集（SDK）](https://docs.console.zenlayer.com/api-reference/cn/api-introduction/toolkit)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

## 6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](https://docs.console.zenlayer.com/api-reference/cn/api-introduction/instruction/commonerrorcode)

| HTTP状态码 | 错误码 | 说明 |
| ------- | --- | -- |