# 查询内网域名列表 - ListPrivateZones #### 功能介绍 当您的内网域名创建成功后，您可以通过调用此接口查询单个内网域名信息，包括域名、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:zone:list | List | zone \* | - | - | - | | dns:zone:list | List | - | - g:RequestTag/\ - g:TagKeys - g:EnterpriseProjectId | - | - | #### URI GET /v2/zones 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | type | 是 | String | **参数解释：** 待查询域名的类型。 **约束限制：** 不涉及。 **取值范围：** - private：内网域名 **默认取值：** 不涉及。 | | limit | 否 | Integer | **参数解释：** 分页查询时配置每页返回的资源个数。 **约束限制：** 不涉及。 **取值范围：** 0\~500。 **默认取值：** 500 | | marker | 否 | String | **参数解释：** 分页查询的起始资源ID。 获取方式：从上一页查询结果中最后一个资源的ID获取。 - 查询第一页时，设置为空。 - 查询下一页时，设置为上一页最后一条资源的ID。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | offset | 否 | Integer | **参数解释：** 分页查询起始偏移量，表示从偏移量的下一个资源开始查询。 **约束限制：** 当设置marker不为空时，以marker为分页起始标识，offset不生效。 **取值范围：** 0\~2147483647。 **默认取值：** 0 | | tags | 否 | String | **参数解释：** 内网域名的标签，包括标签键和标签值。 取值格式：key1,value1\|key2,value2。该字段为字符串，按key1,value1\|key2,value2格式表示多个标签，每个标签含key（标签键，必选）和value（标签值，可选），用于资源标签的分类管理与筛选。 **约束限制：** - 多个标签之间用"\|"分开，每个标签的键值用英文逗号","相隔。 - 多个标签之间为"与"的关系。 - 搜索模式为精确搜索。如果资源标签值value是以\*开头时，则按照\*后面的值全模糊匹配。 - 最多可以查询20个标签。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | name | 否 | String | **参数解释：** 域名。 搜索模式默认为模糊搜索。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | id | 否 | String | **参数解释：** 域名ID。 获取方式：通过查询内网域名列表（ListPrivateZones）接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | status | 否 | String | **参数解释：** 内网域名状态。 **约束限制：** 不涉及。 **取值范围：** - ACTIVE：正常 - PENDING_CREATE：创建中 - PENDING_UPDATE：更新中 - PENDING_DELETE：删除中 - PENDING_FREEZE：冻结中 - FREEZE：冻结 - ILLEGAL：违规冻结 - POLICE：公安冻结 - PENDING_DISABLE：暂停中 - DISABLE：暂停 - ERROR：失败 **默认取值：** 不涉及。 | | search_mode | 否 | String | **参数解释：** 查询条件搜索模式。 **约束限制：** 不涉及。 **取值范围：** - like：模糊搜索 - equal：精确搜索 **默认取值：** 不涉及。 | | sort_key | 否 | String | **参数解释：** 查询结果中域名列表的排序字段。 **约束限制：** 不涉及。 **取值范围：** - name：域名 - created_at：创建时间 - updated_at：更新时间 **默认取值：** created_at | | sort_dir | 否 | String | **参数解释：** 查询结果中域名列表的排序方式。 **约束限制：** 不涉及。 **取值范围：** - desc：降序排序 - asc：升序排序 **默认取值：** desc | | enterprise_project_id | 否 | String | **参数解释：** 域名所属的企业项目ID。可以使用该字段过滤企业项目下的域名。 获取方式：通过查询企业项目列表接口获取。 **约束限制：** 不涉及。 **取值范围：** 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。"0"表示默认企业项目。 **默认取值：** 0 | | router_id | 否 | String | **参数解释：** 关联VPC的ID。 获取方式：通过查询虚拟私有云VPC列表接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | shared_status | 否 | String | **参数解释：** 查询共享状态的过滤条件，用于按资源归属筛选内网域名。 **约束限制：** - 当该参数传空或不传时，查询本账号创建的内网域名。 - 共享状态仅与ID一起过滤生效。 - 共享状态仅支持limit+marker分页查询。 **取值范围：** - sharedwithme：查询其他账号共享给本账号的内网域名。 **默认取值：** 不涉及。 | #### 请求参数 表2请求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** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | links | [pageLink] object | **参数解释：** 指向当前页和下一页的链接。分页查询需要分页时，需要使用一个next字段指向下一页。 | | metadata | [metadata] object | **参数解释：** 分页查询的元数据信息，包含满足过滤条件的资源总数等统计信息。 | | zones | Array of [PrivateZoneResp] objects | **参数解释：** 域名列表信息。 该字段为数组，每个元素包含域名ID、名称、类型及状态等。 | | page_info | [PageInfo] object | **参数解释：** 分页信息对象，包含下一页标识、上一页标识、当前页数量等信息。 | 表4metadata | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释：** 满足查询条件的资源总数，不受分页（即limit、offset参数）影响。 **取值范围：** 不涉及。 | 表5PrivateZoneResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 域名的ID，UUID形式的一个资源标识。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 域名。 **取值范围：** 由多个以点分隔的字符串组成，可包含字母、数字、汉字、中划线，中划线不能在开头或末尾，单个字符串不超过63个字符，域名总长度不超过254个字符。 | | description | String | **参数解释：** 域名的描述信息，长度不超过255个字符。 **取值范围：** 不涉及。 | | email | String | **参数解释：** 管理该域名的管理员邮箱，用于生成该域名的SOA记录。 **取值范围：** 不涉及。 | | zone_type | String | **参数解释：** 域名类型。 **取值范围：** - private：内网域名。 | | ttl | Integer | **参数解释：** 该域名下SOA记录中的有效缓存时间，以秒为单位。 **取值范围：** 1\~2147483647。 | | serial | Integer | **参数解释：** 该域名下SOA记录中用于标识域名文件变更的序列值，用于主从节点同步。 **取值范围：** 不涉及。 | | status | String | **参数解释：** 内网域名状态。 **取值范围：** - ACTIVE：正常 - PENDING_CREATE：创建中 - PENDING_UPDATE：更新中 - PENDING_DELETE：删除中 - PENDING_FREEZE：冻结中 - FREEZE：冻结 - ILLEGAL：违规冻结 - POLICE：公安冻结 - PENDING_DISABLE：暂停中 - DISABLE：暂停 - ERROR：失败 | | record_num | Integer | **参数解释：** 该域名下的记录集个数。 **取值范围：** 不涉及。 | | proxy_pattern | String | **参数解释：** 内网域名的子域名递归解析代理模式。 **取值范围：** - AUTHORITY：当前域名未开启递归解析代理 - RECURSIVE：当前域名已开启递归解析代理 | | pool_id | String | **参数解释：** 托管该域名的pool，由系统分配。 **取值范围：** 不涉及。 | | project_id | String | **参数解释：** 域名所属的项目ID。 **取值范围：** 不涉及。 | | 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。 **取值范围：** 不涉及。 | | links | [pageLink] object | **参数解释：** 指向当前页和下一页的链接。分页查询需要分页时，需要使用一个next字段指向下一页。 | | tags | Array of [tag] objects | **参数解释：** 资源标签列表。 该字段为数组，每个元素包含标签键和标签值。 | | masters | Array of strings | **参数解释：** 主从模式中，从DNS服务器获取DNS信息。目前暂未使用。该字段为字符串数组，每个元素为主DNS服务器的IP地址。 | | routers | Array of [RouterWithStatus] objects | **参数解释：** 与该域名关联的Router(VPC)列表。 | | enterprise_project_id | String | **参数解释：** 域名所属的企业项目ID。可以使用该字段过滤企业项目下的域名。 **取值范围：** 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。"0"表示默认企业项目。 | 表6pageLink | 参数 | 参数类型 | 描述 | |:---|:---|:---| | self | String | **参数解释：** 当前页面的链接。 **取值范围：** 不涉及。 | | next | String | **参数解释：** 下一页的链接。 **取值范围：** 不涉及。 | 表7tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 标签键。 **取值范围：** - 长度不超过128个字符。 - 取值可以包含任意语种字母、数字、空格，以及_ . : = + - @特殊字符。 | | value | String | **参数解释：** 标签值。 **取值范围：** - 长度不超过255个字符。 - 取值可以包含任意语种字母、数字、空格，以及_ . : / = + - @特殊字符。 | 表8RouterWithStatus | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释：** 关联VPC的状态。 **取值范围：** 不涉及。 | | router_id | String | **参数解释：** 关联VPC的ID。 **取值范围：** 不涉及。 | | router_region | String | **参数解释：** 关联VPC所在的region。 **取值范围：** 不涉及。 | 表9PageInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | next_marker | String | **参数解释：** 下一页的页面标识。 **取值范围：** 不涉及。 | | previous_marker | String | **参数解释：** 上一页的页面标识。 **取值范围：** 不涉及。 | | current_count | Integer | **参数解释：** 当前页返回的资源数量。 **取值范围：** 不涉及。 | **状态码：400** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | message | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：404** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | message | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：500** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | message | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 - 查询本账号创建的内网域名列表，每页返回10条。 ``` GET https://{Endpoint}/v2/zones?type=private&limit=10 ``` - 查询其他账号共享给本账号的内网域名列表，每页返回10条。 ``` GET https://{Endpoint}/v2/zones?type=private&limit=10&shared_status=sharedwithme ``` #### 响应示例 **状态码：200** - 查询本账号创建的内网域名列表响应示例。 ``` { "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 } } ``` - 查询其他账号共享给本账号的内网域名列表响应示例。 ``` { "links" : { "self" : "https://{Endpoint}/v2/zones" }, "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" } ], "page_info" : { "next_marker" : "ff8080825b8fc86c015b94bc6f8712c3", "previous_marker" : null, "current_count" : 1 } } ``` #### 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 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("")) .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()); } } } ``` - [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 = 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) ``` - [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.ListPrivateZonesRequest{} response, err := client.ListPrivateZones(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=ListPrivateZones)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询内网域名列表响应。 | | 400 | 接口错误响应。 | | 404 | 接口错误响应。 | | 500 | 接口错误响应。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dns/ErrorCode.html)。