Updated on 2026-09-07 GMT+08:00

Querying the Number of Subtasks

Function

This API is used to calculate the number of subtasks based on the number of shards in the DDM or GaussDB Distributed database.

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 and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permissions are required for calling this API.

URI

GET /v5/{project_id}/jobs/child-count

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region

For details about how to obtain the project ID, see Obtaining a Project ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

ID of a DDM or GaussDB Distributed instance.

region

No

String

Region. The default value is the current region code.

db_type

Yes

String

DB instance type.

Enumerated values:

  • gaussdbv5

  • ddm

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

After a request is processed, the value of X-Subject-Token in the header is the token value.

Content-Type

No

String

MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

X-Language

No

String

Request language type

Enumerated values:

  • en-us

  • zh-cn

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Number of subtasks.

Status code: 422

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

Querying the number of shards in the GaussDB Distributed database to obtain the number of DRS subtasks

https://{endpoint}/v5/{project_id}/jobs/child-count

{
  "instance_id" : "052fd1e1720c4d4cb09611b80a4af471in14",
  "db_type" : "gaussdbv5"
}

Example Response

Status code: 200

Number of subtasks.

{
  "count" : 3
}

Status code: 422

Bad Request

{
  "error_code" : "DRS.M00004",
  "error_msg" : "Server error."
}

Status Codes

Status Code

Description

200

Number of subtasks.

422

Bad Request

For other statuses, see Status Code.

Error Code

For details, see Error Code.