1. 接口描述
接口请求域名: dnspod.tencentcloudapi.com 。
修改域名状态
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyDomainStatus。 |
Version | 是 | String | 公共参数,本接口取值:2021-03-23。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Domain | 是 | String | 域名 示例值:dnspod.cn |
Status | 是 | String | 域名状态,”enable” 、”disable” 分别代表启用和暂停 示例值:enable |
DomainId | 否 | Integer | 域名 ID 。参数 DomainId 优先级比参数 Domain 高,如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId 示例值:61 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改域名状态
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDomainStatus
<公共请求参数>
{
"Domain": "dnspod.com",
"Status": "disable"
}
输出示例
{
"Response": {
"RequestId": "ab4f1426-ea15-42ea-8183-dc1b44151166"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DomainIsKeyDomain | 该域名为腾讯云 DNSPod 重点保护资源,为了避免误操作造成的业务影响,域名禁止自行操作删除。如果您确认需要删除域名,请先联系您的客户经理,我们将竭诚为您提供技术支持。 |
FailedOperation.DomainIsLocked | 锁定域名不能进行此操作。 |
FailedOperation.DomainIsSpam | 封禁域名不能进行此操作。 |
InvalidParameter.DomainIdInvalid | 域名编号不正确。 |
InvalidParameter.DomainInvalid | 域名不正确,请输入主域名,如 dnspod.cn。 |
InvalidParameter.DomainIsAliaser | 此域名是其它域名的别名。 |
InvalidParameter.OperateFailed | 操作失败,请稍后再试。 |
InvalidParameter.ToolsDomainInvalid | 域名无效。 |
InvalidParameter.UnrealNameUser | 未实名认证用户,请先完成实名认证再操作。 |
InvalidParameterValue.DomainNotExists | 当前域名有误,请返回重新操作。 |
OperationDenied.DomainOwnerAllowedOnly | 仅域名所有者可进行此操作。 |
OperationDenied.NoPermissionToOperateDomain | 当前域名无权限,请返回域名列表。 |