有奖调研

获取域名列表

最近更新时间:2021-05-31 08:00:14

我的收藏

1. 接口描述

接口请求域名: dnspod.tencentcloudapi.com 。

获取域名列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDomainList。
Version String 公共参数,本接口取值:2021-03-23。
Region String 公共参数,本接口不需要传递此参数。
Type String 域名分组类型,默认为ALL。可取值为ALL,MINE,SHARE,ISMARK,PAUSE,VIP,RECENT,SHARE_OUT。
Offset Integer 记录开始的偏移, 第一条记录为 0, 依次类推。默认值为0。
Limit Integer 要获取的域名数量, 比如获取20个, 则为20。默认值为3000。
GroupId Integer 分组ID, 获取指定分组的域名
Keyword String 根据关键字搜索域名

3. 输出参数

参数名称 类型 描述
DomainCountInfo DomainCountInfo 列表页统计信息
DomainList Array of DomainListItem 域名列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取域名列表

输入示例

POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDomainList
<公共请求参数>

{
    "Type": "xx",
    "Keyword": "xx",
    "Limit": 2,
    "Offset": 0,
    "GroupId": 1
}

输出示例

{
  "Response": {
    "RequestId": "561cdfcb-37a6-47de-b3c5-2b038e2c2276",
    "DomainCountInfo": {
      "DomainTotal": 4,
      "AllTotal": 4,
      "MineTotal": 4,
      "ShareTotal": 0,
      "VipTotal": 1,
      "PauseTotal": 0,
      "ErrorTotal": 4,
      "LockTotal": 0,
      "SpamTotal": 0,
      "VipExpire": 0,
      "ShareOutTotal": 0,
      "GroupTotal": 3
    },
    "DomainList": [
      {
        "TTL": 600,
        "CNAMESpeedup": "DISABLE",
        "DNSStatus": "DNSERROR",
        "DomainId": 12609493,
        "Status": "ENABLE",
        "Grade": "DP_ULTRA",
        "GroupId": "1",
        "Remark": "",
        "CreatedOn": "2020-05-21 16:08:29",
        "UpdatedOn": "2021-04-01 18:09:58",
        "Punycode": "shenhailong.club",
        "Name": "shenhailong.club",
        "GradeLevel": 10,
        "GradeTitle": "企业旗舰版",
        "IsVip": "YES",
        "Owner": "qcloud_uin_100000012799@qcloud.com",
        "VipStartAt": "0000-00-00 00:00:00",
        "VipEndAt": "0000-00-00 00:00:00",
        "VipAutoRenew": "NO",
        "SearchEnginePush": "NO",
        "RecordCount": 6,
        "EffectiveDNS": [
          "ns3.dnsv5.com",
          "ns4.dnsv5.com"
        ]
      },
      {
        "TTL": 600,
        "CNAMESpeedup": "DISABLE",
        "DNSStatus": "DNSERROR",
        "DomainId": 12610063,
        "Status": "ENABLE",
        "Grade": "DP_FREE",
        "GroupId": "1",
        "Remark": "",
        "CreatedOn": "2020-08-18 17:52:30",
        "UpdatedOn": "2020-08-18 17:52:30",
        "Punycode": "shenhailong.xn--fiqs8s",
        "Name": "shenhailong.中国",
        "GradeLevel": 2,
        "GradeTitle": "免费版",
        "IsVip": "NO",
        "Owner": "qcloud_uin_100000012799@qcloud.com",
        "VipStartAt": "0000-00-00 00:00:00",
        "VipEndAt": "0000-00-00 00:00:00",
        "VipAutoRenew": "NO",
        "SearchEnginePush": "NO",
        "RecordCount": 2,
        "EffectiveDNS": [
          "f1g1ns1.dnspod.net",
          "f1g1ns2.dnspod.net"
        ]
      }
    ]
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
FailedOperation.NotRealNamedUser 未实名认证用户,请先完成实名认证再操作。
FailedOperation.UnknowError 操作未响应,请稍后重试。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.GroupIdInvalid 分组编号不正确。
InvalidParameter.OffsetInvalid 分页起始数量错误。
InvalidParameter.OperateFailed 操作失败,请稍候再试。
InvalidParameter.ResultMoreThan500 搜索结果大于500条,请增加关键字。
InvalidParameterValue.LimitInvalid 分页长度数量错误。
OperationDenied.AccessDenied 您没有权限执行此操作。
RequestLimitExceeded 请求的次数超过了频率限制。
RequestLimitExceeded.RequestLimitExceeded API请求次数超出限制。
UnauthorizedOperation 未授权操作。
目录