查询域名下的记录集列表
功能介绍
当您的记录集创建成功后,您可以通过调用此接口查询指定域名下的所有记录集信息,包括名称、ID、状态、所属域名、解析记录值、标签、TTL、创建时间、修改时间、描述等。
调用方法
请参见如何调用API。
URI
GET /v2/zones/{zone_id}/recordsets
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
zone_id |
是 |
String |
参数解释: 域名ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
search_mode |
否 |
String |
参数解释: 查询条件搜索模式。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
marker |
否 |
String |
参数解释: 分页查询的起始资源ID。
约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
limit |
否 |
Integer |
参数解释: 分页查询时配置每页返回的资源个数。 约束限制: 不涉及。 取值范围: 0~500。 默认取值: 500 |
offset |
否 |
Integer |
参数解释: 分页查询起始偏移量,表示从偏移量的下一个资源开始查询。 约束限制: 当设置marker不为空时,以marker为分页起始标识,offset不生效。 取值范围: 0~2147483647。 默认取值: 0 |
tags |
否 |
String |
参数解释: 记录集的标签,包括标签键和标签值。 取值格式:key1,value1|key2,value2。 约束限制:
取值范围: 最多可以查询20个标签。 默认取值: 不涉及。 |
status |
否 |
String |
参数解释: 记录集状态。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
type |
否 |
String |
参数解释: 记录集的类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
name |
否 |
String |
参数解释: 待查询的记录集的域名中包含此name。 搜索模式默认为模糊搜索。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
id |
否 |
String |
参数解释: 待查询的记录集ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
sort_key |
否 |
String |
参数解释: 查询结果中记录集列表的排序字段。 约束限制: 不涉及。 取值范围:
默认取值: 默认值为空,表示不排序。 |
sort_dir |
否 |
String |
参数解释: 查询结果中记录集列表的排序方式。 约束限制: 不涉及。 取值范围:
默认取值: 默认值为空,表示不排序。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 获取用户Token请参见获取用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
links |
pageLink object |
参数解释: 指向当前页或者其他页的链接。当查询需要分页时,需要包含一个next链接指向下一页。 取值范围: 不涉及。 |
recordsets |
Array of ListRecordSets objects |
参数解释: 记录集列表信息。 取值范围: 不涉及。 |
metadata |
metadata object |
参数解释: 返回满足过滤条件的资源总数。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 记录集的ID。 取值范围: 不涉及。 |
name |
String |
参数解释: 记录集的名称。 取值范围: 不涉及。 |
description |
String |
参数解释: 记录集的描述信息。 取值范围: 长度不超过255个字符。 |
zone_id |
String |
参数解释: 托管该记录的域名ID。 取值范围: 不涉及。 |
zone_name |
String |
参数解释: 托管该记录的域名。 取值范围: 不涉及。 |
type |
String |
参数解释: 记录类型。 取值范围:
|
ttl |
Integer |
参数解释: 解析记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。 取值范围: 1~2147483647。 |
records |
Array of strings |
参数解释: 域名解析后的值。 取值范围: 不涉及。 |
create_at |
String |
参数解释: 记录集的创建时间。 格式:yyyy-MM-dd'T'HH:mm:ss.SSS。 取值范围: 不涉及。 |
update_at |
String |
参数解释: 记录集的最近一次修改时间。 格式:yyyy-MM-dd'T'HH:mm:ss.SSS。 取值范围: 不涉及。 |
status |
String |
参数解释: 记录集状态。 取值范围:
|
default |
Boolean |
参数解释: 标识是否由系统默认生成,系统默认生成的记录集不能删除。 取值范围: 不涉及。 |
project_id |
String |
参数解释: 该记录集所属的项目ID。 取值范围: 不涉及。 |
links |
pageLink object |
参数解释: 指向当前页或者其他页的链接。当查询需要分页时,需要包含一个next链接指向下一页。 取值范围: 不涉及。 |
请求示例
无
响应示例
状态码:200
查询域名下的记录集列表响应。
{ "links" : { "self" : "https://Endpoint/v2/recordsets?limit=10&marker=&name=&status=&zone_id=2c9eb155587194ec01587224c9f90149", "next" : "https://Endpoint/v2/recordsets?limit=10&marker=2c9eb155587194ec01587224c9f9014a&name=&status=&zone_id=2c9eb155587194ec01587224c9f90149" }, "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-17T12: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-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" : "PENDING_CREATE", "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" : 3 } }
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 |
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 ListRecordSetsByZoneSolution { 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(); ListRecordSetsByZoneRequest request = new ListRecordSetsByZoneRequest(); request.withZoneId("{zone_id}"); try { ListRecordSetsByZoneResponse response = client.listRecordSetsByZone(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 |
# 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 = ListRecordSetsByZoneRequest() request.zone_id = "{zone_id}" response = client.list_record_sets_by_zone(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 |
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.ListRecordSetsByZoneRequest{} request.ZoneId = "{zone_id}" response, err := client.ListRecordSetsByZone(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询域名下的记录集列表响应。 |
错误码
请参见错误码。