更新时间:2022-01-25 GMT+08:00

修改Record Set

功能介绍

修改单个Record Set。

URI

PUT /v2/zones/{zone_id}/recordsets/{recordset_id}

参数说明请参见表1
表1 URI格式的参数说明

名称

是否必选

参数类型

说明

zone_id

String

所属zone的ID。

内网Zone ID可以通过查询内网Zone列表获取。

recordset_id

String

待修改recordset的ID。

可以通过查询单个Zone下Record Set列表获取。

请求

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

    名称

    是否必选

    参数类型

    说明

    name

    String

    域名,后缀需以zone name结束且为FQDN(即以“.”号结束的完整主机名)。

    当为公网域名时,子域名级别最多为5级。

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

    description

    String

    可选配置,对域名的描述。

    长度不超过255个字符。

    如果为空,表示维持原值。

    默认值为空。

    type

    String

    Record Set的类型。

    取值范围:A、AAAA、MX、CNAME、TXT、NS(仅限公网Zone)、SRV、PTR(仅限内网Zone)、CAA(仅限公网Zone)。

    取值范围:A、AAAA、MX、CNAME、TXT、SRV、PTR(仅限内网Zone)。

    详细信息请参见解析记录类型

    ttl

    Integer

    解析记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。

    如果您的服务地址经常更换,建议TTL值设置相对小些,反之,建议设置相对大些。

    取值范围:

    1~2147483647。

    如果为空,表示维持原值。

    默认值为空。

    records

    Array of strings

    解析记录的值。不同类型解析记录对应的值的规则不同。

    如Type为AAAA类型,Value是域名对应的IPv6地址列表。

  • 请求样例

    修改域名的记录集,域名的Zone ID为“2c9eb155587194ec01587224c9f90149”,Recordset ID为“2c9eb155587228570158722b6ac30007”。

    PUT https://{DNS_Endpoint}/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007
    • A类型
      {
          "description": "This is an example record set.",
          "ttl": 3600,
          "records": [
              "192.168.10.1",
              "192.168.10.2"
          ]
      }
    • AAAA类型
      {
          "description": "This is an example record set.",
          "ttl": 3600,
          "records": [
              "fe80:0:0:0:202:b3ff:fe1e:8329",
              "ff03:0db8:85a3:0:0:8a2e:0370:7334"
          ]
      }
    • MX类型
      {
          "description": "This is an example record set.",
          "ttl": 3600,
          "records": [
              "1 mail.example.com"
          ]
      }
    • CNAME类型
      {
          "description": "This is an example record set.",
          "ttl": 3600,
          "records": [
              "server1.example.com"
          ]
      }
    • TXT类型
      {
          "description": "This is an example record set.",
          "ttl": 300,
          "records": [
              "\"This host is used for sale.\""
          ]
      }
    • SRV类型
      {
          "description": "This is an example record set.",
          "ttl": 3600,
          "records": [
              "3 60 2176 sipserver.example.com.",
              "10 100 2176 sipserver.example.com."
          ]
      }
    • PTR类型
      {
          "description": "This is an example record set.",
          "ttl": 3600,
          "records": [
              "host.example.com."
      
          ]
      }
      

响应

  • 参数说明
    表3 响应样例的参数说明

    名称

    参数类型

    说明

    id

    String

    Record Set的ID。

    name

    String

    Record Set的名称。

    description

    String

    Record Set的描述信息。

    zone_id

    String

    托管该记录的zone_id。

    zone_name

    String

    托管该记录的zone_name。

    type

    String

    记录类型。

    取值范围:A、AAAA、MX、CNAME、TXT、SRV、PTR(仅限内网Zone)。

    详细信息请参见解析记录类型

    ttl

    Integer

    解析记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。

    如果您的服务地址经常更换,建议TTL值设置相对小些,反之,建议设置相对大些。

    records

    Array of strings

    域名解析后的值。

    create_at

    String

    创建时间。

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

    update_at

    String

    更新时间。

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

    status

    String

    资源状态。

    详细信息请参见资源状态

    default

    Boolean

    标识是否由系统默认生成,系统默认生成的Record Set不能删除。

    project_id

    String

    该Record Set所属的项目ID。

    links

    Object

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

    详细信息请参见表4

    表4 links参数说明

    名称

    参数类型

    说明

    self

    String

    当前资源的链接。

    next

    String

    下一页资源的链接。

  • 响应样例
    {
        "id": "2c9eb155587228570158722b6ac30007",
        "name": "www.example.com.",
        "description": "This is an example record set.",
        "type": "A",
        "ttl": 3600,
        "records": [
            "192.168.10.1",
            "192.168.10.2"
        ],
        "status": "PENDING_UPDATE",
        "links": {
            "self": "https://Endpoint/v2/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007"
        },
        "zone_id": "2c9eb155587194ec01587224c9f90149",
        "zone_name": "example.com.",
        "create_at": "2016-11-17T12:03:17.827",
        "update_at": "2016-11-17T12:56:03.827",
        "default": false,
        "project_id": "e55c6f3dc4e34c9f86353b664ae0e70c"
    }

返回值

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

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