1. 接口描述
接口请求域名: privatedns.tencentcloudapi.com 。
获取私有域记录列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribePrivateZoneRecordList。 |
Version | 是 | String | 公共参数,本接口取值:2020-10-28。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
ZoneId | 是 | String | 私有域ID: zone-xxxxxx 示例值:1 |
Filters.N | 否 | Array of Filter | 过滤参数(支持使用Value、RecordType过滤) |
Offset | 否 | Integer | 分页偏移量,从0开始 示例值:0 |
Limit | 否 | Integer | 分页限制数目, 最大200,默认20 示例值:200 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 解析记录数量 示例值:5 |
RecordSet | Array of PrivateZoneRecord | 解析记录列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取解析记录列表
输入示例
POST / HTTP/1.1
Host: privatedns.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribePrivateZoneRecordList
<公共请求参数>
{
"ZoneId": "zone-123456",
"Limit": 2,
"Offset": 0,
"Filters": [
{
"Name": "Value",
"Values": [
"3",
"b"
]
},
{
"Name": "RecordType",
"Values": [
"A",
"AAAA"
]
}
]
}
输出示例
{
"Response": {
"RequestId": "8a4ea9cc-b1df-f8f8-ffe7efbe98f9ff85",
"TotalCount": 5,
"RecordSet": [
{
"RecordId": "66",
"ZoneId": "zone-123456",
"SubDomain": "b",
"RecordType": "A",
"RecordValue": "3.3.3.3",
"TTL": 600,
"MX": 0,
"Status": "enabled",
"Extra": "weight:100",
"CreatedOn": "2020-11-16 17:16:24",
"UpdatedOn": "2020-11-16 17:16:24",
"Weight": 100,
"Enabled": 0
},
{
"RecordId": "65",
"ZoneId": "zone-123456",
"SubDomain": "mail",
"RecordType": "MX",
"RecordValue": "5.5.5.5",
"TTL": 600,
"MX": 10,
"Status": "enabled",
"Extra": null,
"CreatedOn": "2020-11-16 17:14:02",
"UpdatedOn": "2020-11-16 17:14:02",
"Weight": null,
"Enabled": 0
}
]
}
}
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 | 操作失败。 |
InternalError | 内部错误。 |
InternalError.UndefiendError | 错误未定义。 |
InvalidParameter | 参数错误。 |
InvalidParameter.ZoneNotExists | 解析域不存在。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound.ServiceNotSubscribed | 私有域解析服务未开通。 |
UnauthorizedOperation | 未授权操作。 |
UnauthorizedOperation.UnauthorizedAccount | 未实名账号。 |
UnknownParameter | 未知参数错误。 |
UnsupportedOperation | 操作不支持。 |