更新时间:2024-12-19 GMT+08:00

查询内网Zone列表

功能介绍

查询内网Zone列表

调用方法

请参见如何调用API

URI

GET /v2/zones

表1 Query参数

参数

是否必选

参数类型

描述

type

String

待查询的zone的类型。

取值范围:private。

limit

Integer

每页返回的资源个数。

取值范围:0~500

取值一般为10,20,50。默认值为500。

marker

String

分页查询起始的资源ID,为空时为查询第一页。

默认值为空。

offset

Integer

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

取值范围:0~2147483647

默认值为0。

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

tags

String

资源标签。

name

Array of strings

zone名称列表。

搜索模式为模糊搜索。

status

String

资源状态。

search_mode

String

查询条件搜索模式。

取值范围:

like:模糊搜索

equal:精确搜索

enterprise_project_id

String

域名关联的企业项目ID,长度不超过36个字符。

默认值为0。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

links

pageLink object

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

metadata

metadata object

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

zones

Array of PrivateZoneResp objects

zone列表信息。

表4 metadata

参数

参数类型

描述

total_count

Integer

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

表5 PrivateZoneResp

参数

参数类型

描述

id

String

zone的ID,uuid形式的一个资源标识。

name

String

zone名称。

description

String

对zone的描述信息。

email

String

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

zone_type

String

zone类型,内网(private)。

ttl

Integer

该zone下SOA记录中的ttl值。

serial

Integer

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

status

String

资源状态。

record_num

Integer

该zone下的recordset个数。

proxy_pattern

String

内网Zone的子域名递归解析代理模式。

取值范围:

AUTHORITY:当前Zone未开启递归解析代理

RECURSIVE:当前Zone已开启递归解析代理

pool_id

String

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

project_id

String

zone所属的项目ID。

created_at

String

创建时间。

updated_at

String

更新时间。

links

pageLink object

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

tags

Array of tag objects

资源标签。

masters

Array of strings

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

routers

Array of RouterWithStatus objects

与该zone关联的Router(VPC)列表。

enterprise_project_id

String

域名关联的企业项目ID,长度不超过36个字符。

表7 tag

参数

参数类型

描述

key

String

键。最大长度36个unicode字符。 key不能为空。不能包含“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”,且首尾字符不能为空格。

value

String

值。每个值最大长度43个unicode字符,可以为空字符串。 不能包含“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”,且首尾字符不能为空格。

表8 RouterWithStatus

参数

参数类型

描述

status

String

资源状态。

router_id

String

关联VPC的ID。

router_region

String

关联VPC所在的region。

状态码: 400

表9 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

状态码: 404

表10 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

状态码: 500

表11 响应Body参数

参数

参数类型

描述

code

String

错误码

message

String

错误描述

请求示例

响应示例

状态码: 200

查询内网Zone列表响应。

{
  "links" : {
    "self" : "https://Endpoint/v2/zones?type=private&limit=10",
    "next" : "https://Endpoint/v2/zones?type=private&limit=10&marker=ff8080825b8fc86c015b94bc6f8712c3"
  },
  "zones" : [ {
    "id" : "ff8080825b8fc86c015b94bc6f8712c3",
    "name" : "example.com.",
    "description" : "This is an example zone.",
    "email" : "xx@example.com",
    "ttl" : 300,
    "serial" : 0,
    "masters" : [ ],
    "tags" : [ ],
    "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,
    "proxy_pattern" : "AUTHORITY",
    "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"
    } ],
    "enterprise_project_id" : 0
  }, {
    "id" : "ff8080825b95142f015b951f87280029",
    "name" : "example.org.",
    "description" : "This is an example zone.",
    "email" : "xx@example.org",
    "ttl" : 300,
    "serial" : 0,
    "masters" : [ ],
    "tags" : [ ],
    "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,
    "proxy_pattern" : "AUTHORITY",
    "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"
    } ],
    "enterprise_project_id" : 0
  } ],
  "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 ListPrivateZonesSolution {

    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();
        ListPrivateZonesRequest request = new ListPrivateZonesRequest();
        try {
            ListPrivateZonesResponse response = client.listPrivateZones(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 = ListPrivateZonesRequest()
        response = client.list_private_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.ListPrivateZonesRequest{}
	response, err := client.ListPrivateZones(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询内网Zone列表响应。

400

接口错误响应。

404

接口错误响应。

500

接口错误响应。

错误码

请参见错误码