云解析服务 DNS云解析服务 DNS

更新时间:2021/06/16 GMT+08:00
分享

创建公网Zone

功能介绍

创建单个公网Zone。

URI

POST /v2/zones

请求

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

    名称

    是否必选

    参数类型

    说明

    name

    String

    从域名注册商处获得的授权域名。

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

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

    description

    String

    域名的描述信息。长度不超过255个字符。

    默认值为空。

    zone_type

    String

    域名类型,包括公网域名和内网域名。

    • 公网域名(public):域名可以被internet上的主机访问。
    • 内网域名(private):域名仅被具体VPC内的主机访问。

    取值范围:public、private。

    如果为空,则默认为public。创建内网域名,请参见创建内网Zone

    email

    String

    管理该zone的管理员邮箱。

    默认值为售后服务邮箱。

    ttl

    Integer

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

    取值范围:1~2147483647。

    默认值为300s。

    tags

    Array of object

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

    默认值为空。

    enterprise_project_id

    String

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

    默认值为0。

    表2 tags对象参数说明

    名称

    是否必选

    参数类型

    说明

    key

    String

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

    value

    String

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

  • 请求样例
    创建一个公网Zone,域名为“example.com”。
    POST https://{DNS_Endpoint}/v2/zones
    {
        "name": "example.com.",
        "description": "This is an example zone.",
        "zone_type": "public",
        "email": "xx@example.org",
        "ttl": 300,
        "tags": [
            {
              "key": "key1",
              "value": "value1"
            }
        ]
    }

响应

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

    名称

    参数类型

    说明

    id

    String

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

    name

    String

    zone名称。

    description

    String

    对zone的描述信息。

    email

    String

    管理该zone的管理员邮箱。

    zone_type

    String

    zone类型,公网(public)或者内网(private)。

    ttl

    Integer

    该zone下SOA记录中的ttl值。

    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链接指向下一页。

    详细信息请参见表4

    enterprise_project_id

    String

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

    masters

    Array of strings

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

    目前暂未使用。

    表4 links对象参数说明

    名称

    参数类型

    说明

    self

    String

    当前资源的链接。

    next

    String

    下一页资源的链接。

  • 响应样例
    {
        "id": "2c9eb155587194ec01587224c9f90149",
        "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/2c9eb155587194ec01587224c9f90149"
        },
        "pool_id": "00000000570e54ee01570e9939b20019",
        "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c",
        "zone_type": "public",
        "created_at": "2016-11-17T11:56:03.439",
        "updated_at": null,
        "record_num": 0
    }
    

返回值

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

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

分享:

    相关文档

    相关产品