文档首页/ 云解析服务 DNS/ API参考/ API/ 公网域名检测/ 查询公网域名的网站域名 - ShowWebsiteRecordSet
更新时间:2025-12-25 GMT+08:00
分享

查询公网域名的网站域名 - ShowWebsiteRecordSet

功能介绍

查询公网域名的网站域名。

公网域名为全局资源,请选择“华北-北京四(cn-north-4)”区域调用。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v2.1/zones/{zone_id}/website-recordsets

表1 路径参数

参数

是否必选

参数类型

描述

zone_id

String

参数解释:

域名ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

参数解释:

分页查询时配置每页返回的资源个数。

约束限制:

不涉及。

取值范围:

0~500。

默认取值:

500

offset

Integer

参数解释:

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

约束限制:

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

取值范围:

0~2147483647。

默认取值:

0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

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

获取用户Token请参见获取用户Token

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

links

pageLink object

参数解释:

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

取值范围:

不涉及。

recordsets

Array of ListRecordSets objects

参数解释:

记录集列表信息。

取值范围:

不涉及。

metadata

metadata object

参数解释:

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

取值范围:

不涉及。

表5 ListRecordSets

参数

参数类型

描述

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

参数解释:

域名解析后的值。

取值范围:

不涉及。

create_at

String

参数解释:

记录集的创建时间。

格式:yyyy-MM-dd'T'HH:mm:ss.SSS。

取值范围:

不涉及。

update_at

String

参数解释:

记录集的最近一次修改时间。

格式:yyyy-MM-dd'T'HH:mm:ss.SSS。

取值范围:

不涉及。

status

String

参数解释:

记录集状态。

取值范围:

  • ACTIVE:正常

  • PENDING_CREATE:创建中

  • PENDING_UPDATE:更新中

  • PENDING_DELETE:删除中

  • PENDING_FREEZE:冻结中

  • FREEZE:冻结

  • ILLEGAL:违规冻结

  • POLICE:公安冻结

  • PENDING_DISABLE:暂停中

  • DISABLE:暂停

  • ERROR:失败

default

Boolean

参数解释:

标识是否由系统默认生成,系统默认生成的记录集不能删除。

取值范围:

不涉及。

project_id

String

参数解释:

该记录集所属的项目ID。

取值范围:

不涉及。

links

pageLink object

参数解释:

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

取值范围:

不涉及。

表7 metadata

参数

参数类型

描述

total_count

Integer

参数解释:

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

取值范围:

不涉及。

状态码:400

表8 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码。

取值范围:

不涉及。

message

String

参数解释:

错误描述。

取值范围:

不涉及。

状态码:500

表9 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码。

取值范围:

不涉及。

message

String

参数解释:

错误描述。

取值范围:

不涉及。

请求示例

响应示例

状态码:200

查询公网域名的网站域名响应。

{
  "links" : {
    "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/website-recordsets?limit=10&offset=0"
  },
  "recordsets" : [ {
    "name" : "example.com."
  }, {
    "name" : "www.example.com."
  }, {
    "name" : "test.example.com."
  } ],
  "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 ShowWebsiteRecordSetSolution {

    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();
        ShowWebsiteRecordSetRequest request = new ShowWebsiteRecordSetRequest();
        request.withZoneId("{zone_id}");
        try {
            ShowWebsiteRecordSetResponse response = client.showWebsiteRecordSet(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 = ShowWebsiteRecordSetRequest()
        request.zone_id = "{zone_id}"
        response = client.show_website_record_set(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.ShowWebsiteRecordSetRequest{}
	request.ZoneId = "{zone_id}"
	response, err := client.ShowWebsiteRecordSet(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

查询公网域名的网站域名响应。

400

Bad Request

500

Internal Server Error

错误码

请参见错误码

相关文档