文档首页/ 云解析服务 DNS/ API参考/ API/ Record Set管理/ 查询租户Record Set资源列表
更新时间:2024-07-09 GMT+08:00
分享

查询租户Record Set资源列表

功能介绍

查询租户Record Set资源列表

调用方法

请参见如何调用API

URI

GET /v2/recordsets

表1 Query参数

参数

是否必选

参数类型

描述

zone_type

String

待查询的Record Set的域名类型。

取值范围:public、private

如果为空,表示查询公网类型的Record Set。 如果为public,表示查询公网类型的Record Set。 如果为private,表示查询内网类型的Record Set。 搜索模式默认为模糊搜索。

默认值为public。

marker

String

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

默认值为空。

search_mode

String

查询条件搜索模式。

取值范围:

like:模糊搜索 equal:精确搜索

limit

Integer

每页返回的资源个数。

取值范围:0~500

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

offset

Integer

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

取值范围:0~2147483647

默认值为0。

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

tags

String

资源标签。

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

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

status

String

待查询的Record Set的状态。取值范围:ACTIVE、ERROR、DISABLE、FREEZE、PENDING_CREATE、PENDING_UPDATE、PENDING_DELETE

type

String

待查询的Record Set的记录集类型。公网域名场景的记录类型: A、AAAA、MX、CNAME、TXT、NS、SRV、CAA。内网域名场景的记录类型: A、AAAA、MX、CNAME、TXT、SRV。

name

String

待查询的Record Set的域名中包含此name。

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

默认值为空。

id

String

待查询的Record Set的id包含此id。

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

默认值为空。

records

String

待查询的Record Set的值中包含此records。

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

默认值为空。

sort_key

String

查询结果中Record Set列表的排序字段。

取值范围:

name:域名 type:记录集类型 默认值为空,表示不排序。

sort_dir

String

查询结果中Record Set列表的排序方式。

取值范围:

desc:降序排序 asc:升序排序 默认值为空,表示不排序。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

links

pageLink object

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

recordsets

Array of ListRecordSetsWithTags objects

recordset列表对象。

metadata

metadata object

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

表4 ListRecordSetsWithTags

参数

参数类型

描述

id

String

Record Set的ID。

name

String

Record Set的名称。

description

String

Record Set的描述信息。

zone_id

String

托管该记录的zone_id。

zone_name

String

托管该记录的zone_name。

type

String

记录类型。

ttl

Integer

解析记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。

records

Array of strings

域名解析后的值。

create_at

String

创建时间。

update_at

String

更新时间。

status

String

资源状态。

default

Boolean

标识是否由系统默认生成,系统默认生成的Record Set不能删除。

project_id

String

该Record Set所属的项目ID。

links

pageLink object

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

tags

Array of tag objects

资源标签。

表6 tag

参数

参数类型

描述

key

String

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

value

String

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

表7 metadata

参数

参数类型

描述

total_count

Integer

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

请求示例

响应示例

状态码: 200

查询租户Record Set资源列表响应。

