# 查询域名下的记录集列表 - ShowRecordSetByZone #### 功能介绍 当您的记录集创建成功后，您可以通过调用此接口查询指定域名下的所有记录集信息，包括名称、ID、状态、所属域名、解析记录值、标签、TTL、创建时间、修改时间、描述等。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dns/zh-cn_topic_0037134405.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dns/dns_api_70000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dns:recordset:list | List | zone \* | - g:ResourceTag/\ - g:EnterpriseProjectId | - | - | #### URI GET /v2.1/zones/{zone_id}/recordsets 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | zone_id | 是 | String | **参数解释：** 域名ID。 获取方式：通过查询公网域名列表（ListPublicZones）或内网域名列表（ListPrivateZones）接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | marker | 否 | String | **参数解释：** 分页查询的起始资源ID。 获取方式：从上一页查询结果中最后一个资源的ID获取。 - 查询第一页时，设置为空。 - 查询下一页时，设置为上一页最后一条资源的ID。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | limit | 否 | Integer | **参数解释：** 分页查询时配置每页返回的资源个数。 **约束限制：** 不涉及。 **取值范围：** 0\~500。 **默认取值：** 500 | | offset | 否 | Integer | **参数解释：** 分页查询起始偏移量，表示从偏移量的下一个资源开始查询。 **约束限制：** 当设置marker不为空时，以marker为分页起始标识，offset不生效。 **取值范围：** 0\~2147483647。 **默认取值：** 0 | | line_id | 否 | String | **参数解释：** 解析线路ID。 获取线路ID请参见[获取线路ID](https://support.huaweicloud.com/api-dns/zh-cn_topic_0085546214.html)。也可通过查询自定义线路（ListCustomLine）或查询线路分组列表（ListLineGroups）接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | tags | 否 | String | **参数解释：** 记录集的标签，包括标签键和标签值。 取值格式：key1,value1\|key2,value2。该字段为字符串，按key1,value1\|key2,value2格式表示多个标签，每个标签含key（标签键，必选）和value（标签值，可选），用于资源标签的分类管理与筛选。 **约束限制：** - 多个标签之间用"\|"分开，每个标签的键值用英文逗号","相隔。 - 多个标签之间为"与"的关系。 - 搜索模式为精确搜索。如果资源标签值value是以\*开头时，则按照\*后面的值全模糊匹配。 - 最多可以查询20个标签。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | status | 否 | String | **参数解释：** 记录集状态。 **约束限制：** 不涉及。 **取值范围：** - ACTIVE：正常 - PENDING_CREATE：创建中 - PENDING_UPDATE：更新中 - PENDING_DELETE：删除中 - PENDING_FREEZE：冻结中 - FREEZE：冻结 - ILLEGAL：违规冻结 - POLICE：公安冻结 - PENDING_DISABLE：暂停中 - DISABLE：暂停 - ERROR：失败 **默认取值：** 不涉及。 | | type | 否 | String | **参数解释：** 记录集的类型。 **约束限制：** 不涉及。 **取值范围：** - A：将域名解析到指定的IPv4地址。 - AAAA：将域名解析到指定的IPv6地址。 - MX：指定域名对应的邮件服务器。 - CNAME：将域名解析到另一域名，或者多个域名映射到同一域名上。 - TXT：用于对域名进行标识和说明。 - SRV：用于记录某台服务器对外提供了哪些服务。 - NS：指定域名的权威DNS服务器。 - SOA：提供域名的基本信息和权威服务器的详细信息。 - CAA：指定为域名颁发HTTPS证书的授权CA机构，仅支持公网域名解析。 - PTR：指定IP地址反向解析记录，仅支持内网域名解析。 **默认取值：** 不涉及。 | | name | 否 | String | **参数解释：** 待查询的记录集的域名中包含此name。 搜索模式默认为模糊搜索。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | id | 否 | String | **参数解释：** 待查询的记录集ID。 获取方式：通过查询域名下的记录集列表（ShowRecordSetByZone）接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | sort_key | 否 | String | **参数解释：** 查询结果中记录集列表的排序字段。 **约束限制：** 不涉及。 **取值范围：** - name：记录集名称 - type：记录集类型 - created_at：创建时间 - updated_at：更新时间 **默认取值：** created_at | | sort_dir | 否 | String | **参数解释：** 查询结果中记录集列表的排序方式。 **约束限制：** 不涉及。 **取值范围：** - desc：降序排序 - asc：升序排序 **默认取值：** desc | | search_mode | 否 | String | **参数解释：** 查询条件搜索模式。 **约束限制：** 不涉及。 **取值范围：** - like：模糊搜索 - equal：精确搜索 **默认取值：** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，用于用户身份认证，调用接口时需在请求头中携带该Token以验证用户身份。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 获取用户Token请参见[获取用户Token](https://support.huaweicloud.com/api-dns/dns_api_30003.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | links | [pageLink] object | **参数解释：** 指向当前页和下一页的链接。分页查询需要分页时，需要使用一个next字段指向下一页。 | | recordsets | Array of [ShowRecordSetByZoneResp] objects | **参数解释：** 记录集列表信息。 该字段为数组，每个元素包含记录集ID、名称、类型、TTL及解析记录值列表等字段。 | | metadata | [metadata] object | **参数解释：** 分页查询的元数据信息，包含满足查询条件的资源总数（total_count）等。 | 表5ShowRecordSetByZoneResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 记录集的ID。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 记录集的名称。 **取值范围：** 不涉及。 | | description | String | **参数解释：** 记录集的描述信息。 **取值范围：** 长度不超过255个字符。 | | zone_id | String | **参数解释：** 托管该记录的域名ID。 **取值范围：** 不涉及。 | | zone_name | String | **参数解释：** 托管该记录的域名。 **取值范围：** 不涉及。 | | type | String | **参数解释：** 记录类型。 **取值范围：** - A：将域名解析到指定的IPv4地址。 - AAAA：将域名解析到指定的IPv6地址。 - MX：指定域名对应的邮件服务器。 - CNAME：将域名解析到另一域名，或者多个域名映射到同一域名上。 - TXT：用于对域名进行标识和说明。 - SRV：用于记录某台服务器对外提供了哪些服务。 - NS：指定域名的权威DNS服务器。 - SOA：提供域名的基本信息和权威服务器的详细信息。 - CAA：指定为域名颁发HTTPS证书的授权CA机构，仅支持公网域名解析。 - PTR：指定IP地址反向解析记录，仅支持内网域名解析。 | | ttl | Integer | **参数解释：** 解析记录在本地DNS服务器的缓存时间，缓存时间越长更新生效越慢，以秒为单位。 **取值范围：** 1\~2147483647。 | | records | Array of strings | **参数解释：** 域名解析后的值。 该字段为字符串数组，每个元素为一条解析记录值。 | | created_at | String | **参数解释：** 记录集的创建时间。 使用UTC+0时间格式，格式为yyyy-MM-dd'T'HH:mm:ss.SSS，例如：2023-01-01T12:00:00.000。 **取值范围：** 不涉及。 | | updated_at | String | **参数解释：** 记录集的最近一次修改时间。 使用UTC+0时间格式，格式为yyyy-MM-dd'T'HH:mm:ss.SSS，例如：2023-01-01T12:00:00.000。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 记录集状态。 **取值范围：** - ACTIVE：正常 - PENDING_CREATE：创建中 - PENDING_UPDATE：更新中 - PENDING_DELETE：删除中 - PENDING_FREEZE：冻结中 - FREEZE：冻结 - ILLEGAL：违规冻结 - POLICE：公安冻结 - PENDING_DISABLE：暂停中 - DISABLE：暂停 - ERROR：失败 | | default | Boolean | **参数解释：** 标识是否由系统默认生成，系统默认生成的记录集不能删除。 **取值范围：** - true：由系统默认生成，不能删除。 - false：非系统默认生成，可以删除。 | | project_id | String | **参数解释：** 该记录集所属的项目ID。 **取值范围：** 不涉及。 | | links | [pageLink] object | **参数解释：** 指向当前页和下一页的链接。分页查询需要分页时，需要使用一个next字段指向下一页。 | | line | String | **参数解释：** 解析线路ID。 **取值范围：** 不涉及。 | | weight | Integer | **参数解释：** 解析记录的权重。 **取值范围：** 0\~1000。 | | health_check_id | String | **参数解释：** 健康检查ID。 **取值范围：** 不涉及。 | | alias_target | [alias_target] object | **参数解释：** 别名记录，用于将当前记录集指向其他云服务的域名。 | 表6pageLink | 参数 | 参数类型 | 描述 | |:---|:---|:---| | self | String | **参数解释：** 当前页面的链接。 **取值范围：** 不涉及。 | | next | String | **参数解释：** 下一页的链接。 **取值范围：** 不涉及。 | 表7alias_target | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resource_type | String | **参数解释：** 资源服务类型，支持别名记录的服务。 **取值范围：** - cloudsite：企业门户 - waf：Web应用防火墙 | | resource_domain_name | String | **参数解释：** 对应服务下的域名，由各服务提供。 **取值范围：** 不涉及。 | 表8metadata | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释：** 满足查询条件的资源总数，不受分页（即limit、offset参数）影响。 **取值范围：** 不涉及。 | #### 请求示例 查询域名下的记录集列表。 ``` GET https://{Endpoint}/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets?limit=10&marker=&name=&status= ``` #### 响应示例 **状态码：200** ``` { "links" : { "self" : "https://{Endpoint}/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets?limit=10&marker=&name=&status=", "next" : "https://{Endpoint}/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets?limit=10&marker=2c9eb155587194ec01587224c9f9014a&name=&status=" }, "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.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014a" }, "alias_target" : null, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "created_at" : "2016-11-17T11:56:03.439", "updated_at" : "2016-11-17T11:56:06.439", "default" : true, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "line" : "default_view", "weight" : 1, "health_check_id" : null }, { "id" : "2c9eb155587194ec01587224c9f9014c", "name" : "example.com.", "type" : "NS", "ttl" : 172800, "records" : [ "ns2.hotrot.de.", "ns1.hotrot.de." ], "status" : "ACTIVE", "links" : { "self" : "https://{Endpoint}/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587194ec01587224c9f9014c" }, "alias_target" : null, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "created_at" : "2016-11-17T11:56:03.439", "updated_at" : "2016-11-17T11:56:06.439", "default" : true, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "line" : "default_view", "weight" : 1, "health_check_id" : null }, { "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.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007" }, "alias_target" : null, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "created_at" : "2016-11-17T12:03:17.827", "updated_at" : "2016-11-17T12:56:06.439", "default" : false, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "line" : "default_view", "weight" : 1, "health_check_id" : null } ], "metadata" : { "total_count" : 3 } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` 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 ShowRecordSetByZoneSolution { 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("")) .build(); ShowRecordSetByZoneRequest request = new ShowRecordSetByZoneRequest(); request.withZoneId("{zone_id}"); try { ShowRecordSetByZoneResponse response = client.showRecordSetByZone(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()); } } } ``` - [Python] ``` # 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("")) \ .build() try: request = ShowRecordSetByZoneRequest() request.zone_id = "{zone_id}" response = client.show_record_set_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) ``` - [Go] ``` 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, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dns.DnsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dns.NewDnsClient(hcClient) request := &model.ShowRecordSetByZoneRequest{} request.ZoneId = "{zone_id}" response, err := client.ShowRecordSetByZone(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DNS/sdk?api=ShowRecordSetByZone)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询域名下的记录集列表响应。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dns/ErrorCode.html)。