更新时间:2025-08-21 GMT+08:00

查询公网域名列表

功能介绍

当您的公网域名创建成功后,您可以通过调用此接口查询所有公网域名信息,包括域名、ID、状态、记录集个数、企业项目、标签、TTL、创建时间、修改时间、描述等。

公网域名为全局资源,请选择“亚太-新加坡(ap-southeast-3)”区域调用。

调用方法

请参见如何调用API

URI

GET /v2/zones

表1 Query参数

参数

是否必选

参数类型

描述

type

String

参数解释:

待查询域名的类型。

约束限制:

不涉及。

取值范围:

public:公网域名

默认取值:

public。

limit

Integer

参数解释:

分页查询时配置每页返回的资源个数。

约束限制:

不涉及。

取值范围:

0~500。

默认取值:

500

marker

String

参数解释:

分页查询的起始资源ID。

  • 查询第一页时,设置为空。

  • 查询下一页时,设置为上一页最后一条资源的ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

offset

Integer

参数解释:

分页查询起始偏移量,表示从偏移量的下一个资源开始查询。

约束限制:

当设置marker不为空时,以marker为分页起始标识,offset不生效。

取值范围:

0~2147483647。

默认取值:

0

tags

String

参数解释:

公网域名的标签,包括标签键和标签值。

取值格式:key1,value1|key2,value2。

约束限制:

  • 多个标签之间用“|”分开,每个标签的键值用英文逗号“,”相隔。

  • 多个标签之间为“与”的关系。

  • 搜索模式为精确搜索。如果资源标签值value是以*开头时,则按照*后面的值全模糊匹配。

取值范围:

最多可以查询20个标签。

默认取值:

不涉及。

name

String

参数解释:

域名。

搜索模式默认为模糊搜索。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

id

String

参数解释:

域名ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

status

String

参数解释:

公网域名状态。

约束限制:

不涉及。

取值范围:

  • ACTIVE:正常

  • PENDING_CREATE:创建中

  • PENDING_UPDATE:更新中

  • PENDING_DELETE:删除中

  • PENDING_FREEZE:冻结中

  • FREEZE:冻结

  • ILLEGAL:违规冻结

  • POLICE:公安冻结

  • PENDING_DISABLE:暂停中

  • DISABLE:暂停

  • ERROR:失败

默认取值:

不涉及。

search_mode

String

参数解释:

查询条件搜索模式。

约束限制:

不涉及。

取值范围:

  • like:模糊搜索

  • equal:精确搜索

默认取值:

不涉及。

sort_key

String

参数解释:

查询结果中域名列表的排序字段。

约束限制:

不涉及。

取值范围:

  • name:域名

  • created_at:创建时间

  • updated_at:更新时间

默认取值:

created_at

sort_dir

String

参数解释:

查询结果中域名列表的排序方式。

约束限制:

不涉及。

取值范围:

  • desc:降序排序

  • asc:升序排序

默认取值:

desc

enterprise_project_id

String

参数解释:

域名所属的企业项目ID。可以使用该字段过滤企业项目下的域名。

约束限制:

不涉及。

取值范围:

最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。

默认取值:

0

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

获取用户Token请参见获取用户Token

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

links

pageLink object

参数解释:

指向当前页或者其他页的链接。当查询需要分页时,需要包含一个next链接指向下一页。

取值范围:

不涉及。

zones

Array of PublicZoneResp objects

参数解释:

查询公网域名的列表响应。

取值范围:

不涉及。

metadata

metadata object

参数解释:

返回满足过滤条件的资源总数。

取值范围:

不涉及。

表4 PublicZoneResp

参数

参数类型

描述

id

String

参数解释:

域名的ID,UUID形式的一个资源标识。

取值范围:

不涉及。

name

String

参数解释:

域名。

取值范围:

由多个以点分隔的字符串组成,可包含字母、数字、汉字、中划线,中划线不能在开头或末尾,单个字符串不超过63个字符,域名总长度不超过254个字符。

description

String

参数解释:

对域名的描述信息。

取值范围:

长度不超过255个字符。

email

String

参数解释:

管理该域名的管理员邮箱,用于生成该域名的SOA记录。

取值范围:

不涉及。

zone_type

String

参数解释:

域名类型。

取值范围:

public:公网域名。

ttl

Integer

参数解释:

该域名下SOA记录中的有效缓存时间,以秒为单位。

