Creating a Private Zone
Function
This API is used to create a private zone.
Calling Method
For details, see Calling APIs.
URI
POST /v2/zones
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. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Zone to be created |
description |
No |
String |
Zone description |
zone_type |
Yes |
String |
Zone type. The value is private. |
|
No |
String |
Email address of the administrator managing the zone |
ttl |
No |
Integer |
Caching duration of the SOA record set (in seconds) |
router |
Yes |
Router object |
VPC to be disassociated |
proxy_pattern |
No |
String |
Recursive resolution proxy mode for subdomain names of private zones. Value options:
|
tags |
No |
Array of tag objects |
Resource tag |
enterprise_project_id |
No |
String |
ID of the enterprise project associated with the zone. The value contains a maximum of 36 characters. The default value is 0. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
router_id |
Yes |
String |
ID of the VPC associated with the zone |
router_region |
No |
String |
Region of the VPC |
status |
No |
String |
Resource status |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
key |
Yes |
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 |
No |
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. |
Response Parameters
Status code: 202
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. This parameter is reserved. |
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. The UTC time format is YYYY-MM-DDTHH:MM:SSZ. |
updated_at |
String |
Time when the zone was updated. The UTC time format is YYYY-MM-DDTHH:MM:SSZ. |
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. |
masters |
Array of strings |
Master DNS servers, from which the slave servers get DNS information |
router |
RouterWithStatus object |
List of VPC associated with the zone |
Parameter |
Type |
Description |
---|---|---|
self |
String |
Link to the current resource |
next |
String |
Link to the next page |
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 Minimum: 8 Maximum: 36 |
message |
String |
Description Minimum: 2 Maximum: 512 |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code Minimum: 8 Maximum: 36 |
message |
String |
Description Minimum: 2 Maximum: 512 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code Minimum: 8 Maximum: 36 |
message |
String |
Description Minimum: 2 Maximum: 512 |
Example Requests
Creating a private zone and setting the recursive resolution proxy mode to AUTHORITY for subdomains
POST https://{endpoint}/v2/zones { "name" : "example.com.", "description" : "This is an example zone.", "zone_type" : "private", "email" : "xx@example.org", "router" : { "router_id" : "19664294-0bf6-4271-ad3a-94b8c79c6558", "router_region" : "xx" }, "proxy_pattern" : "AUTHORITY", "tags" : [ { "key" : "key1", "value" : "value1" } ] }
Example Responses
Status code: 202
Response to the request for creating a private zone
{ "id" : "ff8080825b8fc86c015b94bc6f8712c3", "name" : "example.com.", "description" : "This is an example zone.", "email" : "xx@example.com", "ttl" : 300, "serial" : 1, "masters" : [ ], "status" : "PENDING_CREATE", "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" : null, "record_num" : 0, "proxy_pattern" : "AUTHORITY", "router" : { "status" : "PENDING_CREATE", "router_id" : "19664294-0bf6-4271-ad3a-94b8c79c6558", "router_region" : "xx" } }
SDK Sample Code
The SDK sample code is as follows.
Creating a private zone and setting the recursive resolution proxy mode to AUTHORITY for subdomains
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 58 59 60 61 62 63 64 65 |
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.*; import java.util.List; import java.util.ArrayList; public class CreatePrivateZoneSolution { 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(); CreatePrivateZoneRequest request = new CreatePrivateZoneRequest(); CreatePrivateZoneReq body = new CreatePrivateZoneReq(); List<Tag> listbodyTags = new ArrayList<>(); listbodyTags.add( new Tag() .withKey("key1") .withValue("value1") ); Router routerbody = new Router(); routerbody.withRouterId("19664294-0bf6-4271-ad3a-94b8c79c6558") .withRouterRegion("xx"); body.withTags(listbodyTags); body.withProxyPattern("AUTHORITY"); body.withRouter(routerbody); body.withEmail("xx@example.org"); body.withZoneType("private"); body.withDescription("This is an example zone."); body.withName("example.com."); request.withBody(body); try { CreatePrivateZoneResponse response = client.createPrivateZone(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()); } } } |
Creating a private zone and setting the recursive resolution proxy mode to AUTHORITY for subdomains
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 |
# 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 = CreatePrivateZoneRequest() listTagsbody = [ Tag( key="key1", value="value1" ) ] routerbody = Router( router_id="19664294-0bf6-4271-ad3a-94b8c79c6558", router_region="xx" ) request.body = CreatePrivateZoneReq( tags=listTagsbody, proxy_pattern="AUTHORITY", router=routerbody, email="xx@example.org", zone_type="private", description="This is an example zone.", name="example.com." ) response = client.create_private_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) |
Creating a private zone and setting the recursive resolution proxy mode to AUTHORITY for subdomains
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 58 59 |
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.CreatePrivateZoneRequest{} valueTags:= "value1" var listTagsbody = []model.Tag{ { Key: "key1", Value: &valueTags, }, } routerRegionRouter:= "xx" routerbody := &model.Router{ RouterId: "19664294-0bf6-4271-ad3a-94b8c79c6558", RouterRegion: &routerRegionRouter, } proxyPatternCreatePrivateZoneReq:= "AUTHORITY" emailCreatePrivateZoneReq:= "xx@example.org" descriptionCreatePrivateZoneReq:= "This is an example zone." request.Body = &model.CreatePrivateZoneReq{ Tags: &listTagsbody, ProxyPattern: &proxyPatternCreatePrivateZoneReq, Router: routerbody, Email: &emailCreatePrivateZoneReq, ZoneType: "private", Description: &descriptionCreatePrivateZoneReq, Name: "example.com.", } response, err := client.CreatePrivateZone(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 |
---|---|
202 |
Response to the request for creating a private zone |
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