一、1. 接口描述
开通、描述降冷策略接口
默认接口请求频率限制：20次/秒。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数，本接口取值：OpenCoolDownPolicy。 |
| Version | 是 | String | 公共参数，本接口取值：2021-12-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 否 | String | 实例id示例值：instance-12345 |
| DatabaseName | 否 | String | db名称示例值：testdb |
| TableName | 否 | String | table名称示例值：testtable |
| OperationType | 否 | String | 操作类型示例值：open_cool_down |
| BatchOpenCoolDownTables | 否 | String | 逗号分隔 需要带上db的名字 db1.tb1,db1.tb2,db2.tb1示例值：testdb.testtable1,testdb.testtable2,anotherdb.anotherTable |
| PolicyName | 否 | String | 绑定的时候用 策略名称示例值：cool_down_policy_01 |
| BatchOpenCoolDownPartitions | 否 | String | 逗号分隔 p1,p2,p3示例值：p1,p2,p3,p4 |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| ErrorMsg | String | 错误信息示例值：1 |
| QueryDocument | String | 返回信息示例值："[{"partition_name": "p1", "cool_down_status": "enabled", "cool_down_policy": "policy_7days"}, {"partition_name": "p2", "cool_down_status": "disabled", "cool_down_policy": ""}]" |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
四、输入示例
POST / HTTP/1.1
Host: cdwdoris.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OpenCoolDownPolicy
<公共请求参数>
{
"InstanceId": "doris-12345678",
"DatabaseName": "sales_db",
"TableName": "customer_orders",
"OperationType": "enable"
}
五、输出示例
{
"Response": {
"ErrorMsg": "Operation successful",
"QueryDocument": "[{\"partition_name\": \"p1\", \"cool_down_status\": \"enabled\", \"cool_down_policy\": \"policy_7days\"}, {\"partition_name\": \"p2\", \"cool_down_status\": \"disabled\", \"cool_down_policy\": \"\"}]",
"RequestId": "req-987654321"
}
}
六、腾讯云 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
九、命令行工具
·Tencent Cloud CLI 3.0
十、6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。