取值范围:

1~2147483647。

serial

Integer

参数解释:

该域名下SOA记录中用于标识域名文件变更的序列值,用于主从节点同步。

取值范围:

不涉及。

status

String

参数解释:

公网域名状态。

取值范围:

  • ACTIVE:正常

  • PENDING_CREATE:创建中

  • PENDING_UPDATE:更新中

  • PENDING_DELETE:删除中

  • PENDING_FREEZE:冻结中

  • FREEZE:冻结

  • ILLEGAL:违规冻结

  • POLICE:公安冻结

  • PENDING_DISABLE:暂停中

  • DISABLE:暂停

  • ERROR:失败

record_num

Integer

参数解释:

该域名下的记录集个数。

取值范围:

不涉及。

pool_id

String

参数解释:

托管该域名的pool,由系统分配。

取值范围:

不涉及。

project_id

String

参数解释:

域名所属的项目ID。

取值范围:

不涉及。

created_at

String

参数解释:

域名的创建时间。

格式:yyyy-MM-dd'T'HH:mm:ss.SSS。

取值范围:

不涉及。

updated_at

String

参数解释:

域名的最近一次修改时间。

格式:yyyy-MM-dd'T'HH:mm:ss.SSS。

取值范围:

不涉及。

links

pageLink object

参数解释:

指向当前页或者其他页的链接。当查询需要分页时,需要包含一个next链接指向下一页。

取值范围:

不涉及。

tags

Array of tag objects

参数解释:

资源标签。

取值范围:

不涉及。

masters

Array of strings

参数解释:

主从模式中,从DNS服务器获取DNS信息。

取值范围:

不涉及。

enterprise_project_id

String

参数解释:

域名所属的企业项目ID。可以使用该字段过滤企业项目下的域名。

取值范围:

最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。

表6 tag

参数

参数类型

描述

key

String

参数解释:

标签键。

取值范围:

  • 不能为空。

  • 对于同一资源键的取值唯一。

  • 长度不超过128个字符。

  • 取值可以包含任意语种字母、数字、空格,以及_ . : = + - @特殊字符,但首尾不能含有空格,不能以_sys_开头。

value

String

参数解释:

标签值。

取值范围:

  • 可以为空。

  • 长度不超过255个字符。

  • 取值可以包含任意语种字母、数字、空格,以及_ . : / = + - @特殊字符。

表7 metadata

参数

参数类型

描述

total_count

Integer

参数解释:

满足查询条件的资源总数,不受分页(即limit、offset参数)影响。

取值范围:

不涉及。

状态码:400

表8 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码。

取值范围:

不涉及。

message

String

参数解释:

错误描述。

取值范围:

不涉及。

状态码:404

表9 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码。

取值范围:

不涉及。

message

String

参数解释:

错误描述。

取值范围:

不涉及。

状态码:500

表10 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码。

取值范围:

不涉及。

message

String

参数解释:

错误描述。

取值范围:

不涉及。

请求示例

查询公网域名列表。

GET https://{endpoint}/v2/zones?type=public&limit=10

响应示例

状态码:200

查询公网域名的列表响应。

{
  "links" : {
    "self" : "https://Endpoint/v2/zones?type=public&limit=10",
    "next" : "https://Endpoint/v2/zones?type=public&limit=10&marker=2c9eb155587194ec01587224c9f90149"
  },
  "zones" : [ {
    "id" : "2c9eb155587194ec01587224c9f90149",
    "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/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" : "xx@example.org",
    "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
  }
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dns.v2.region.DnsRegion;
import com.huaweicloud.sdk.dns.v2.*;
import com.huaweicloud.sdk.dns.v2.model.*;


public class ListPublicZonesSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        DnsClient client = DnsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DnsRegion.valueOf("<YOUR REGION>"))
                .build();
        ListPublicZonesRequest request = new ListPublicZonesRequest();
        try {
            ListPublicZonesResponse response = client.listPublicZones(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdns.v2.region.dns_region import DnsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdns.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = DnsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DnsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = ListPublicZonesRequest()
        response = client.list_public_zones(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dns "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dns.NewDnsClient(
        dns.DnsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListPublicZonesRequest{}
	response, err := client.ListPublicZones(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询公网域名的列表响应。

400

接口错误响应。

404

接口错误响应。

500

接口错误响应。

错误码

请参见错误码