DescribeCidrs

1. 接口描述

本接口(DescribeCidrs)用于查询CIDR地址块列表

2. 请求参数

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

参数名称	必选	类型	描述
cidrIds	否	Array of String	一个或多个待操作的Cidr ID，根据cidrId进行过滤。
regionId	否	String	根据CIDR所在的节点ID进行过滤。
name	否	String	根据CIDR名称进行过滤，支持模糊查询。
cidrBlock	否	String	根据CIDR地址进行过滤。
source	否	CidrCreateSource	根据CIDR来源进行过滤。
resourceGroupId	否	String	根据资源组ID进行过滤。
pageSize	否	Integer	返回的分页大小，默认为20，最大为1000。 可选值范围：[1, 1000]。
pageNum	否	Integer	返回的分页数，默认为1。 可选值范围：[1, +)。
tagKeys	否	Array of String	根据标签键进行搜索。 最长不得超过20个标签键。
tags	否	Array of Tag	根据标签进行搜索。 最长不得超过20个标签。

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。 每次请求都会返回。定位问题时需要提供该次请求的 requestId。
totalCount	Integer	符合条件的数据总数。
dataSet	Array of CidrInfo	查询CIDR地址的结果数据。

4. 代码示例

示例

1. 查询CidrBlock为128.0.0.0/24的Cidr列表。

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

Request：
{
  "cidrIds": ["xxx"],
  "regionId": "asia-east-1",
  "cidrBlock": "128.0.0.0/24",
  "pageSize": 10,
  "pageNum": 1
}
Response：
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "totalCount": 10,
    "dataSet": [
      {
        "cidrId": "xxx",
        "regionId": "xxx",
        "name": "xxx",
        "cidrBlock": "128.0.0.0/24",
        "totalCount"：20,
        "usedCount": 1,
        "source": "CONSOLE",
        "eipV4Type": "BGPLine",
        "netmask": 2,
        "poolId": "xxx",
        "createTime": "xxx",
        "expiredTime": "xxx",
        "resourceGroupId": "xxx",
        "resourceGroupName": "xxx",
        "tags":null
      }
    ]
  }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码	错误码	说明