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

Querying the Number of Image Subtasks

Function

Queries the number of asynchronous subtasks. If job_type is not specified,

the total number of subtasks whose JobType is CREATE_SERVER|CREATE_SERVER_IMAGE|DELETE_SERVER is queried.

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:imageServer:countImageSubJobs

    Read

    -

    -

    -

    -

URI

GET /v1/{project_id}/image-server-sub-jobs/actions/count

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

No

String

Task type. If there are multiple task types, separate them with commas (,).

job_id

No

String

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

Status code: 400

Table 5 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 6 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 7 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 8 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 9 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 10 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 11 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

Success.

{
  "count" : 0
}

Status Codes

Status Code

Description

200

Success.

400

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

401

Authentication failed.

403

No permissions.

404

Resources not found.

405

The method specified in the request 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