查询内网Zone列表

功能介绍

查询内网Zone的列表。

URI

GET /v2/zones?type={type}&limit={limit}&marker={marker}&offset={offset}&tags={tags}&name={name}&status={status}&enterprise_project_id={id}

请求

• 请求参数

  无

• 请求样例

  查询域名类型为内网，且资源标签键为key1、值为value1的前10个域名。

  GET https://{DNS_Endpoint}/v2/zones?type=private&limit=10&offset=0&tags=key1,value1

响应

• 要素说明

  表2 响应样例的要素说明

  名称	参数类型	说明
  links	Object	指向当前资源或者其他资源的链接。 当查询需要分页时，需要包含一个next链接指向下一页。 详细信息请参见表5。
  zones	Array of object	zone列表对象，详细内容请参见表3。
  metadata	Object	返回满足过滤条件的资源总数，详细内容请参见表4。

  表3 zones参数说明

  名称	参数类型	说明
  id	String	zone的ID，uuid形式的一个资源标识。
  name	String	zone名称。
  description	String	对zone的描述信息。
  email	String	管理该zone的管理员邮箱。
  zone_type	String	zone类型，内网（private）。
  ttl	Integer	该zone下SOA记录中的ttl值。 取值范围：300~2147483647 默认值为300s。
  serial	Integer	该zone下SOA记录中用于标识zone文件变更的序列值，用于主从节点同步。 该参数暂未使用。
  status	String	资源状态。 详细信息请参见资源状态。
  record_num	Integer	该zone下的recordset个数。
  pool_id	String	托管该zone的pool，由系统分配。
  project_id	String	zone所属的项目ID。
  created_at	String	创建时间。 采用UTC时间格式，格式为：YYYY-MM-DDTHH:MM:SSZ
  updated_at	String	更新时间。 采用UTC时间格式，格式为：YYYY-MM-DDTHH:MM:SSZ
  links	Object	指向当前资源或者其他资源的链接。 当查询需要分页时，需要包含一个next链接指向下一页。 详细信息请参见表5。
  masters	Array of strings	主从模式中，从DNS服务器用以获取DNS信息。 目前暂未使用。
  routers	Array of object	与该zone关联的Router(VPC)列表。详细信息请参见表7。
  enterprise_project_id	String	域名关联的企业项目ID，长度不超过36个字符。

  表4 metadata参数说明

  名称	参数类型	说明
  total_count	Integer	满足查询条件的资源总数，不受分页（即limit、offset参数）影响。

  表5 links参数说明

  名称	参数类型	说明
  self	String	当前资源的链接。
  next	String	下一页资源的链接。

  表6 tag对象参数说明

  名称	参数类型	说明
  key	String	键。 最大长度36个unicode字符。 key不能为空。不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能为空格。
  value	String	值。 每个值最大长度43个unicode字符，可以为空字符串。 不能包含“=”、“*”、“<”、“>”、“\”、“,”、“|”和“/”，且首尾字符不能为空格。

  表7 routers对象参数说明

  名称	参数类型	说明
  status	String	资源状态。 详细信息请参见资源状态。
  router_id	String	Router(VPC)所属VPC的ID。
  router_region	String	Router(VPC)所在的region。 如果为空，默认为token中project所在的region。

• 响应样例

  {
      "links": {
          "self": "https://Endpoint/v2/zones?type=private&limit=11",
          "next": "https://Endpoint/v2/zones?type=private&limit=11&marker=ff8080825b8fc86c015b94bc6f8712c3"
      },
      "zones": [
          {
              "id": "ff8080825b8fc86c015b94bc6f8712c3",
              "name": "example.com.",
              "description": "This is an example zone.",
              "email": "xx@example.com",
              "ttl": 300,
              "serial": 0,
              "masters": [],
              "status": "ACTIVE",
              "links": {
                  "self": "https://Endpoint/v2/zones/ff8080825b8fc86c015b94bc6f8712c3"
              },
              "pool_id": "ff8080825ab738f4015ab7513298010e",
              "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
              "zone_type": "private",
              "created_at": "2017-04-22T08:17:08.997",
              "updated_at": "2017-04-22T08:17:09.997",
              "record_num": 2,
              "routers": [
                  {
                      "status": "ACTIVE",
                      "router_id": "19664294-0bf6-4271-ad3a-94b8c79c6558",
                      "router_region": "xx"
                  },
                  {
                      "status": "ACTIVE",
                      "router_id": "f0791650-db8c-4a20-8a44-a06c6e24b15b",
                      "router_region": "xx"
                  }
              ]
          },
          {
              "id": "ff8080825b95142f015b951f87280029",
              "name": "example.org.",
              "description": "This is an example zone.",
              "email": "xx@example.org",
              "ttl": 300,
              "serial": 0,
              "masters": [],
              "status": "ACTIVE",
              "links": {
                  "self": "https://Endpoint/v2/zones/ff8080825b95142f015b951f87280029"
              },
              "pool_id": "ff8080825ab738f4015ab7513298010e",
              "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
              "zone_type": "private",
              "created_at": "2017-04-22T08:17:08.997",
              "updated_at": "2017-04-22T08:17:09.997",
              "record_num": 2,
              "routers": [
                  {
                      "status": "ACTIVE",
                      "router_id": "19664294-0bf6-4271-ad3a-94b8c79c6558",
                      "router_region": "xx"
                  },
                  {
                      "status": "ACTIVE",
                      "router_id": "f0791650-db8c-4a20-8a44-a06c6e24b15b",
                      "router_region": "xx"
                  }
              ]
  
          }
      ],
      "metadata": {
          "total_count": 2
      }
  }
  

返回值

接口正常的返回值为2xx，例如200、202或者204。

返回值含义以及更多返回值请参考状态码。