All Products
Search
Document Center

:ListInstanceTask

Last Updated:Mar 01, 2024

Queries all asynchronous tasks of a specified instance by using the instance ID.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /v2/openapi/instances/{instanceId}/tasks

Request parameters

ParameterTypeRequiredDescriptionExample
instanceIdstringYes

The instance ID.

airec-cn-o400whm78004

Response parameters

ParameterTypeDescriptionExample
object
resultobject []

The progress of the task that is running on the instance.

subProgressInfosobject []

The information about the progress of subtasks.

typestring

The type of subtasks.

DATA_PROCESS
detailstring

The detailed description of subtasks.

data import progress info
totalNuminteger

The total number of subtasks.

11
finishedNuminteger

The number of completed subtasks.

11
progressinteger

The progress of subtasks.

100
totalProgressinteger

The overall progress of the current task.

100
namestring

The name of the step. Example: DATA_IMPORT. The value indicates that data is being imported.

DATA_IMPORT
codestring

The error code.

InternalServerError
requestIdstring

The request ID.

8F81A922-6C81-46D6-B78C-CC35E16B1691
messagestring

The error message.

An internal server error occurred

Examples

Sample success responses

JSONformat

{
  "result": [
    {
      "subProgressInfos": [
        {
          "type": "DATA_PROCESS",
          "detail": "data import progress info",
          "totalNum": 11,
          "finishedNum": 11,
          "progress": 100
        }
      ],
      "totalProgress": 100,
      "name": "DATA_IMPORT"
    }
  ],
  "code": "InternalServerError",
  "requestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
  "message": "An internal server error occurred"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history