Querying Private Zones
Function
This API is used to query private zones.
Calling Method
For details, see Calling APIs.
URI
GET /v2/zones
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
type |
Yes |
String |
Zone type. The value is private. |
limit |
No |
Integer |
Number of resources on each page. The value ranges from 0 to 500. Commonly used values are 10, 20, and 50, and the default value is 500. |
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. |
offset |
No |
Integer |
Start offset of the pagination query. The query will start from the next resource of the offset value. The value ranges from 0 to 2147483647, and 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 |
name |
No |
Array of strings |
Zone name |
status |
No |
String |
Resource status |
search_mode |
No |
String |
Search mode.
|
enterprise_project_id |
No |
String |
ID of the enterprise project associated with the zone. The value contains a maximum of 36 characters. It is set to 0 by default. |
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. |
metadata |
metadata object |
Number of resources that meet the query condition |
zones |
Array of PrivateZoneResp objects |
Zone list |
Parameter |
Type |
Description |
---|---|---|
total_count |
Integer |
Number of resources that meet the filter criteria. The number is irrelevant to limit or offset. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Zone ID, which is a UUID used to identify the zone |
name |
String |
Zone name |
description |
String |
Zone description |
|
String |
Email address of the administrator managing the zone |
zone_type |
String |
Zone type. The value is private. |
ttl |
Integer |
TTL value of the SOA record set in the zone |
serial |
Integer |
Sequence number used to identify zone file changes in the SOA record set of the zone. The sequence number is used for synchronization between the master and slave nodes. |
status |
String |
Resource status |
record_num |
Integer |
Number of record sets in the zone |
proxy_pattern |
String |
Recursive resolution proxy mode for subdomain names of private zones. Value options:
|
pool_id |
String |
Pool ID of the zone, which is assigned by the system |
project_id |
String |
Project ID of the zone |
created_at |
String |
Time when the zone was created |
updated_at |
String |
Time when the zone was updated |
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. |
tags |
Array of tag objects |
Resource tag |
masters |
Array of strings |
Master DNS servers, from which the slave servers get DNS information |
routers |
Array of RouterWithStatus objects |
List of VPCs associated with the zone |
enterprise_project_id |
String |
ID of the enterprise project associated with the zone. The value contains a maximum of 36 characters. |
Parameter |
Type |
Description |
---|---|---|
self |
String |
Link to the current resource |
next |
String |
Link to the next page |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key. A key can contain up to 36 Unicode characters. It cannot be left blank. A tag value cannot contain special characters (=*<>,|/) or start or end with spaces. |
value |
String |
Tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. A tag value cannot contain special characters (=*<>,|/) or start or end with spaces. |
Parameter |
Type |
Description |
---|---|---|
status |
String |
Resource status |
router_id |
String |
ID of the VPC associated with the zone |
router_region |
String |
Region of the VPC |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code |
message |
String |
Description |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code |
message |
String |
Description |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code |
message |
String |
Description |
Example Requests
None
Example Responses
Status code: 200
Response to the request for querying private zones
{ "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 } }
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 |
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("<YOUR REGION>")) .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()); } } } |
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 |
# 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 = 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) |
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 |
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.ListPrivateZonesRequest{} response, err := client.ListPrivateZones(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 private zones |
400 |
Error response |
404 |
Error response |
500 |
Error response |
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