Querying Record Sets in a Zone
Function
This API is used to query record sets in a zone.
Calling Method
For details, see Calling APIs.
URI
GET /v2/zones/{zone_id}/recordsets
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
zone_id |
Yes |
String |
Zone ID Minimum: 32 Maximum: 36 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
search_mode |
No |
String |
Search mode. The options are as follows:
|
marker |
No |
String |
Start resource ID at the beginning for paging query. If the parameter is left blank, only resources on the first page are queried. This parameter is left empty by default. |
limit |
No |
Integer |
Number of resources on each page. The value ranges from 0 to 500. Commonly used values are 10, 20, and 50. The default value is 500. |
offset |
No |
Integer |
Start offset of pagination query. The query will start from the next resource of the offset value. The value ranges from 0 to 2147483647. The default value is 0. If marker is not left blank, the query starts from the resource specified by marker. |
tags |
No |
String |
Resource tag. The format is as follows: key1,value1|key2,value2. Multiple tags are separated by vertical bar (|). The key and value of each tag are separated by comma (,). |
status |
No |
String |
Status of the record set to be queried. The value can be ACTIVE, ERROR, DISABLE, FREEZE, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE. |
type |
No |
String |
Record set type.Public zones: The value can be A, AAAA, MX, CNAME, TXT, NS, SRV or CAA.Private zones: The value can be A, AAAA, MX, CNAME, TXT, or SRV. |
name |
No |
String |
Name of the record set to be queried. Fuzzy search will work. It is left blank by default. |
id |
No |
String |
ID of the record set to be queried. Fuzzy search will work. It is left blank by default. |
sort_key |
No |
String |
Sorting field of the record sets in the list. Value options:
The default value is left blank, indicating that the record sets are not sorted. |
sort_dir |
No |
String |
Sorting order of the record sets in the list. Value options:
The default value is left blank, indicating that the record sets are not sorted. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
links |
pageLink object |
Link of the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. |
recordsets |
Array of ListRecordSets objects |
Record set list |
metadata |
metadata object |
Number of resources that meet the query condition |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Record set ID |
name |
String |
Record set name |
description |
String |
Record set description |
zone_id |
String |
Zone ID of the record set |
zone_name |
String |
Zone name of the record set |
type |
String |
Record set type |
ttl |
Integer |
Record set caching duration (in seconds) on a local DNS server. The longer the duration is, the slower the update takes effect. |
records |
Array of strings |
Record set value |
create_at |
String |
Time when the record set was created |
update_at |
String |
Time when the record set was updated |
status |
String |
Resource status |
default |
Boolean |
Whether the record set is generated by the system. A system-generated record set cannot be deleted. |
project_id |
String |
Project ID of the record set |
links |
pageLink object |
Link of the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. |
Example Requests
None
Example Responses
Status code: 200
Response to the request for querying record sets in a zone
{ "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 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 47 48 49 50 51 52 53 54 55 56 |
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.withSearchMode("<search_mode>"); request.withMarker("<marker>"); request.withLimit(<limit>); request.withOffset(<offset>); request.withTags("<tags>"); request.withStatus("<status>"); request.withType("<type>"); request.withName("<name>"); request.withId("<id>"); request.withSortKey("<sort_key>"); request.withSortDir("<sort_dir>"); 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 32 33 34 35 36 37 38 39 40 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("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.search_mode = "<search_mode>" request.marker = "<marker>" request.limit = <limit> request.offset = <offset> request.tags = "<tags>" request.status = "<status>" request.type = "<type>" request.name = "<name>" request.id = "<id>" request.sort_key = "<sort_key>" request.sort_dir = "<sort_dir>" 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 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
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{} searchModeRequest:= "<search_mode>" request.SearchMode = &searchModeRequest markerRequest:= "<marker>" request.Marker = &markerRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest tagsRequest:= "<tags>" request.Tags = &tagsRequest statusRequest:= "<status>" request.Status = &statusRequest typeRequest:= "<type>" request.Type = &typeRequest nameRequest:= "<name>" request.Name = &nameRequest idRequest:= "<id>" request.Id = &idRequest sortKeyRequest:= "<sort_key>" request.SortKey = &sortKeyRequest sortDirRequest:= "<sort_dir>" request.SortDir = &sortDirRequest response, err := client.ListRecordSetsByZone(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 |
Response to the request for querying record sets in a zone |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot