API 文档
文档目录
服务与支持 API 文档 批量修改记录
批量修改记录

1. 接口描述

本接口 Batch.Record.Modify 批量修改记录。
接口请求地址:https://dnsapi.cn/Batch.Record.Modify
HTTP请求方式:POST

2. 请求参数

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见 公共请求参数 公共请求参数页面。

参数名 是否必须 参数描述
record_id 记录的ID,多个 record_id 用英文的逗号分割。
change 要修改的字段,可选值为 [“sub_domain”、”record_type”、”area”、”value”、”mx”、”ttl”、”status”] 中的某一个。
change_to 修改为,具体依赖 change 字段,必填参数。
value 要修改到的记录值,仅当 change 字段为 “record_type” 时为必填参数。
mx MX记录优先级,仅当修改为 MX 记录时为必填参数。

3. 响应代码

以下请求参数列表仅列出了此接口请求响应代码,除此接口请求响应代码外。还包含 共通返回码

响应码 描述
共通返回码【具体错误信息参见 message 字段】

4. 示例

  • 批量将多条记录修改为 CNAME 记录。
curl -X POST https://dnsapi.cn/Batch.Record.Modify -d ‘login_token=LOGIN_TOKEN&format=json&record_id=36,90,91&change=record_type&change_to=CNAME&value=dnsapi1.cn.’
  • 批量将多条记录暂停。
curl -X POST https://dnsapi.cn/Batch.Record.Modify -d ‘login_token=LOGIN_TOKEN&format=json&record_id=36,90,91&change=status&change_to=disable’

返回示例如下:

  • JSON:
{
    "status": {
        "code": "1",
        "message": "Action completed successful",
        "created_at": "2015-09-08 18:21:13"
    },
    "job_id": "409952",
    "detail": [
        {
            "domain_id": 92,
            "domain": "dnsapi1.cn",
            "err_msg": null,
            "status": "waiting",
            "operation": null,
            "records": [
                {
                    "record_id": "36",
                    "sub_domain": "bbs",
                    "area": "默认",
                    "record_type": "CNAME",
                    "ttl": "600",
                    "value": "bbs.dnsapi2.com.",
                    "enabled": "1",
                    "status": "waiting",
                    "err_msg": null,
                    "id": 0,
                    "operation": "edit"
                }
            ],
            "domain_grade": "D_Plus",
            "id": 0
        },
        {
            "domain_id": 171,
            "domain": "dnsapi1.cn",
            "err_msg": null,
            "status": "waiting",
            "operation": null,
            "records": [
                {
                    "record_id": "90",
                    "sub_domain": "www",
                    "area": "电信",
                    "record_type": "A",
                    "ttl": "3600",
                    "value": "11.11.22.22",
                    "enabled": "1",
                    "status": "waiting",
                    "err_msg": null,
                    "id": 0,
                    "operation": "edit"
                },
                {
                    "record_id": "91",
                    "sub_domain": "@",
                    "area": "电信",
                    "record_type": "MX",
                    "ttl": "3600",
                    "value": "61.144.40.92.",
                    "enabled": "1",
                    "status": "waiting",
                    "mx": "5",
                    "err_msg": null,
                    "id": 1,
                    "operation": "edit"
                }
            ],
            "domain_grade": "D_Free",
            "id": 1
        }
    ]
}
  • 字段说明:
  • job_id: 任务ID,批量操作为异步执行,拿到 job_id 说明批量操作已经成功加入到任务队列,可通过 Batch.Detail 接口异步去查询执行结果。
  • detail: 任务详情,仅将用户的输入补全,并非实际执行结果,开发者可以忽略该字段。
最近更新于 2020-09-08 11:17