接口请求域名: cfg.intl.tencentcloudapi.com 。
修改任务运行状态
默认接口请求频率限制:10次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ModifyTaskRunStatus。 |
| Version | 是 | String | 公共参数,本接口取值:2021-08-20。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| TaskId | 是 | Integer | 任务ID |
| Status | 是 | Integer | 任务状态, 1001--未开始 1002--进行中(执行)1003--进行中(暂停)1004--执行结束 |
| IsExpect | 否 | Boolean | 执行结果是否符合预期(当前扭转状态为执行结束时,需要必传此字段) |
| Summary | 否 | String | 演习结论(当演习状态转变为执行结束时,需要填写此字段) |
| Issue | 否 | String | 问题以及改进 |
| Record | 否 | String | 演练记录 |
| IncludeRecordInReport | 否 | Integer |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
POST / HTTP/1.1
Host: cfg.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTaskRunStatus
<公共请求参数>
{
"Status": "1002",
"TaskId": "1698"
}
{
"Response": {
"RequestId": "8e9a0777-ff96-4020-8aec-6802d8103689"
}
}
POST / HTTP/1.1
Host: cfg.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyTaskRunStatus
<公共请求参数>
{
"Status": "1004",
"IsExpect": true,
"TaskId": "222",
"Summary": "演习结论"
}
{
"Response": {
"RequestId": "e38eca72-e4ae-4a86-9696-7df399e672bd"
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| MissingParameter | 缺少参数错误。 |
| OperationDenied | 操作被拒绝。 |
| ResourceInUse | 资源被占用。 |
| UnsupportedOperation | 操作不支持。 |
文档反馈