4.2 公网 Zone 管理
4.2.3 查询公网 Zone 列表
功能介绍
查询公网Zone的列表。
调试
您可以在API Explorer中调试该接口。
URI
GET /v2/zones?
type={type}&limit={limit}&marker={marker}&offset={offset}&tags={tags}&name={
name}&status={status}&enterprise_project_id={id}
参数说明请参见表4-16。
表4-16 URI 格式的参数说明
名称 是否必选 参数类型 说明
type 否 String 待查询的zone的类型。
取值范围：public、private
● 如果为空，表示查询公网类型的zone。
● 如果为public，表示查询公网类型的zone。
● 如果为private，表示查询内网类型的zone。
搜索模式默认为模糊搜索。
默认值为空。
marker 否 String 分页查询起始的资源ID，为空时为查询第一页。
limit 否 Integer 每页返回的资源个数。
取值范围：0~500
取值一般为10，20，50。默认值为500。
offset 否 Integer 分页查询起始偏移量，表示从偏移量的下一个资 源开始查询。
取值范围：0-2147483647 默认值为0。
当前设置marker不为空时，以marker为分页起 始标识。
名称 是否必选 参数类型 说明 tags 否 String 资源标签。
取值格式：key1,value1|key2,value2
多个标签之间用"|"分开，每个标签的键值用英文 逗号","相隔。
多个标签之间为“与”的关系。
关于资源标签，请参见添加资源标签。
搜索模式为精确搜索。如果资源标签值value是以
*开头时，则按照*后面的值全模糊匹配。
默认值为空。
name 否 String zone名称。
搜索模式默认为模糊搜索。
status 否 String 资源状态。
详细信息请参见资源状态。
enterpri se_proje ct_id
否 String 域名关联的企业项目ID，长度不超过36个字符。
默认值为0。
请求
● 请求参数 无
● 请求样例
查询域名类型为公网，且资源标签键为key1、值为value1的前10个域名。
GET https://{DNS_Endpoint}/v2/zones?type=public&limit=10&offset=0&tags=key1,value1
响应
● 要素说明
表4-17 响应样例的要素说明
名称 参数类型 说明
links Object 指向当前资源或者其他资源的链接。当查询需要 分页时，需要包含一个next链接指向下一页。
详细信息请参见表4-20。
zones Array of
object zone列表对象，详细内容请参见表4-18。
metadata Object 返回满足过滤条件的资源总数，详细内容请参见 表4-19。
表4-18 zones 参数说明
名称 参数类型 说明
id String zone的ID，uuid形式的一个资源标识。
name String zone名称。
description String 对zone的描述信息。
email String 管理该zone的管理员邮箱。
zone_type String zone类型，公网（public）或者内网
（private）。
ttl Integer 该zone下SOA记录中的ttl值。
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链接指向下一页。
详细信息请参见表4-20。
tags Array of tag
objects 资源标签。
取值格式：key1,value1|key2,value2
多个标签之间用"|"分开，每个标签的键值用英文 逗号","相隔。
多个标签之间为“与”的关系。
关于资源标签，请参见表4-21。
搜索模式为精确搜索。如果资源标签值value是 以*开头时，则按照*后面的值全模糊匹配。
默认值为空。
enterprise_
project_id String 域名关联的企业项目ID，长度不超过36个字符。
名称 参数类型 说明 masters Array of
strings 主从模式中，从DNS服务器用以获取DNS信息。
目前暂未使用。
表4-19 metadata 参数说明
名称 参数类型 说明
total_count Integer 满足查询条件的资源总数，不受分页（即limit、
offset参数）影响。
表4-20 links 参数说明
名称 参数类型 说明
self String 当前资源的链接。
next String 下一页资源的链接。
表4-21 tag 对象参数说明
名称 参数类型 说明
key String 键。最大长度36个unicode字符。 key不能为 空。不能包含“=”、“*”、“<”、“>”、
“\”、“,”、“|”和“/”，且首尾字符不能为 空格。
value String 值。每个值最大长度43个unicode字符，可以为 空字符串。 不能包含“=”、“*”、“<”、
“>”、“\”、“,”、“|”和“/”，且首尾字 符不能为空格。
● 响应样例
{ "links": {
"self": "https://Endpoint/v2/zones?type=public&limit=11", "next": "https://Endpoint/v2/zones?
type=public&limit=11&marker=2c9eb155587194ec01587224c9f90149"
}, "zones": [ {
"id": "2c9eb155587194ec01587224c9f90149", "name": "example.com.",
"description": "This is an example zone.", "email": "[email protected]",
"ttl": 300, "serial": 0, "masters": [], "status": "ACTIVE", "links": {
"self": "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149"
},
"pool_id": "00000000570e54ee01570e9939b20019", "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c", "zone_type": "public",
"created_at": "2016-11-17T11:56:03.439", "updated_at": "2016-11-17T11:56:05.528", "record_num": 2
}, {
"id": "2c9eb155587228570158722996c50001", "name": "example.org.",
"description": "This is an example zone.", "email": "[email protected]",
"ttl": 300, "serial": 0, "masters": [],
"status": "PENDING_CREATE", "links": {
"self": "https://Endpoint/v2/zones/2c9eb155587228570158722996c50001"
},
"pool_id": "00000000570e54ee01570e9939b20019", "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c", "zone_type": "public",
"created_at": "2016-11-17T12:01:17.996", "updated_at": "2016-11-17T12:01:18.528", "record_num": 2
} ],
"metadata": { "total_count": 2 }
}
返回值
接口正常的返回值为2xx，例如200、202或者204。
返回值含义以及更多返回值请参考状态码。