文档中心 > DNSPod > API 文档 > DNSPod相关接口 > 暂停子域名的解析记录

暂停子域名的解析记录

最近更新时间:2022-01-27 08:36:32

我的收藏

1. 接口描述

接口请求域名: dnspod.tencentcloudapi.com 。

暂停子域名的解析记录

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数
本文档展示的是V1签名的参数说明,腾讯云建议您使用安全系数更高的V3签名算法,使用签名方法 v3 时,公共参数需要统一放到 HTTP Header 请求头部中,详情

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifySubdomainStatus。
Version String 公共参数,本接口取值:2021-03-23。
Region String 公共参数,本接口不需要传递此参数。
Domain String 域名
RecordType String 记录类型。允许的值为A、CNAME、MX、TXT、NS、AAAA、SPF、SRV、CAA、URL、URL1。若要传多个,用英文逗号分隔,例如A,TXT,CNAME。
Status String 记录状态。允许的值为disable。
DomainId Integer 域名 ID 。参数 DomainId 优先级比参数 Domain 高,如果传递参数 DomainId 将忽略参数 Domain 。
SubDomain String 主机记录,如 www,如果不传,默认为 @。

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 暂停@子域名A和TXT类型的解析记录

输入示例

POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySubdomainStatus
<公共请求参数>

{
    "Domain": "dnspod.site",
    "RecordType": "A,TXT",
    "Status": "disable"
}

输出示例

{
  "Response": {
    "RequestId": "ab4f1426-ea15-42ea-8183-dc1b44151166"
  }
}

示例2 暂停www子域名A/TXT/CNAME类型的解析记录

输入示例

POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySubdomainStatus
<公共请求参数>

{
    "Domain": "dnspod.site",
    "SubDomain": "www",
    "RecordType": "A,TXT,CNAME",
    "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。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.DomainIsLocked 锁定域名不能进行此操作。
FailedOperation.DomainIsSpam 封禁域名不能进行此操作。
FailedOperation.LoginAreaNotAllowed 帐号异地登录,请求被拒绝。
FailedOperation.LoginFailed 登录失败,请检查账号和密码是否正确。
FailedOperation.UnknowError 操作未响应,请稍后重试。
InvalidParameter.CustomMessage 自定义错误信息。
InvalidParameter.DnssecAddCnameError 该域名开启了 DNSSEC,不允许添加 @ 子域名 CNAME、显性 URL 或者隐性 URL 记录。
InvalidParameter.DomainIdInvalid 域名编号不正确。
InvalidParameter.DomainInvalid 域名不正确,请输入主域名,如 dnspod.cn。
InvalidParameter.DomainIsAliaser 此域名是其它域名的别名。
InvalidParameter.DomainNotAllowedModifyRecords 处于生效中/失效中的域名,不允许变更解析记录。
InvalidParameter.DomainNotBeian 该域名未备案,无法添加 URL 记录。
InvalidParameter.DomainSelfNoCopy 域名自己无需进行复制。
InvalidParameter.EmailNotVerified 抱歉,您的账户还没有通过邮箱验证。
InvalidParameter.LoginTokenIdError Token 的 ID 不正确。
InvalidParameter.LoginTokenNotExists 传入的 Token 不存在。
InvalidParameter.LoginTokenValidateFailed Token 验证失败。
InvalidParameter.MobileNotVerified 抱歉,您的账户还没有通过手机验证。
InvalidParameter.RecordIdInvalid 记录编号错误。
InvalidParameter.RecordValueInvalid 记录的值不正确。
InvalidParameter.RequestIpLimited 您的IP非法,请求被拒绝。
InvalidParameter.StatusCodeInvalid 状态代码不正确。
InvalidParameter.SubdomainInvalid 子域名不正确。
InvalidParameter.UnrealNameUser 未实名认证用户,请先完成实名认证再操作。
InvalidParameter.UrlValueIllegal 很抱歉,您要添加的URL的内容不符合DNSPod解析服务条款,URL添加/启用失败,如需帮助请联系技术支持。
InvalidParameter.UserNotExists 用户不存在。
InvalidParameterValue.DomainNotExists 当前域名有误,请返回重新操作。
InvalidParameterValue.UserIdInvalid 用户编号不正确。
LimitExceeded.AAAACountLimit AAAA记录数量超出限制。
LimitExceeded.AtNsRecordLimit @的NS记录只能设置为默认线路。
LimitExceeded.FailedLoginLimitExceeded 登录失败次数过多已被系统封禁。
LimitExceeded.HiddenUrlExceeded 该域名使用的套餐不支持隐性URL转发或数量已达上限,如需要使用,请去商城购买。
LimitExceeded.NsCountLimit NS记录数量超出限制。
LimitExceeded.SrvCountLimit SRV记录数量超出限制。
LimitExceeded.SubdomainLevelLimit 子域名级数超出限制。
LimitExceeded.SubdomainRollLimit 子域名负载均衡数量超出限制。
LimitExceeded.SubdomainWcardLimit 泛解析级数超出限制。
LimitExceeded.UrlCountLimit 该域名的显性URL转发数量已达上限,如需继续使用,请去商城购买。
OperationDenied.DomainOwnerAllowedOnly 仅域名所有者可进行此操作。
OperationDenied.NoPermissionToOperateDomain 当前域名无权限,请返回域名列表。
OperationDenied.NotAdmin 您不是管理用户。
OperationDenied.NotAgent 您不是代理用户。
OperationDenied.NotManagedUser 不是您名下用户。
RequestLimitExceeded.RequestLimitExceeded API请求次数超出限制。
目录