更新时间:2023-12-07 GMT+08:00
分享

查询公网Zone列表

功能介绍

查询公网Zone列表

调用方法

请参见如何调用API

URI

GET /v2/zones

表1 Query参数

参数

是否必选

参数类型

描述

type

String

待查询的zone的类型。

取值范围:public

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

默认值为空。

limit

Integer

每页返回的资源个数。

取值范围:0~500

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

marker

String

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

默认值为空。

offset

Integer

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

取值范围:0~2147483647

默认值为0。

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

tags

String

资源标签。

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

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

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

关于资源标签,请参见添加资源标签。

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

默认值为空。

name

String

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链接指向下一页。

zones

Array of PublicZoneResp objects

查询公网Zone的列表响应。

metadata

metadata object

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

表4 PublicZoneResp

参数

参数类型

描述

id

String

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

name

String

zone名称。

description

String

对zone的描述信息。

email

String

管理该zone的管理员邮箱。

zone_type

String

zone类型,公网(public)。

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

创建时间。

updated_at

String

更新时间。

links

pageLink object

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

tags

Array of tag objects

资源标签。

masters

Array of strings

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

enterprise_project_id

String

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

表6 tag

参数

参数类型

描述

key

String

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

value

String

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

表7 metadata

参数

参数类型

描述

total_count

Integer

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

状态码: 400

表8 响应Body参数

参数

参数类型

描述

code

String

错误码

最小长度:8

最大长度:36

message

String

错误描述

最小长度:2

最大长度:512

状态码: 404

表9 响应Body参数

参数

参数类型

描述

code

String

错误码

最小长度:8

最大长度:36

message

String

错误描述

最小长度:2

最大长度:512

状态码: 500

表10 响应Body参数

参数

参数类型

描述

code

String

错误码

最小长度:8

最大长度:36

message

String

错误描述

最小长度:2

最大长度:512

请求示例

响应示例

状态码: 200

查询公网Zone的列表响应。

{
  "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
46
47
48
49
50
51
52
53
54
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("cn-north-4"))
                .build();
        ListPublicZonesRequest request = new ListPublicZonesRequest();
        request.withType("<type>");
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withOffset(<offset>);
        request.withTags("<tags>");
        request.withName("<name>");
        request.withStatus("<status>");
        request.withSearchMode("<search_mode>");
        request.withEnterpriseProjectId("<enterprise_project_id>");
        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
31
32
33
34
35
36
37
38
# coding: utf-8

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.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = DnsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DnsRegion.value_of("cn-north-4")) \
        .build()

    try:
        request = ListPublicZonesRequest()
        request.type = "<type>"
        request.limit = <limit>
        request.marker = "<marker>"
        request.offset = <offset>
        request.tags = "<tags>"
        request.name = "<name>"
        request.status = "<status>"
        request.search_mode = "<search_mode>"
        request.enterprise_project_id = "<enterprise_project_id>"
        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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
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("cn-north-4")).
            WithCredential(auth).
            Build())

    request := &model.ListPublicZonesRequest{}
	typeRequest:= "<type>"
	request.Type = &typeRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	tagsRequest:= "<tags>"
	request.Tags = &tagsRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	statusRequest:= "<status>"
	request.Status = &statusRequest
	searchModeRequest:= "<search_mode>"
	request.SearchMode = &searchModeRequest
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	response, err := client.ListPublicZones(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询公网Zone的列表响应。

400

接口错误响应。

404

接口错误响应。

500

接口错误响应。

错误码

请参见错误码

分享:

    相关文档

    相关产品