有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

此接口用于操作维修任务

入参TaskId为维修任务ID

入参Operate表示对维修任务的操作,支持如下取值:

AuthorizeRepair(授权维修)

Ignore(暂不提醒)

ConfirmRecovered(维修完成后,确认故障恢复)

ConfirmUnRecovered(维修完成后,确认故障未恢复,该操作已不推荐用)

NeedRepairAgain(维修完成后,故障未恢复,需要重新维修,推荐用此操作打回)

入参OperateRemark仅在Operate为NeedRepairAgain时有效,表示打回重修原因,建议给出打回的具体原因。



操作约束(当前任务状态(TaskStatus)->对应可执行的操作):

未授权(1)->授权维修;暂不处理

暂不处理(4)->授权维修

待确认(3)->确认故障恢复;确认故障未恢复;需要重新维修

未恢复(6)->确认故障恢复



对于Ping不可达故障的任务,还允许:

未授权->确认故障恢复

暂不处理->确认故障恢复



处理中与已恢复状态的任务不允许进行操作。



详细信息请访问:https://cloud.tencent.com/document/product/386/18190

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

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

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RepairTaskControl。
Version String 公共参数,本接口取值:2018-04-23。
Region String 公共参数,详见产品支持的 地域列表
TaskId String 维修任务ID
示例值:bm-repair-4zywlogv
Operate String 操作
示例值:AuthorizeRepair
OperateRemark String 需要重新维修操作的备注信息,可提供返场维修原因,以便驻场快速针对问题定位解决。

3. 输出参数

参数名称 类型 描述
TaskId Integer 出参TaskId是黑石异步任务ID,不同于入参TaskId字段。
此字段可作为DescriptionOperationResult查询异步任务状态接口的入参,查询异步任务执行结果。
示例值:123
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InvalidParameter 参数错误。
UnauthorizedOperation 未授权操作。