WorkspaceActionStatus - 异步任务状态查看

更新时间:
复制为 MD 格式

工作空间异步操作状态查询接口,比如部署代码接口返回一个key,根据这个key来查这个status接口,即可获取到状态

接口说明

传入 key,获取异步任务的状态。 key 可以在部署等动作接口的返回中获得

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

WorkspaceId

string

工作空间 ID。

12345

Key

string

会话回放历史的 Key

ws-xxx-xxxx

返回参数

名称

类型

描述

示例值

object

Schema of Response

Data

object

返回的结果信息

Status

string

异步动作的执行结果: SUCCESS/ERROR/TIMEOUT/CANCEL

{'phase': 'Created', 'latestExecError': {'message': '', 'code': '', 'requestId': '', 'extraInfo': '', 'title': ''}}

StartTime

string

开始时间

2026-01-13T14:30:20.582182728+08:00

EndTime

string

结束时间

2026-01-13T14:30:20.582182728+08:00

Data

string

当错误时,这里返回错误信息

action failed

Message

string

请求失败时的错误消息

This record is being collected, please wait for a moment.

RequestId

string

请求 ID

67E910F2-4B62-5B0C-ACA3-7547695C****

ErrorCode

string

错误码。

InvalidTid

HttpStatusCode

integer

错误码描述。

200

Success

boolean

请求是否成功,返回值如下:

  • true:请求成功。

  • false:请求失败。

true

示例

正常返回示例

JSON格式

{
  "Data": {
    "Status": "{'phase': 'Created', 'latestExecError': {'message': '', 'code': '', 'requestId': '', 'extraInfo': '', 'title': ''}}",
    "StartTime": "2026-01-13T14:30:20.582182728+08:00",
    "EndTime": "2026-01-13T14:30:20.582182728+08:00",
    "Data": "action failed"
  },
  "Message": "This record is being collected, please wait for a moment.",
  "RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
  "ErrorCode": "InvalidTid",
  "HttpStatusCode": 200,
  "Success": true
}

错误码

HTTP status code

错误码

错误信息

描述

400 IdempotentParameterMismatch The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

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

变更历史

更多信息,参考变更详情