更新时间:2025-07-31 GMT+08:00
分享

创建内网域名

功能介绍

内网域名是指在VPC中生效的域名,内网域名创建后,用户可以将其与私网IP地址相关联,为云服务提供VPC内的内网域名解析服务。

调用方法

请参见如何调用API

URI

POST /v2/zones

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

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

获取用户Token请参见获取用户Token

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释:

域名。

约束限制:

不涉及。

取值范围:

由多个以点分隔的字符串组成,可包含字母、数字、汉字、中划线,中划线不能在开头或末尾,单个字符串不超过63个字符,域名总长度不超过254个字符。

默认取值:

不涉及。

description

String

参数解释:

域名的描述信息。

约束限制:

不涉及。

取值范围:

长度不超过255个字符。

默认取值:

不涉及。

zone_type

String

参数解释:

域名类型。

约束限制:

不涉及。

取值范围:

private:内网域名。

默认取值:

不涉及。

email

String

参数解释:

管理该域名的管理员邮箱,用于生成该域名的SOA记录。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

ttl

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

1~2147483647。

默认取值:

300

router

Router object

参数解释:

需要关联的Router(VPC)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

proxy_pattern

String

参数解释:

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

约束限制:

不涉及。

取值范围:

  • AUTHORITY:当前域名未开启递归解析代理

  • RECURSIVE:当前域名已开启递归解析代理

默认取值:

AUTHORITY。

tags

Array of tag objects

参数解释:

资源标签。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

enterprise_project_id

String

参数解释:

域名所属的企业项目ID。可以使用该字段过滤企业项目下的域名。

约束限制:

不涉及。

取值范围:

最大长度36字节,带“-”连字符的UUID格式,或者是字符串“0”。“0”表示默认企业项目。

默认取值:

0

表3 Router

参数

是否必选

参数类型

描述

router_id

String

关联VPC的ID。

router_region

String

关联VPC所在的region。

status

String

资源状态。

表4 tag

参数

是否必选

参数类型

描述

key

String

参数解释:

标签键。

取值范围:

  • 不能为空。

  • 对于同一资源键的取值唯一。

  • 长度不超过128个字符。

  • 取值可以包含任意语种字母、数字、空格,以及_ . : = + - @特殊字符,但首尾不能含有空格,不能以_sys_开头。

value

String

参数解释:

标签值。

取值范围:

  • 可以为空。

  • 长度不超过255个字符。

  • 取值可以包含任意语种字母、数字、空格,以及_ . : / = + - @特殊字符。

响应参数

状态码:202

表5 响应Body参数

参数

参数类型

描述

id

String

参数解释:

域名的ID,UUID形式的一个资源标识。

取值范围:

不涉及。

name

String

参数解释:

域名。

取值范围:

不涉及。

description

String

参数解释:

域名的描述信息。

取值范围:

长度不超过255个字符。

email

String

参数解释:

管理该域名的管理员邮箱,用于生成该域名的SOA记录。

取值范围:

不涉及。

zone_type

String

参数解释:

域名类型。

取值范围:

private:内网域名。

ttl

Integer

参数解释:

该域名下SOA记录中的有效缓存时间,以秒为单位。

取值范围:

1~2147483647。

serial

Integer

参数解释:

该域名下SOA记录中用于标识域名文件变更的序列值,用于主从节点同步。

该参数暂未使用。

取值范围:

不涉及。

status

String

参数解释:

内网域名状态。

取值范围:

  • ACTIVE:正常

  • PENDING_CREATE:创建中

  • DISABLE:暂停

record_num

Integer

参数解释:

该域名下的记录集个数。

取值范围:

不涉及。

proxy_pattern

String

参数解释:

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

取值范围:

  • AUTHORITY:当前域名未开启递归解析代理

  • RECURSIVE:当前域名已开启递归解析代理

pool_id

String

参数解释:

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

取值范围:

不涉及。

project_id

String

参数解释:

域名所属的项目ID。

取值范围:

不涉及。

created_at

String

参数解释:

域名的创建时间。

格式:yyyy-MM-dd'T'HH:mm:ss.SSS。

取值范围:

不涉及。

updated_at

String

参数解释:

域名的最近一次修改时间。

格式:yyyy-MM-dd'T'HH:mm:ss.SSS。

取值范围:

不涉及。

links

pageLink object

参数解释:

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

取值范围:

不涉及。

masters

Array of strings

参数解释:

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

取值范围:

不涉及。

router

RouterWithStatus object

参数解释:

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

取值范围:

不涉及。

表7 RouterWithStatus

参数

参数类型

描述

status

String

参数解释:

关联VPC的状态。

取值范围:

不涉及。

router_id

String

参数解释:

关联VPC的ID。

取值范围:

不涉及。

router_region

String

参数解释:

关联VPC所在的region。

取值范围:

不涉及。

状态码:400

表8 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码。

取值范围:

不涉及。

message

String

参数解释:

错误描述。

取值范围:

不涉及。

状态码:404

表9 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码。

取值范围:

不涉及。

message

String

参数解释:

错误描述。

取值范围:

不涉及。

状态码:500

表10 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码。

取值范围:

不涉及。

message

String

参数解释:

错误描述。

取值范围:

不涉及。

请求示例

创建一个内网域名,子域名递归解析代理模式设置为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

创建内网域名响应。

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

创建内网域名响应。

400

接口错误响应。

404

接口错误响应。

500

接口错误响应。

错误码

请参见错误码

相关文档