更新时间:2024-07-25 GMT+08:00

创建单个内网Zone

功能介绍

创建单个内网Zone

调用方法

请参见如何调用API

URI

POST /v2/zones

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

待创建的域名。

description

String

域名的描述信息。

zone_type

String

域名类型。取值:private。

email

String

管理该zone的管理员邮箱。

ttl

Integer

用于填写默认生成的SOA记录中有效缓存时间,以秒为单位。

router

Router object

需要关联的Router(VPC)。

proxy_pattern

String

内网Zone的子域名递归解析代理模式。

取值范围:

AUTHORITY:当前Zone未开启递归解析代理 RECURSIVE:当前Zone已开启递归解析代理

tags

Array of tag objects

资源标签。

enterprise_project_id

String

域名关联的企业项目ID,长度不超过36个字符。 默认值为0。

表3 Router

参数

是否必选

参数类型

描述

router_id

String

关联VPC的ID。

router_region

String

关联VPC所在的region。

status

String

资源状态。

表4 tag

参数

是否必选

参数类型

描述

key

String

键。最大长度36个unicode字符。 key不能为空。不能包含“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”,且首尾字符不能为空格。

value

String

值。每个值最大长度43个unicode字符,可以为空字符串。 不能包含“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”,且首尾字符不能为空格。

响应参数

状态码: 202

表5 响应Body参数

参数

参数类型

描述

id

String

zone的ID,uuid形式的一个资源标识。

name

String

zone名称。

description

String

对zone的描述信息。

email

String

管理该zone的管理员邮箱。

zone_type

String

zone类型,内网(private)。

ttl

Integer

该zone下SOA记录中的ttl值。

serial

Integer

该zone下SOA记录中用于标识zone文件变更的序列值,用于主从节点同步。 该参数暂未使用。

status

String

资源状态。

record_num

Integer

该zone下的recordset个数。

proxy_pattern

String

内网Zone的子域名递归解析代理模式。

取值范围:

AUTHORITY:当前Zone未开启递归解析代理 RECURSIVE:当前Zone已开启递归解析代理

pool_id

String

托管该zone的pool,由系统分配。

project_id

String

zone所属的项目ID。

created_at

String

创建时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ

updated_at

String

更新时间。 采用UTC时间格式,格式为:YYYY-MM-DDTHH:MM:SSZ

links

pageLink object

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

masters

Array of strings

主从模式中,从DNS服务器获取DNS信息。

router

RouterWithStatus object

与该zone关联的Router(VPC)列表。

表7 RouterWithStatus

参数

参数类型

描述

status

String

资源状态。

router_id

String

关联VPC的ID。

router_region

String

关联VPC所在的region。

状态码: 400

表8 响应Body参数

参数

参数类型

描述

code

String

错误码

最小长度:8

最大长度:36

message

String

错误描述

最小长度:2

最大长度:512

状态码: 404

表9 响应Body参数

参数

参数类型

描述

code

String

错误码

最小长度:8

最大长度:36

message

String

错误描述

最小长度:2

最大长度:512

状态码: 500

表10 响应Body参数

参数

参数类型

描述

code

String

错误码

最小长度:8

最大长度:36

message

String

错误描述

最小长度:2

最大长度:512

请求示例

创建一个内网域名,子域名递归解析代理模式设置为AUTHORITY。

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"
  } ]
}

响应示例

状态码: 202

创建单个内网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代码示例

SDK代码示例如下。

创建一个内网域名,子域名递归解析代理模式设置为AUTHORITY。

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

创建一个内网域名,子域名递归解析代理模式设置为AUTHORITY。

 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
# 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 = 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)

创建一个内网域名,子域名递归解析代理模式设置为AUTHORITY。

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

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

状态码

状态码

描述

202

创建单个内网Zone响应。

400

接口错误响应。

404

接口错误响应。

500

接口错误响应。

错误码

请参见错误码