Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Task Management/ Querying Subtasks
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Querying Subtasks

Function

Queries the execution status of an asynchronous subtask. If sub_job_ids is not empty, offset and limit do not take effect.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    workspace:jobs:listSubJobs

    List

    -

    -

    -

    -

URI

GET /v1/{project_id}/app-server-sub-jobs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a project
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

status

No

String

Job status. Options:

WAITING

RUNNING

SUCCESS

FAILED

ABNORMAL

ROLLBACK

ABORTING: cancel.

job_type

Yes

String

Job type. Options:

CREATE_SERVER

DELETE_SERVER

REJOIN_DOMAIN: Rejoining the domain on the server.

CHANGE_SERVER_IMAGE

REINSTALL_OS: Reinstalling the server OS.

MIGRATE_SERVER

UPDATE_SERVER_TSVI: Updating the virtual IP configuration.

UPGRADE_ACCESS_AGENT: HDA upgrade

SCHEDULED_TASK

UPDATE_FREEZE_STATUS: Updating server freezing status.

offset

No

Integer

Query offset. The default value is 0.

limit

No

Integer

Number of records to be queried. The value ranges from 1 to 100. The default value is 10.

job_id

No

String

Job ID.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Total number.

items

Array of JobDetailInfo objects

Task details list. The maximum number of returned records is the maximum number of records on each page.
Table 5 JobDetailInfo

Parameter

Type

Description

id

String

Identifies a subjob.

job_type

String

Task type:

CREATE_SERVER: creating a server

DELETE_SERVER: deleting a server

UPDATE_FREEZE_STATUS: changing the server freezing status

CREATE_SERVER_IMAGE: creating an image

REINSTALL_OS: reinstalling the OS

CHANGE_SERVER_IMAGE: replacing an image

REJOIN_DOMAIN: rejoining the domain

MIGRATE_SERVER: migrating a server

UPGRADE_ACCESS_AGENT: upgrading the HDA

UPDATE_SERVER_TSVI: updating a virtual session IP

SCHEDULED_TASK: performing a scheduled task

COLLECT_HDA_LOG: collecting HDA logs

COLLECT_APS_LOG: collecting application streaming server logs

CREATE_SERVER_SNAPSHOT: creating a server snapshot

DELETE_SERVER_SNAPSHOT: deleting a server snapshot

RESTORE_SERVER_SNAPSHOT: restoring a server snapshot

BATCH_INSTALL_APP: installing applications in batches

job_resource_info

JobResourceInfo object

Indicates the resource information corresponding to the job result. The resource information varies according to the job type.

Server: server information

Image: image information

begin_time

String

Time when a job is created.

end_time

String

End time of a job.

status

String

Job status.

error_code

String

Error code of a failed job.

error_message

String

Job failure cause.

project_id

String

Project ID.

job_id

String

Job ID.
Table 6 JobResourceInfo

Parameter

Type

Description

resource_id

String

Resource ID.

resource_name

String

Product name or operated resource name.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 405

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

Response to a successful request.

{
  "count" : 0,
  "items" : [ {
    "id" : "1",
    "job_type" : "CREATE_SERVER",
    "job_resource_info" : {
      "resource_id" : "a1a1245-xxxx123d-1425af14",
      "resource_name" : "APS-20220902093902-AYOASWQDEJ"
    },
    "begin_time" : "2022-03-07T10:40:43.858Z",
    "end_time" : "2022-03-07T10:40:43.858Z",
    "status" : "WAITING",
    "error_code" : "WKS.00129901",
    "error_message" : "The service is now unavailable to process the request.",
    "project_id" : "325f2346-xxxx123d-1425af14",
    "job_id" : "1"
  } ]
}

Status Codes

Status Code

Description

200

Response to a successful request.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

Permissions required.

404

No resources found.

405

The request method is not allowed.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: Task Management