1. 接口描述
接口请求域名: privatedns.tencentcloudapi.com 。
修改解析记录状态
默认接口请求频率限制:5次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyRecordsStatus。 | 
| Version | 是 | String | 公共参数,本接口取值:2020-10-28。 | 
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 | 
| ZoneId | 是 | String | 私有域ID 示例值:zone-vcxs31di | 
| RecordIds.N | 是 | Array of Integer | 解析记录ID列表 示例值:[1,2,3] | 
| Status | 是 | String | enabled:生效,disabled:失效 示例值:enabled | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| ZoneId | String | 私有域ID 示例值:zone-sdf1fds3 | 
| RecordIds | Array of Integer | 解析记录ID列表 示例值:[1,2,3] | 
| Status | String | enabled:生效,disabled:失效 示例值:enabled | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 修改解析记录状态
解析记录状态修改为可用
输入示例
POST / HTTP/1.1
Host: privatedns.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRecordsStatus
<公共请求参数>
{
    "ZoneId": "zone-mao3y9jo",
    "RecordIds": [
        1,
        2,
        3
    ],
    "Status": "enabled"
}输出示例
{
    "Response": {
        "RequestId": "660006f4-8531-46f0-a2ba-05daf4e7932e",
        "ZoneId": "zone-mao3y9jo",
        "RecordIds": [
            1,
            2,
            3
        ],
        "Status": "enabled"
    }
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| FailedOperation.ModifyRecordFailed | 记录修改失败。 | 
| FailedOperation.UpdateRecordFailed | 记录更新失败 | 
| InternalError | 内部错误。 | 
| InternalError.UndefiendError | 错误未定义。 | 
| InvalidParameter | 参数错误。 | 
| InvalidParameter.RecordNotExist | 记录不存在。 | 
| InvalidParameter.ZoneNotExists | 解析域不存在。 | 
| LimitExceeded.TldOutOfLimit | 超过自定义TLD额度。 | 
| LimitExceeded.TldOutOfRange | 使用自定义TLD的私有域超过总额度。 | 
| ResourceUnavailable.TldPackageExpired | TLD增值包已过期。 |