1. 接口描述
接口请求域名: bm.tencentcloudapi.com 。
此接口用于操作维修任务
入参TaskId为维修任务ID
入参Operate表示对维修任务的操作,支持如下取值:
AuthorizeRepair(授权维修)
Ignore(暂不提醒)
ConfirmRecovered(维修完成后,确认故障恢复)
ConfirmUnRecovered(维修完成后,确认故障未恢复)
操作约束(当前任务状态(TaskStatus)->对应可执行的操作):
未授权(1)->授权维修;暂不处理
暂不处理(4)->授权维修
待确认(3)->确认故障恢复;确认故障未恢复
未恢复(6)->确认故障恢复
对于Ping不可达故障的任务,还允许:
未授权->确认故障恢复
暂不处理->确认故障恢复
处理中与已恢复状态的任务不允许进行操作。
详细信息请访问:https://cloud.tencent.com/document/product/386/18190
默认接口请求频率限制:10次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:RepairTaskControl |
Version | 是 | String | 公共参数,本接口取值:2018-04-23 |
Region | 是 | String | 公共参数,详见产品支持的地域列表。 |
TaskId | 是 | String | 维修任务ID |
Operate | 是 | String | 操作 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TaskId | Integer | 出参TaskId是黑石异步任务ID,不同于入参TaskId字段。 此字段可作为DescriptionOperationResult查询异步任务状态接口的入参,查询异步任务执行结果。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 维修任务管理-授权维修
输入示例
https://bm.tencentcloudapi.com/?Action=RepairTaskControl
&TaskId=bm-repair-4zywlogv
&Operate=AuthorizeRepair
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "0436564c-1284-4f0f-a341-59e86f548446",
"TaskId": 123
}
}
5. 开发者资源
API Explorer
该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败 |
InvalidParameter | 参数错误 |
UnauthorizedOperation | 未授权操作 |
如果有其他疑问,您也可以在问答社区中寻求帮助。前往问答社区 >