DocsICP FilingConsole
Documentation

WorkspaceActionStatus

Updated at:
Copy as MD
Product
My Favorites

Queries the status of an asynchronous task in a workspace. Operations such as a deployment return a key. Call this operation with the key to retrieve the task's status.

Operation description

Provide the key returned by an asynchronous action, such as a deployment, to retrieve the task's status.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example
WorkspaceId

string

Yes

The ID of the workspace.

12345
Key

string

Yes

The unique key that identifies the asynchronous task. You can obtain this key from the response of an operation, such as a deployment.

ws-xxx-xxxx

Response elements

Element

Type

Description

Example

object

Schema of Response

Data

object

The returned data.

Status

string

The status of the asynchronous task. Valid values: SUCCESS, ERROR, TIMEOUT, and CANCEL.

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

string

The time when the task started.

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

string

The time when the task ended.

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

string

The error message if the task fails.

action failed
Message

string

The error message that is returned if the request fails.

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

string

The ID of the request.

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

string

The error code.

InvalidTid
HttpStatusCode

integer

The HTTP status code.

200
Success

boolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.

  • false: The request failed.

true

Examples

Success response

JSON format

{
  "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
}

Error codes

HTTP status code

Error code

Error message

Description
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.