1. 接口描述
接口请求域名： dnspod.tencentcloudapi.com 。
DNSPod商品下单
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateDeal。 |
| Version | 是 | String | 公共参数，本接口取值：2021-03-23。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| DealType | 是 | Integer | 询价类型，1 新购，2 续费，3 套餐升级（增值服务暂时只支持新购） 示例值：1 |
| GoodsType | 是 | Integer | 商品类型，1 域名套餐 2 增值服务 示例值：1 |
| GoodsChildType | 是 | String | 套餐类型： DP_PLUS：专业版 DP_EXPERT：企业版 DP_ULTRA：尊享版 增值服务类型 LB：负载均衡 URL：URL转发 DMONITOR_TASKS：D监控任务数 DMONITOR_IP：D监控备用 IP 数 CUSTOMLINE：自定义线路数 示例值：DP_PLUS |
| GoodsNum | 是 | Integer | 增值服务购买数量，如果是域名套餐固定为1，如果是增值服务则按以下规则： 负载均衡、D监控任务数、D监控备用 IP 数、自定义线路数、URL 转发（必须是5的正整数倍，如 5、10、15 等） 示例值：1 |
| AutoRenew | 是 | Integer | 是否开启自动续费，1 开启，2 不开启（增值服务暂不支持自动续费），默认值为 2 不开启 示例值：1 |
| Domain | 否 | String | 需要绑定套餐的域名，如 dnspod.cn，如果是续费或升级，domain 参数必须要传，新购可不传。 示例值：testses.com |
| TimeSpan | 否 | Integer | 套餐时长： 1. 套餐以月为单位（按月只能是 3、6 还有 12 的倍数），套餐例如购买一年则传12，最大120 。（续费最低一年） 2. 升级套餐时不需要传。 3. 增值服务的时长单位为年，买一年传1（增值服务新购按年只能是 1，增值服务续费最大为 10） 示例值：3 |
| NewPackageType | 否 | String | 套餐类型，需要升级到的套餐类型，只有升级时需要。 示例值：DP_EXTRA |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| BigDealId | String | 大订单号，一个大订单号下可以有多个子订单，说明是同一次下单 示例值：xxxx |
| DealList | Array of Deals | 子订单列表 示例值：[{"DealId":"xxx","DealName":"xxx""}] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DNSPod商品下单示例
DNSPod商品下单示例
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDeal
<公共请求参数>
{
"Domain": "8988.ltd",
"NewPackageType": "",
"GoodsNum": 1,
"TimeSpan": 12,
"AutoRenew": 1,
"DealType": 1,
"GoodsChildType": "DP_PLUS",
"GoodsType": 1
}输出示例
{
"Response": {
"RequestId": "896a1b04-814d-49d1-b404-42cc8d5b67f0",
"DealList": [
{
"DealName": "20220519328000975112751",
"DealId": "223011900"
}
],
"BigDealId": "20220519328000975112741"
}
}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签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 操作未授权。 |
| FailedOperation | 操作失败。 |
| FailedOperation.AccountIsLocked | 抱歉，该账户已经被锁定。 |
| FailedOperation.ContainsPersonalVip | 您的账户下包含个人豪华域名，不能直接升级，请联系销售。 |
| FailedOperation.DomainIsPersonalType | 域名已升级为个人套餐，但目前位于企业账号，请与销售联系。 |
| FailedOperation.DomainIsSpam | 封禁域名不能进行此操作。 |
| FailedOperation.DomainIsVip | VIP域名不能进行此操作。 |
| FailedOperation.EipCheckFailed | 校验公网 IP 发生异常。 |
| FailedOperation.FunctionNotAllowedApply | 此功能暂停申请，请稍候重试。 |
| FailedOperation.GetWhoisFailed | 获取不到域名信息，可能域名非法或网络故障，请稍后再试。 |
| FailedOperation.LoginAreaNotAllowed | 账号异地登录，请求被拒绝。 |
| FailedOperation.LoginFailed | 登录失败，请检查账号和密码是否正确。 |
| FailedOperation.LoginTimeout | 登录已经超时，请重新登录。 |
| FailedOperation.MobileNotVerified | 用户手机没有通过验证。 |
| FailedOperation.NotRealNamedUser | 未实名认证用户，请先完成实名认证再操作。 |
| FailedOperation.NotResourceOwner | 您没有权限操作此资源。 |
| FailedOperation.OrderCanNotPay | 您不能付款此订单。 |
| FailedOperation.OrderHasPaid | 此订单已经付过款。 |
| FailedOperation.ResourceNotBind | 资源未绑定域名。 |
| FailedOperation.UnknowError | 操作未响应，请稍后重试。 |
| FailedOperation.VerifyingBillExists | 域名已经提交过订单并且正在审核中，请稍候。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.AccountIsBanned | 您的账号已被系统封禁，如果您有任何疑问请与我们联系。 |
| InvalidParameter.ActionInvalid | 无效的操作。 |
| InvalidParameter.ActionSuccess | 操作已经成功完成。 |
| InvalidParameter.Activity | 用户未实名。 |
| InvalidParameter.BillNumberInvalid | 订单号码不正确。 |
| InvalidParameter.Common | 您操作过于频繁，请稍后重试。 |
| InvalidParameter.DataExpired | 数据过期,请重新提交。 |
| InvalidParameter.DataInvalid | data 无效。 |
| InvalidParameter.DealTypeInvalid | 订单类型无效。 |
| InvalidParameter.DnsDealDomainUpgraded | 域名已升级至付费套餐，无法完成下单。 |
| InvalidParameter.DnsDealLocked | 相关服务已有其他未完成的订单，请先将原订单支付或取消后，才可提交新的订单。 |
| InvalidParameter.DnsInvalidDeal | 订单数据非法。 |
| InvalidParameter.DomainAliasExists | 别名已经存在。 |
| InvalidParameter.DomainAliasIdInvalid | 别名编号错误。 |
| InvalidParameter.DomainIdInvalid | 域名编号不正确。 |
| InvalidParameter.DomainInvalid | 域名不正确，请输入主域名，如 dnspod.cn。 |
| InvalidParameter.DomainIsAliaser | 此域名是其它域名的别名。 |
| InvalidParameter.DomainIsModifyingDns | 该域名已有同类型操作未完成，无法执行该操作。 |
| InvalidParameter.DomainNotReged | 域名还没有注册，无法添加。 |
| InvalidParameter.DomainNotVip | 原域名不是VIP域名，无法替换。 |
| InvalidParameter.DomainTooLong | 域名过长。 |
| InvalidParameter.DomainTypeInvalid | 域名类型错误。 |
| InvalidParameter.DomainsEmpty | 没有提交任何域名。 |
| InvalidParameter.GoodsChildTypeInvalid | 商品子类型无效。 |
| InvalidParameter.GoodsNumInvalid | 商品数量无效。 |
| InvalidParameter.GoodsTypeInvalid | 商品类型无效。 |
| InvalidParameter.GroupNameInvalid | 分组名为1-17个字符。 |
| InvalidParameter.IllegalNewDeal | 该订单存在冲突或参数有误，无法完成支付，请重新购买。 |
| InvalidParameter.InvalidDealName | 请输入正确的订单号。 |
| InvalidParameter.InvalidSecretId | 无效密钥 ID。 |
| InvalidParameter.InvalidSignature | 无效签名。 |
| InvalidParameter.InvalidTime | 无效的时间。 |
| InvalidParameter.OperateFailed | 操作失败，请稍后再试。 |
| InvalidParameter.PermissionDenied | 鉴权失败。 |
| InvalidParameter.QcloudUinInvalid | 用户UIN无效。 |
| InvalidParameter.RequestIpLimited | 您的IP非法，请求被拒绝。 |
| InvalidParameter.SharedUsersUnrealName | 共享用户中包含未实名认证用户。 |
| InvalidParameter.TimeSpanInvalid | 时长无效。 |
| InvalidParameter.TimestampExpired | 时间戳已过期。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.DomainNotExists | 当前域名有误，请返回重新操作。 |
| LimitExceeded | 超过配额限制。 |
| LimitExceeded.FailedLoginLimitExceeded | 登录失败次数过多已被系统封禁。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.AccessDenied | 您没有权限执行此操作。 |
| OperationDenied.CancelBillNotAllowed | 此订单不能取消。 |
| OperationDenied.DomainOwnerAllowedOnly | 仅域名所有者可进行此操作。 |
| OperationDenied.MonitorCallbackNotEnabled | 抱歉，您的域名等级不支持D监控通知回调功能。 |
| OperationDenied.NoPermissionToOperateDomain | 当前域名无权限，请返回域名列表。 |
| OperationDenied.NotAdmin | 您不是管理用户。 |
| OperationDenied.NotGrantedByOwner | 您还没有获取到授权，无法执行此操作。 |
| OperationDenied.NotManagedUser | 不是您名下用户。 |
| OperationDenied.NotOrderOwner | 您没有权限操作此订单。 |
| OperationDenied.PostRequestAcceptOnly | 只支持 POST 方法提交数据。 |
| OperationDenied.VipDomainAllowed | 企业用户的域名需要升级到VIP才能解析。 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| RequestLimitExceeded.BatchTaskLimit | 您的IP添加了过多任务，请稍后重试。 |
| RequestLimitExceeded.CreateDomainLimit | 您的账号在短时间内添加了大量的域名，请控制添加频率。 |
| RequestLimitExceeded.RequestLimitExceeded | API请求次数超出限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceNotFound.NoDataOfDomain | 域名列表为空。 |
| ResourceNotFound.NoDataOfDomainAlias | 没有域名别名。 |
| ResourceNotFound.NoDataOfGift | 还没有任何礼券。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |
