调用 EndTask 接口,结束正在机审中的任务。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | EndTask | 接口名称。当前 API 的名称为 EndTask。 |
| Version | String | 是 | 2024-08-01 | 接口版本。当前 API 的版本为 2024-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
TaskId | Long | 是 |
| 任务 ID。您可通过调用 CreateTask 或 ListTasks 获取 ID。 说明 目前仅支持结束状态为“机审中”的任务。 |
| ProjectName | String | 是 | 1827*****8608457 | 项目名称。您可通过调用 ListProjects 接口获取项目名称。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Status | Boolean | true | 是否成功结束任务。成功返回 true。 |
POST https://livesaas.volcengineapi.com/?Action=EndTask&Version=2024-08-01 { "TaskId": 397***71, "ProjectName": "1827*****8608457" }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "EndTask", "Version": "2024-08-01", "Service": "livesaas", "Region": "cn-north-1" }, "Result": { "Status": true } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 400 | TaskAlreadyClosedError | the inspection task has been closed and cannot be operated | 当前任务不是“机审中”的状态。请确保任务的状态为“机审中”,再调用本接口。 |