1. 接口描述
接口请求域名: dnspod.tencentcloudapi.com 。
套餐绑定、解绑、更换域名
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyPackageDomain。 |
| Version | 是 | String | 公共参数,本接口取值:2021-03-23。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| Operation | 是 | String | 操作类型:change: 套餐换域名;unbind: 解绑套餐域名;bind: 套餐绑定域名。 示例值:change |
| DomainId | 否 | Integer | 域名ID。Operation为change时必传,代表更换前的域名。 示例值:49372 |
| NewDomainId | 否 | Integer | 域名ID。Operation为change或bind时必传,代表更换后或要绑定的域名。 示例值:548874 |
| ResourceId | 否 | String | 套餐资源ID。Operation为bind或unbind时必传,代表将要操作的套餐资源。 示例值:4f83dbe5 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 成功1
成功1
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPackageDomain
<公共请求参数>
{
"ResourceId": "64e4dbbd",
"Operation": "change",
"DomainId": 12615187,
"NewDomainId": 12615183
}
输出示例
{
"Response": {
"RequestId": "37ef03f4-f151-432e-b2db-f8664a4ee137"
}
}
示例2 成功示例
成功示例
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPackageDomain
<公共请求参数>
{
"ResourceId": "6392cb9b",
"Operation": "change",
"DomainId": 12600866,
"NewDomainId": 12611925
}
输出示例
{
"Response": {
"RequestId": "152ca659-d453-481e-8be3-f0f04d783a24"
}
}
示例3 套餐更换域名
套餐更换域名
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPackageDomain
<公共请求参数>
{
"Operation": "change",
"DomainId": 203232,
"NewDomainId": 4975354
}
输出示例
{
"Response": {
"RequestId": "561cdfcb-37a6-47de-b3c5-2b038e2c2276"
}
}
示例4 套餐绑定域名
套餐绑定域名
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPackageDomain
<公共请求参数>
{
"Operation": "bind",
"ResourceId": "a4d4cec3",
"NewDomainId": 4975354
}
输出示例
{
"Response": {
"RequestId": "561cdfcb-37a6-47de-b3c5-2b038e2c2276"
}
}
示例5 套餐解绑域名
套餐解绑域名
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyPackageDomain
<公共请求参数>
{
"Operation": "unbind",
"ResourceId": "a4d4cec3"
}
输出示例
{
"Response": {
"RequestId": "561cdfcb-37a6-47de-b3c5-2b038e2c2276"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 操作未授权。 |
| FailedOperation | 操作失败。 |
| FailedOperation.AccountIsLocked | 抱歉,该账户已经被锁定。 |
| FailedOperation.DomainIsEnterpriseType | 域名已升级为企业套餐,但目前位于个人账号,请与销售联系。 |
| FailedOperation.DomainIsLocked | 锁定域名不能进行此操作。 |
| FailedOperation.DomainIsPersonalType | 域名已升级为个人套餐,但目前位于企业账号,请与销售联系。 |
| FailedOperation.DomainIsSpam | 封禁域名不能进行此操作。 |
| FailedOperation.DomainIsVip | VIP域名不能进行此操作。 |
| FailedOperation.EipCheckFailed | 校验公网 IP 发生异常。 |
| FailedOperation.FreeForumUidNotAllowed | 不能绑定到免费账号。 |
| FailedOperation.LoginAreaNotAllowed | 账号异地登录,请求被拒绝。 |
| FailedOperation.LoginFailed | 登录失败,请检查账号和密码是否正确。 |
| FailedOperation.LoginTimeout | 登录已经超时,请重新登录。 |
| FailedOperation.NotBatchTaskOwner | 权限错误,您无法查看该任务的详情。 |
| FailedOperation.NotDomainOwner | 域名不在您的名下。 |
| FailedOperation.NotRealNamedUser | 未实名认证用户,请先完成实名认证再操作。 |
| FailedOperation.NotResourceOwner | 您没有权限操作此资源。 |
| FailedOperation.OrderCanNotPay | 您不能付款此订单。 |
| FailedOperation.OrderHasPaid | 此订单已经付过款。 |
| FailedOperation.ResourceNotBind | 资源未绑定域名。 |
| FailedOperation.TransferToPersonDenied | 不能转移到个人账号。 |
| FailedOperation.TwoStepNotOn | 没有开启D令牌。 |
| FailedOperation.UnknowError | 操作未响应,请稍后重试。 |
| FailedOperation.VerifyingBillExists | 域名已经提交过订单并且正在审核中,请稍候。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.AccountIsBanned | 您的账号已被系统封禁,如果您有任何疑问请与我们联系。 |
| InvalidParameter.ActionInvalid | 无效的操作。 |
| InvalidParameter.BillNumberInvalid | 订单号码不正确。 |
| InvalidParameter.Common | 您操作过于频繁,请稍后重试。 |
| InvalidParameter.DTokenNotSupport | 您的帐户下没有 企业II 或 企业III 的VIP套餐,不能开启D令牌。 |
| InvalidParameter.DataExpired | 数据过期,请重新提交。 |
| InvalidParameter.DataInvalid | data 无效。 |
| InvalidParameter.DealTypeInvalid | 订单类型无效。 |
| InvalidParameter.DefaultLineNotSelfdefined | 默认线路无法进行自定义线路分组。 |
| InvalidParameter.DnsDealDomainUpgraded | 域名已升级至付费套餐,无法完成下单。 |
| InvalidParameter.DnsDealLocked | 相关服务已有其他未完成的订单,请先将原订单支付或取消后,才可提交新的订单。 |
| InvalidParameter.DnsInvalidDeal | 订单数据非法。 |
| InvalidParameter.DomainAliasExists | 别名已经存在。 |
| InvalidParameter.DomainAlreadyVip | 目标域名已经是VIP域名,无法替换。 |
| InvalidParameter.DomainDuplicated | 一个任务里不能存在相同的域名。 |
| InvalidParameter.DomainIdInvalid | 域名编号不正确。 |
| InvalidParameter.DomainInEffectOrInvalidated | 不允许操作生效中或失效中的域名。 |
| InvalidParameter.DomainInvalid | 域名不正确,请输入主域名,如 dnspod.cn。 |
| InvalidParameter.DomainIsAliaser | 此域名是其它域名的别名。 |
| InvalidParameter.DomainNotEffective | 域名未生效。 |
| InvalidParameter.DomainNotReged | 域名还没有注册,无法添加。 |
| InvalidParameter.DomainNotVip | 原域名不是VIP域名,无法替换。 |
| InvalidParameter.DomainTaskNotFinished | 存在进行中的任务,请稍后提交。 |
| InvalidParameter.DomainTooLong | 域名过长。 |
| InvalidParameter.DomainTypeInvalid | 域名类型错误。 |
| InvalidParameter.EmailSame | 域名已经在该账号下。 |
| InvalidParameter.GetNsFail | 无法查询 DNS 地址,请确认域名是否正确。 |
| InvalidParameter.GoodsChildTypeInvalid | 商品子类型无效。 |
| InvalidParameter.IllegalNewDeal | 该订单存在冲突或参数有误,无法完成支付,请重新购买。 |
| InvalidParameter.InvalidDealName | 请输入正确的订单号。 |
| InvalidParameter.InvalidSecretId | 无效密钥 ID。 |
| InvalidParameter.InvalidSignature | 无效签名。 |
| InvalidParameter.InvalidTime | 无效的时间。 |
| InvalidParameter.OpenidInvalid | 无效的openid。 |
| InvalidParameter.OperateFailed | 操作失败,请稍后再试。 |
| InvalidParameter.OperationIsTooFrequent | 当前操作过于频繁,请 1 分钟后重试。 |
| InvalidParameter.OptypeNotSupported | 不支持的操作类型。 |
| InvalidParameter.ParamInvalid | param 格式错误。 |
| InvalidParameter.ParamsIllegal | 参数不合法,请求被拒绝。 |
| InvalidParameter.ParamsMissing | 参数错误。 |
| InvalidParameter.RequestIpLimited | 您的IP非法,请求被拒绝。 |
| InvalidParameter.TimestampExpired | 时间戳已过期。 |
| InvalidParameter.UpdateNewGradeFailed | 更新新域名等级失败。 |
| InvalidParameter.UpdateOldGradeFailed | 更新旧域名等级失败。 |
| InvalidParameterValue | 参数取值错误。 |
| LimitExceeded.FailedLoginLimitExceeded | 登录失败次数过多已被系统封禁。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| OperationDenied.AccessDenied | 您没有权限执行此操作。 |
| OperationDenied.AgentDenied | 代理不能使用此功能。 |
| OperationDenied.AgentSubordinateDenied | 代理名下的用户不能使用此功能。 |
| OperationDenied.DomainOwnerAllowedOnly | 仅域名所有者可进行此操作。 |
| OperationDenied.NoPermissionToOperateDomain | 当前域名无权限,请返回域名列表。 |
| OperationDenied.NotAdmin | 您不是管理用户。 |
| OperationDenied.NotAgent | 您不是代理用户。 |
| OperationDenied.NotGrantedByOwner | 您还没有获取到授权,无法执行此操作。 |
| OperationDenied.NotManagedUser | 不是您名下用户。 |
| OperationDenied.NotOrderOwner | 您没有权限操作此订单。 |
| OperationDenied.NotResourceOwner | 您没有权限操作此资源。 |
| OperationDenied.PostRequestAcceptOnly | 只支持 POST 方法提交数据。 |
| OperationDenied.ResourceAlreadyBind | 资源已经绑定 |
| RequestLimitExceeded | 请求的次数超过了频率限制。 |
| RequestLimitExceeded.BatchTaskLimit | 您的IP添加了过多任务。每个小时内,一个IP最多可提交80个任务,请稍后重试。 |
| RequestLimitExceeded.CreateDomainLimit | 您的账号在短时间内添加了大量的域名,请控制添加频率。 |
| RequestLimitExceeded.RequestLimitExceeded | API请求次数超出限制。 |
| ResourceInUse | 资源被占用。 |
| ResourceInsufficient | 资源不足。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| ResourcesSoldOut | 资源售罄。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |
| UnsupportedOperation | 操作不支持。 |