获取域名筛选列表

最近更新时间:2024-03-12 01:26:34

我的收藏

1. 接口描述

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

获取域名筛选列表
备注:新添加的解析记录存在短暂的索引延迟,如果查询不到新增记录,请在 30 秒后重试

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDomainFilterList。
Version String 公共参数,本接口取值:2021-03-23。
Region String 公共参数,本接口不需要传递此参数。
Type String 根据域名分组类型获取域名。可取值为 ALL,MINE,SHARE,RECENT。
ALL:全部
MINE:我的域名
SHARE:共享给我的域名
RECENT:最近操作过的域名
示例值:ALL
Offset Integer 记录开始的偏移, 第一条记录为 0, 依次类推。默认值为 0。
示例值:0
Limit Integer 要获取的域名数量, 比如获取 20 个, 则为 20。默认值为 5000。如果账户中的域名数量超过了 5000, 将会强制分页并且只返回前 5000 条, 这时需要通过 Offset 和 Limit 参数去获取其它域名。
示例值:20
GroupId.N Array of Integer 根据域名分组 id 获取域名,可通过 DescribeDomain 或 DescribeDomainList 接口 GroupId 字段获取。
示例值:[1]
Keyword String 根据关键字获取域名。
示例值:qq
SortField String 排序字段。可取值为 NAME,STATUS,RECORDS,GRADE,UPDATED_ON。
NAME:域名名称
STATUS:域名状态
RECORDS:记录数量
GRADE:套餐等级
UPDATED_ON:更新时间
示例值:NAME
SortType String 排序类型,升序:ASC,降序:DESC。
示例值:ASC
Status.N Array of String 根据域名状态获取域名。可取值为 ENABLE,LOCK,PAUSE,SPAM。
ENABLE:正常
LOCK:锁定
PAUSE:暂停
SPAM:封禁
示例值:["ENABLE"]
Package.N Array of String 根据套餐获取域名,可通过 DescribeDomain 或 DescribeDomainList 接口 Grade 字段获取。
示例值:["DP_FREE"]
Remark String 根据备注信息获取域名。
示例值:备注
UpdatedAtBegin String 要获取域名的更新时间起始时间点,如 '2021-05-01 03:00:00'。
示例值:2021-05-01 03:00:00
UpdatedAtEnd String 要获取域名的更新时间终止时间点,如 '2021-05-10 20:00:00'。
示例值:2021-05-10 20:00:00
RecordCountBegin Integer 要获取域名的记录数查询区间起点。
示例值:10
RecordCountEnd Integer 要获取域名的记录数查询区间终点。
示例值:100
ProjectId Integer 项目ID
示例值:-1
Tags.N Array of TagItemFilter 标签过滤

3. 输出参数

参数名称 类型 描述
DomainCountInfo DomainCountInfo 列表页统计信息
DomainList Array of DomainListItem 域名列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取域名筛选列表参数示例

获取域名筛选列表

输入示例

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

{
    "Type": "ALL",
    "Offset": 0,
    "Limit": 1
}

输出示例

{
    "Response": {
        "DomainCountInfo": {
            "DomainTotal": 1,
            "AllTotal": 1,
            "MineTotal": 1,
            "ShareTotal": 1,
            "VipTotal": 1,
            "PauseTotal": 1,
            "ErrorTotal": 1,
            "LockTotal": 1,
            "SpamTotal": 1,
            "VipExpire": 1,
            "ShareOutTotal": 1,
            "GroupTotal": 1
        },
        "DomainList": [
            {
                "DomainId": 1,
                "Name": "abc",
                "Status": "abc",
                "TTL": 1,
                "CNAMESpeedup": "abc",
                "DNSStatus": "abc",
                "Grade": "abc",
                "GroupId": 1,
                "SearchEnginePush": "abc",
                "Remark": "abc",
                "Punycode": "abc",
                "EffectiveDNS": [
                    "abc"
                ],
                "GradeLevel": 1,
                "GradeTitle": "abc",
                "IsVip": "abc",
                "VipStartAt": "2020-09-22 00:00:00",
                "VipEndAt": "2020-09-22 00:00:00",
                "VipAutoRenew": "abc",
                "RecordCount": 1,
                "CreatedOn": "2020-09-22 00:00:00",
                "UpdatedOn": "2020-09-22 00:00:00",
                "Owner": "abc",
                "TagList": [
                    {
                        "TagKey": "abc",
                        "TagValue": "abc"
                    }
                ]
            }
        ],
        "RequestId": "abc"
    }
}

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 未授权操作。