更新时间:2026-01-08 GMT+08:00

创建内网Zone

功能介绍

创建单个内网Zone。

URI

POST /v2/zones

请求

  • 参数说明
    表1 请求样例的参数说明

    名称

    是否必选

    参数类型

    说明

    name

    String

    待创建的域名。

    • 若以“.”号结束,总长度不超过254个字符。
    • 若以非“.”号结束,总长度不超过253个字符。
    • 单个字符串不超过63个字符,字符串间以点号分隔。

    域名格式不区分大小写,系统会将输入的大写字母统一转换为小写。

    description

    String

    域名的描述信息。

    长度不超过255个字符。

    默认值为空。

    zone_type

    String

    域名类型。

    内网域名:域名仅被具体VPC内的主机访问。

    取值:private。

    email

    String

    管理该zone的管理员邮箱。

    默认值为售后服务邮箱。

    ttl

    Integer

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

    取值范围:1~2147483647

    默认值为300s。

    router

    Object

    Private zone关联的Router(VPC)信息,详细信息请参见表2

    tags

    Array of object

    资源标签。详细信息请参见表3

    默认值为空。

    enterprise_project_id

    String

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

    默认值为0。

    proxy_pattern

    String

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

    取值范围:

    • AUTHORITY:当前Zone不进行递归解析。
    • RECURSIVE:开启递归解析代理。
    表2 router对象参数说明

    名称

    是否必选

    参数类型

    说明

    router_id

    String

    Router(VPC)所属VPC的ID。

    router_region

    String

    Router(VPC)所在的region。

    如果为空,默认为token中project所在的region。

    表3 tags对象参数说明

    名称

    是否必选

    参数类型

    说明

    key

    String

    键。

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

    value

    String

    值。

    每个值最大长度43个unicode字符,可以为空字符串。

  • 请求样例
    创建一个内网域名,域名为“example.com”。
    POST https://{DNS_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"
            }
        ]
    }

响应

  • 要素说明
    表4 响应样例的要素说明

    名称

    参数类型

    说明

    id

    String

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

    name

    String

    zone名称。

    description

    String

    对zone的描述信息。

    email

    String

    管理该zone的管理员邮箱。

    zone_type

    String

    zone类型,内网(private)。

    ttl

    Integer

    该zone下SOA记录中的ttl值。

    取值范围:1~2147483647

    默认值为300s。

    serial

    Integer

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

    该参数暂未使用。

    status

    String

    资源状态。

    详细信息请参见资源状态

    record_num

    Integer

    该zone下的recordset个数。

    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

    Object

    指向当前资源或者其他资源的链接。

    当查询需要分页时,需要包含一个next链接指向下一页。

    详细信息请参见表5

    masters

    Array of strings

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

    目前暂未使用。

    router

    Object

    Private zone关联的Router(VPC)信息。详细信息请参考表6

    proxy_pattern

    String

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

    取值范围:

    • AUTHORITY:当前Zone不进行递归解析。
    • RECURSIVE:开启递归解析代理。
    表5 links参数说明

    名称

    参数类型

    说明

    self

    String

    当前资源的链接。

    next

    String

    下一页资源的链接。

    表6 router对象参数说明

    名称

    参数类型

    说明

    status

    String

    资源状态。

    详细信息请参见资源状态

    router_id

    String

    Router(VPC)的ID。

    router_region

    String

    Router(VPC)所在的region。

  • 响应样例
    {
        "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"
        }
    }
    

返回值

接口正常的返回值为2xx,例如200、202或者204。

返回值含义以及更多返回值请参考状态码