{
  "links" : {
    "self" : "https://Endpoint/v2/recordsets",
    "next" : "https://Endpoint/v2/recordsets?id=&limit=10&marker=2c9eb155587194ec01587224c9f9014a"
  },
  "recordsets" : [ {
    "id" : "2c9eb155587194ec01587224c9f9014a",
    "name" : "example.com.",
    "type" : "SOA",
    "ttl" : 300,
    "records" : [ "ns1.hotrot.de. xx.example.com. (1 7200 900 1209600 300)" ],
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014a"
    },
    "zone_id" : "2c9eb155587194ec01587224c9f90149",
    "zone_name" : "example.com.",
    "create_at" : "2016-11-17T11:56:03.439",
    "update_at" : "2016-11-17T11:56:03.827",
    "default" : true,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
  }, {
    "id" : "2c9eb155587194ec01587224c9f9014c",
    "name" : "example.com.",
    "type" : "NS",
    "ttl" : 172800,
    "records" : [ "ns2.hotrot.de.", "ns1.hotrot.de." ],
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014c"
    },
    "zone_id" : "2c9eb155587194ec01587224c9f90149",
    "zone_name" : "example.com.",
    "create_at" : "2016-11-17T11:56:03.439",
    "update_at" : "2016-11-17T11:56:03.827",
    "default" : true,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
  }, {
    "id" : "2c9eb155587228570158722996ca0002",
    "name" : "example.org.",
    "type" : "SOA",
    "ttl" : 300,
    "records" : [ "ns1.hotrot.de. xx.example.org. (1 7200 900 1209600 300)" ],
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587228570158722996c50001/recordsets/2c9eb155587228570158722996ca0002"
    },
    "zone_id" : "2c9eb155587228570158722996c50001",
    "zone_name" : "example.org.",
    "create_at" : "2016-11-17T12:01:17.996",
    "update_at" : "2016-11-17T12:56:03.827",
    "default" : true,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
  }, {
    "id" : "2c9eb155587228570158722996ca0004",
    "name" : "example.org.",
    "type" : "NS",
    "ttl" : 172800,
    "records" : [ "ns2.hotrot.de.", "ns1.hotrot.de." ],
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587228570158722996c50001/recordsets/2c9eb155587228570158722996ca0004"
    },
    "zone_id" : "2c9eb155587228570158722996c50001",
    "zone_name" : "example.org.",
    "create_at" : "2016-11-17T12:01:17.996",
    "update_at" : "2016-11-17T12:56:03.827",
    "default" : true,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
  }, {
    "id" : "2c9eb155587228570158722b6ac30007",
    "name" : "www.example.com.",
    "description" : "This is an example record set.",
    "type" : "A",
    "ttl" : 300,
    "records" : [ "192.168.10.2", "192.168.10.1" ],
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007"
    },
    "zone_id" : "2c9eb155587194ec01587224c9f90149",
    "zone_name" : "example.com.",
    "create_at" : "2016-11-17T12:03:17.827",
    "update_at" : "2016-11-17T12:56:03.827",
    "default" : false,
    "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c"
  } ],
  "metadata" : {
    "total_count" : 5
  }
}

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
55
56
57
58
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 ListRecordSetsSolution {

    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();
        ListRecordSetsRequest request = new ListRecordSetsRequest();
        request.withZoneType("<zone_type>");
        request.withMarker("<marker>");
        request.withSearchMode("<search_mode>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        request.withTags("<tags>");
        request.withStatus("<status>");
        request.withType("<type>");
        request.withName("<name>");
        request.withId("<id>");
        request.withRecords("<records>");
        request.withSortKey("<sort_key>");
        request.withSortDir("<sort_dir>");
        try {
            ListRecordSetsResponse response = client.listRecordSets(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
39
40
41
42
43
# 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 = ListRecordSetsRequest()
        request.zone_type = "<zone_type>"
        request.marker = "<marker>"
        request.search_mode = "<search_mode>"
        request.limit = <limit>
        request.offset = <offset>
        request.tags = "<tags>"
        request.status = "<status>"
        request.type = "<type>"
        request.name = "<name>"
        request.id = "<id>"
        request.records = "<records>"
        request.sort_key = "<sort_key>"
        request.sort_dir = "<sort_dir>"
        response = client.list_record_sets(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
54
55
56
57
58
59
60
61
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.ListRecordSetsRequest{}
	zoneTypeRequest:= "<zone_type>"
	request.ZoneType = &zoneTypeRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	searchModeRequest:= "<search_mode>"
	request.SearchMode = &searchModeRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	tagsRequest:= "<tags>"
	request.Tags = &tagsRequest
	statusRequest:= "<status>"
	request.Status = &statusRequest
	typeRequest:= "<type>"
	request.Type = &typeRequest
	nameRequest:= "<name>"
	request.Name = &nameRequest
	idRequest:= "<id>"
	request.Id = &idRequest
	recordsRequest:= "<records>"
	request.Records = &recordsRequest
	sortKeyRequest:= "<sort_key>"
	request.SortKey = &sortKeyRequest
	sortDirRequest:= "<sort_dir>"
	request.SortDir = &sortDirRequest
	response, err := client.ListRecordSets(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询租户Record Set资源列表响应。

错误码

请参见错误码

相关文档