API 文档
文档目录
    加载中
服务与支持 API 文档 获取域名列表

获取域名列表

1. 接口描述

本接口 Domain.List 添加新域名。
接口请求地址:https://dnsapi.cn/Domain.List
HTTP请求方式:POST

2. 请求参数

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

参数名 是否必须 参数描述
type 域名分组类型, 默认为"all"。
offset 记录开始的偏移, 第一条记录为 0, 依次类推。
length 要获取的域名数量, 比如获取20个, 则为20。
group_id 分组ID, 获取指定分组的域名。可以通过获取域名分组获取 group_id。
keyword 搜索的关键字, 如果指定则只返回符合该关键字的域名。

域名分组类型, 包含以下类型:

  • all:所有域名。
  • mine:我的域名。
  • share:共享给我的域名。
  • ismark:星标域名。
  • pause:暂停域名。
  • vip:VIP 域名。
  • recent:最近操作过的域名。
  • share_out:我共享出去的域名。

注意:
如果账户中的域名数量超过了3000, 将会强制分页并且只返回前3000条, 这时需要通过 offset 和 length 参数去获取其它域名。

3. 响应代码

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

响应码 描述
6 记录开始的偏移无效。
7 共要获取的记录的数量无效。
9 没有任何域名。

4. 示例

curl -X POST https://dnsapi.cn/Domain.List -d 'login_token=LOGIN_TOKEN&format=json'

返回示例如下:

  • JSON:
{
    "status": {
        "code": "1",
        "message": "Action completed successful",
        "created_at": "2015-01-18 16:21:28"
    },
    "info": {
        "domain_total": 2,
        "all_total": 2,
        "mine_total": 2,
        "share_total": 0,
        "vip_total": 0,
        "ismark_total": 0,
        "pause_total": 0,
        "error_total": 2,
        "lock_total": 0,
        "spam_total": 0,
        "vip_expire": 0,
        "share_out_total": 0
    },
    "domains": [
        {
            "id": 2238269,
            "status": "enable",
            "grade": "D_Free",
            "group_id": "1",
            "searchengine_push": "yes",
            "is_mark": "no",
            "ttl": "300",
            "cname_speedup": "disable",
            "remark": "",
            "created_on": "2015-01-19 08:20:03",
            "updated_on": "2015-01-19 18:54:35",
            "punycode": "xn--vnqp08b.cn",
            "ext_status": "dnserror",
            "name": "我们.cn",
            "grade_title": "免费套餐",
            "grade_ns": [ 
                "ns3.dnsv3.com" ,
                "ns4.dnsv3.com" 
            ],
            "is_vip": "no",
            "owner": "api@dnspod.com",
            "records": "4",
            "vip_start_at": "2019-07-17 00:00:00",
            "vip_end_at": "2020-08-26 23:59:59",
            "vip_auto_renew": "default",
        },
        {
            "id": 10360095,
            "status": "enable",
            "grade": "DP_Free",
            "group_id": "1",
            "searchengine_push": "yes",
            "is_mark": "no",
            "ttl": "600",
            "cname_speedup": "disable",
            "remark": "",
            "created_on": "2014-11-25 16:56:31",
            "updated_on": "2015-01-19 16:56:31",
            "punycode": "usertest.com",
            "ext_status": "dnserror",
            "name": "usertest.com",
            "grade_title": "新免费套餐",
            "grade_ns": [ 
                "f1g1ns1.dnspod.net" ,
                "f1g1ns2.dnspod.net" 
            ],
            "is_vip": "no",
            "owner": "api@dnspod.com",
            "records": "2",
            "auth_to_anquanbao": true
        }
    ]
}
  • 字段说明:

  • info:

    • domain_total: 域名总数。
    • all_total: 域名总数。
    • mine_total: 自己创建的域名总数(不包括共享得到的域名)。
    • share_total: 共享得到的域名总数。
    • vip_total: VIP 域名总数。
    • ismark_total: 星标域名的总数。
    • pause_total: 暂停解析的域名总数。
    • error_total: DNS 设置错误的域名总数(包括未注册的和 NS 地址没有改到 DNSPod 的域名)。
    • lock_total: 已锁定的域名总数。
    • spam_total: 已被封禁的域名总数。
    • vip_expire: VIP 即将到期的域名总数(30天之内)。
    • share_out_total: 共享出去的域名总数。
  • domains:

  • id: 域名 ID, 即为 domain_id。

  • status: 域名状态:

    • “enable”: 正常。
    • “pause”: 已暂停解析。
    • “spam”: 已被封禁。
    • “lock”: 已被锁定。
  • grade: 域名等级:

    • “D_Free”: 旧免费套餐 (旧套餐)。
    • “D_Plus”: 个人豪华套餐 (旧套餐)。
    • “D_Extra”: 企业Ⅰ (旧套餐)。
    • “D_Expert” 企业Ⅱ (旧套餐)。
    • “D_Ultra”: 企业Ⅲ (旧套餐)。
    • “DP_Free” 免费套餐。
    • “DP_Plus”: 个人专业版。
    • “DP_Extra”: 企业创业版。
    • “DP_Expert”: 企业标准版。
    • “DP_Ultra”: 企业旗舰版。
  • grade_ns: 域名等级对应的ns服务器地址。

  • group_id: 域名分组 ID。

  • searchengine_push: 是否开启搜索引擎推送功能:

    • “yes”: 已开启。
    • “no”: 未开启。
  • is_mark: 是否设置域名星标:

    • “yes”: 已设置。
    • “no”: 未设置。
  • ttl: 域名默认的 TTL 值。

  • cname_speedup: CNAME 加速状态:

    • “enable”: 已启用。
    • “disable”: 已禁用。
  • remark: 域名备注。

  • created_on: 添加域名的时间。

  • updated_on: 域名最后修改时间。

  • punycode: 使用 punycode 转码之后的域名。

  • ext_status: 域名扩展的状态:

    • “notexist”: 域名没有注册。
    • “dnserror”: DNS 设置错误。
    • “”: 正常。
  • name: 域名。

  • grade_title: 域名等级(中文说明)。

  • is_vip: 是否是VIP 等级:

    • “yes”: 是 VIP。
    • “no”: 不是 VIP。
  • owner: 域名所有者。

  • records: 域名下记录总条数。

最近更新于 2020-10-14 19:38