1. 接口描述
接口请求域名： privatedns.tencentcloudapi.com 。
添加私有域解析记录
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreatePrivateZoneRecord。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-28。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| ZoneId | 是 | String | 私有域ID 示例值：1 |
| RecordType | 是 | String | 记录类型，可选的记录类型为："A", "AAAA", "CNAME", "MX", "TXT", "PTR" 示例值：A |
| SubDomain | 是 | String | 子域名，例如 "www", "m", "@" 示例值：b |
| RecordValue | 是 | String | 记录值，例如 IP：192.168.10.2，CNAME：cname.qcloud.com.，MX：mail.qcloud.com. 示例值：3.3.3.3 |
| Weight | 否 | Integer | 记录权重，值为1-100 示例值：100 |
| MX | 否 | Integer | MX优先级：记录类型为MX时必填。取值范围：5,10,15,20,30,40,50 示例值：15 |
| TTL | 否 | Integer | 记录缓存时间，数值越小生效越快，取值1-86400s, 默认 600 示例值：600 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RecordId | String | 记录Id 示例值：1111 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 私有域-添加A记录
添加A记录
输入示例
POST / HTTP/1.1
Host: privatedns.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePrivateZoneRecord
<公共请求参数>
{
"ZoneId": "zone-123456",
"RecordType": "A",
"SubDomain": "b",
"RecordValue": "3.3.3.3",
"Weight": 100,
"TTL": 600
}输出示例
{
"Response": {
"RequestId": "a98891db-9d73-514a-8751422197b540cd",
"RecordId": "1111"
}
}示例2 私有域-添加MX记录
添加MX记录
输入示例
POST / HTTP/1.1
Host: privatedns.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePrivateZoneRecord
<公共请求参数>
{
"ZoneId": "zone-123456",
"RecordType": "MX",
"SubDomain": "b",
"RecordValue": "3.3.3.3",
"Weight": 100,
"MX": 5
}输出示例
{
"Response": {
"RequestId": "a98891db-9d73-514a-8751422197b540cd",
"RecordId": "1111"
}
}示例3 私有域-添加PTR记录
添加反解析记录
输入示例
POST / HTTP/1.1
Host: privatedns.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreatePrivateZoneRecord
<公共请求参数>
{
"ZoneId": "zone-123456",
"RecordType": "PTR",
"SubDomain": "1.1.1",
"RecordValue": "qq.com"
}输出示例
{
"Response": {
"RequestId": "a98891db-9d73-514a-8751422197b540cd",
"RecordId": "1111"
}
}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签名/鉴权错误。 |
| DryRunOperation | DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。 |
| FailedOperation | 操作失败。 |
| FailedOperation.CreateRecordFailed | 记录创建失败。 |
| FailedOperation.DataError | 数据异常。 |
| InternalError | 内部错误。 |
| InternalError.UndefiendError | 错误未定义。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.IllegalPTRRecord | PTR记录非法。 |
| InvalidParameter.IllegalRecord | 记录不合法。 |
| InvalidParameter.IllegalRecordValue | 无效的记录值。 |
| InvalidParameter.InvalidMX | MX 必须为5-50之间且为5的倍数。 |
| InvalidParameter.MXNotSupported | 该记录类型不支持 MX 优先级设置 |
| InvalidParameter.RecordAAAACountExceed | AAAA记录负载均衡数量超过50。 |
| InvalidParameter.RecordACountExceed | A记录负载均衡数量超过50。 |
| InvalidParameter.RecordCNAMECountExceed | CNAME记录负载均衡数量超过50。 |
| InvalidParameter.RecordConflict | 记录冲突。 |
| InvalidParameter.RecordCountExceed | 记录数量超过限制。 |
| InvalidParameter.RecordExist | 记录已经存在。 |
| InvalidParameter.RecordMXCountExceed | MX记录负载均衡数量超过50。 |
| InvalidParameter.RecordRolllimitCountExceed | 记录负载均衡数量超过限制。 |
| InvalidParameter.RecordTXTCountExceed | TXT记录负载均衡数量超过10。 |
| InvalidParameter.RecordUnsupportWeight | 当前记录类型不支持权重。 |
| InvalidParameter.VpcBindedMainDomain | 当前VPC已关联相同主域名。 |
| InvalidParameter.ZoneNotExists | 解析域不存在。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.IllegalTTLValue | ttl的值必须是1-86400之间。 |
| LimitExceeded | 超过配额限制。 |
| LimitExceeded.TldOutOfLimit | 超过自定义TLD额度。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.ServiceNotSubscribed | 私有域解析服务未开通。 |
| ResourceUnavailable | 资源不可用。 |
| ResourceUnavailable.TldPackageExpired | TLD增值包已过期。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnauthorizedOperation.UnauthorizedAccount | 未实名账号。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
