Help Center/ Domain Name Service/ API Reference/ APIs/ Public Zone Check/ Querying Website Record Sets in a Public Zone
Updated on 2025-11-17 GMT+08:00

Querying Website Record Sets in a Public Zone

Function

This API is used to query website record sets in a public zone.

Public zones are global resources. Select the AP-Singapore (ap-southeast-3) region.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

zone_id

Yes

String

Definition

Zone ID

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Definition

The number of records returned on each page during pagination query.

Constraints

N/A

Range

0 to 500

Default Value

500

offset

No

Integer

Definition

The offset of pagination query. It specifies the number of rows or records to skip from the beginning of the result set before retrieving the desired data.

Constraints

If marker is not left blank, the query starts from the resource specified by marker and the offset does not take effect.

Range

0 to 2147483647

Default Value

0

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

The user token.

The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

For details about how to obtain a user token, seeObtaining a User Token.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

links

pageLink object

Definition

The link to the current page or other pages. When a response is broken into pages, a next link is provided to point to the next page.

Range

N/A

recordsets

Array of ListRecordSets objects

Definition

Record set list

Range

N/A

metadata

metadata object

Definition

Number of resources that meet the filter condition

Range

N/A

Table 5 ListRecordSets

Parameter

Type

Description

id

String

Definition

Record set ID

Range

N/A

name

String

Definition

Record set name

Range

N/A

description

String

Definition

The description of the record set.

Range

The value can contain a maximum of 255 characters.

zone_id

String

Definition

Zone ID of the record set

Range

N/A

zone_name

String

Definition

Zone name of the record set

Range

N/A

type

String

Definition

Record set type

Range

  • Public zones: The value can be A, AAAA, MX, CNAME, TXT, SRV, NS, SOA or CAA.

  • Private zones: The value can be A, AAAA, MX, CNAME, TXT, PTR, SRV, NS or SOA.

ttl

Integer

Definition

Record set caching duration (in seconds) on a local DNS server. The longer the duration is, the slower the update will be applied.

Range

1 to 2147483647

records

Array of strings

Definition

Record set value

Range

N/A

create_at

String

Definition

The time when the record set was created.

Format: yyyy-MM-dd'T'HH:mm:ss.SSS

Range

N/A

update_at

String

Definition

The time when the record set was last modified.

Format: yyyy-MM-dd'T'HH:mm:ss.SSS

Range

N/A

status

String

Definition

The status of the record set.

Range

  • ACTIVE: The zone is normal.

  • PENDING_CREATE: The zone is being created.

  • PENDING_UPDATE: The zone is being updated.

  • PENDING_DELETE: The zone is being deleted.

  • PENDING_FREEZE: The zone is being frozen.

  • FREEZE: The zone is frozen.

  • ILLEGAL: The zone is frozen due to abuse.

  • POLICE: The zone is frozen due to security reasons.

  • PENDING_DISABLE: The zone is being disabled.

  • DISABLE: The zone is disabled.

  • ERROR: The zone failed to be created.

default

Boolean

Definition

Whether the record set is created by default. A default record set cannot be deleted.

Range

N/A

project_id

String

Definition

ID of the project to which the record set belongs

Range

N/A

links

pageLink object

Definition

The link to the current page or other pages. When a response is broken into pages, a next link is provided to point to the next page.

Range

N/A

Table 7 metadata

Parameter

Type

Description

total_count

Integer

Definition

Number of resources that meet the filter criteria. The number is irrelevant to limit or offset.

Range

N/A

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Example Requests

None

Example Responses

Status code: 200

Querying website record sets in a public zone

{
  "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 Sample Code

The SDK sample code is as follows.

 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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Querying website record sets in a public zone

400

Bad Request

500

Internal Server Error

Error Codes

See Error Codes.