StopTask - 暂停任务

根据任务ID暂停任务。

接口说明

  • 调用此接口前,建议您确认任务 ID,请参考请求参数描述中的指引获取。
  • 若需启动任务,可调用 StartTask 接口。

QPS 限制

  • 单用户调用频率:不限流。
  • API 频率:500 次/秒。
说明 如果多个用户的总调用超过 API 频率也会触发流控。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
TaskIdlong

机器人呼叫任务的唯一任务 ID。

12****

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

D9CB3933-9FE3-4870-BA8E-2BEE91B69D23
Databoolean

是否成功。

  • true:成功。
  • false:失败。
true
Codestring

请求状态码。返回 OK 代表请求成功。

Ok
Messagestring

状态码描述。

OK
Successboolean

接口调用是否成功。

  • true:成功。
  • false:失败。
true

示例

正常返回示例

JSON格式

{
  "RequestId": "D9CB3933-9FE3-4870-BA8E-2BEE91B69D23",
  "Data": true,
  "Code": "Ok",
  "Message": "OK",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400PermissionInsufficientInsufficient permissions. Please contact the Alibaba Cloud account administrator.权限不足,请联系主账号管理员
400ParameterErrorThe parameter is invalid.参数错误

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2021-05-19新增 OpenAPI看变更集