1. 接口描述
接口请求域名： dnspod.tencentcloudapi.com 。
设置记录备注
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyRecordRemark。 |
| Version | 是 | String | 公共参数，本接口取值：2021-03-23。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Domain | 是 | String | 域名 示例值：dnspod.cn |
| RecordId | 是 | Integer | 记录 ID 。可以通过接口DescribeRecordList查到所有的解析记录列表以及对应的RecordId 示例值：162 |
| DomainId | 否 | Integer | 域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId 示例值：1923 |
| Remark | 否 | String | 解析记录备注，删除备注请提交空内容。 示例值：这是解析记录的备注 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 设置记录备注
输入示例
POST / HTTP/1.1
Host: dnspod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRecordRemark
<公共请求参数>
{
"Domain": "dnspod.site",
"DomainId": 62,
"RecordId": 162,
"Remark": "这是解析记录的备注"
}输出示例
{
"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.DomainIsLocked | 锁定域名不能进行此操作。 |
| FailedOperation.DomainIsSpam | 封禁域名不能进行此操作。 |
| FailedOperation.LoginAreaNotAllowed | 账号异地登录，请求被拒绝。 |
| FailedOperation.LoginFailed | 登录失败，请检查账号和密码是否正确。 |
| FailedOperation.UnknowError | 操作未响应，请稍后重试。 |
| InvalidParameter.DomainIdInvalid | 域名编号不正确。 |
| InvalidParameter.DomainInvalid | 域名不正确，请输入主域名，如 dnspod.cn。 |
| InvalidParameter.DomainIsAliaser | 此域名是其它域名的别名。 |
| InvalidParameter.DomainNotAllowedModifyRecords | 处于生效中/失效中的域名，不允许变更解析记录。 |
| InvalidParameter.LoginTokenIdError | Token 的 ID 不正确。 |
| InvalidParameter.LoginTokenNotExists | 传入的 Token 不存在。 |
| InvalidParameter.LoginTokenValidateFailed | Token 验证失败。 |
| InvalidParameter.RecordIdInvalid | 记录编号错误。 |
| InvalidParameter.RemarkLengthExceeded | 备注信息超出字符限制。 |
| InvalidParameter.RequestIpLimited | 您的IP非法，请求被拒绝。 |
| InvalidParameter.UnrealNameUser | 未实名认证用户，请先完成实名认证再操作。 |
| InvalidParameter.UserNotExists | 用户不存在。 |
| InvalidParameterValue.DomainNotExists | 当前域名有误，请返回重新操作。 |
| InvalidParameterValue.UserIdInvalid | 用户编号不正确。 |
| LimitExceeded.FailedLoginLimitExceeded | 登录失败次数过多已被系统封禁。 |
| OperationDenied.DomainOwnerAllowedOnly | 仅域名所有者可进行此操作。 |
| OperationDenied.NoPermissionToOperateDomain | 当前域名无权限，请返回域名列表。 |
| OperationDenied.NotAdmin | 您不是管理用户。 |
| OperationDenied.NotAgent | 您不是代理用户。 |
| OperationDenied.NotManagedUser | 不是您名下用户。 |
| RequestLimitExceeded.RequestLimitExceeded | API请求次数超出限制。 |