1. 接口描述
接口请求域名: dnspod.tencentcloudapi.com 。
获取某个域名下的解析记录列表
备注:
- 新添加的解析记录存在短暂的索引延迟,如果查询不到新增记录,请在 30 秒后重试
- API获取的记录总条数会比控制台多2条,原因是: 为了防止用户误操作导致解析服务不可用,对2021-10-29 14:24:26之后添加的域名,在控制台都不显示这2条NS记录。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRecordList。 |
Version | 是 | String | 公共参数,本接口取值:2021-03-23。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Domain | 是 | String | 要获取的解析记录所属的域名 示例值:shenjianing.com |
DomainId | 否 | Integer | 要获取的解析记录所属的域名Id,如果传了DomainId,系统将会忽略Domain参数。 可以通过接口DescribeDomainList查到所有的Domain以及DomainId 示例值:81345824 |
Subdomain | 否 | String | 解析记录的主机头,如果传了此参数,则只会返回此主机头对应的解析记录 示例值:www |
RecordType | 否 | String | 获取某种类型的解析记录,如 A,CNAME,NS,AAAA,显性URL,隐性URL,CAA,SPF等 示例值:A |
RecordLine | 否 | String | 获取某条线路名称的解析记录。可以通过接口DescribeRecordLineList查看当前域名允许的线路信息 示例值:默认 |
RecordLineId | 否 | String | 获取某个线路Id对应的解析记录,如果传RecordLineId,系统会忽略RecordLine参数。可以通过接口DescribeRecordLineList查看当前域名允许的线路信息 示例值:0 |
GroupId | 否 | Integer | 获取某个分组下的解析记录时,传这个分组Id。 示例值:23 |
Keyword | 否 | String | 通过关键字搜索解析记录,当前支持搜索主机头和记录值 示例值:book |
SortField | 否 | String | 排序字段,支持 name,line,type,value,weight,mx,ttl,updated_on 几个字段。 示例值:type |
SortType | 否 | String | 排序方式,正序:ASC,逆序:DESC。默认值为ASC。 示例值:asc |
Offset | 否 | Integer | 偏移量,默认值为0。 示例值:0 |
Limit | 否 | Integer | 限制数量,当前Limit最大支持3000。默认值为100。 示例值:100 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RecordCountInfo | RecordCountInfo | 记录的数量统计信息 |
RecordList | Array of RecordListItem | 获取的记录列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询域名的解析记录
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRecordList
<公共请求参数>
{
"Offset": 0,
"Limit": 2,
"Domain": "shenjianing.com",
"DomainId": 123,
"Subdomain": "www",
"Keyword": "dnspod",
"RecordType": "NS",
"RecordLine": "默认",
"RecordLineId": "0",
"SortField": "type",
"SortType": "ASC",
"GroupId": 34
}
输出示例
{
"Response": {
"RequestId": "561cdfcb-37a6-47de-b3c5-2b038e2c2276",
"RecordCountInfo": {
"SubdomainCount": 2,
"TotalCount": 2,
"ListCount": 2
},
"RecordList": [
{
"RecordId": 556507778,
"Value": "f1g1ns1.dnspod.net.",
"Status": "ENABLE",
"UpdatedOn": "2021-03-28 11:27:09",
"Name": "@",
"Line": "默认",
"LineId": "0",
"Type": "NS",
"Weight": null,
"MonitorStatus": "",
"Remark": "",
"TTL": 86400,
"MX": 0,
"DefaultNS": true
},
{
"RecordId": 556507779,
"Value": "f1g1ns2.dnspod.net.",
"Status": "ENABLE",
"UpdatedOn": "2021-03-28 11:27:09",
"Name": "@",
"Line": "默认",
"LineId": "0",
"Type": "NS",
"Weight": null,
"MonitorStatus": "",
"Remark": "",
"TTL": 86400,
"MX": 0,
"DefaultNS": true
}
]
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
FailedOperation.NotDomainOwner | 域名不在您的名下。 |
FailedOperation.NotRealNamedUser | 未实名认证用户,请先完成实名认证再操作。 |
FailedOperation.UnknowError | 操作未响应,请稍后重试。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.DomainIdInvalid | 域名编号不正确。 |
InvalidParameter.DomainInvalid | 域名不正确,请输入主域名,如 dnspod.cn。 |
InvalidParameter.DomainIsAliaser | 此域名是其它域名的别名。 |
InvalidParameter.OperateFailed | 操作失败,请稍后再试。 |
InvalidParameter.ParamInvalid | param 格式错误。 |
InvalidParameter.RecordLineInvalid | 记录线路不正确。 |
InvalidParameter.RecordTypeInvalid | 记录类型不正确。 |
InvalidParameter.ResultMoreThan500 | 搜索结果大于500条,请增加关键字。 |
InvalidParameterValue.DomainNotExists | 当前域名有误,请返回重新操作。 |
InvalidParameterValue.LimitInvalid | 分页长度数量错误。 |
OperationDenied.NoPermissionToOperateDomain | 当前域名无权限,请返回域名列表。 |
RequestLimitExceeded | 请求的次数超过了频率限制。 |
RequestLimitExceeded.RequestLimitExceeded | API请求次数超出限制。 |
ResourceNotFound.NoDataOfRecord | 记录列表为空。 |
UnauthorizedOperation | 未授权操作。 |