Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ Querying Pipeline Concurrency on the Dashboard

Updated on 2025-12-16 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying Pipeline Concurrency on the Dashboard

Function

This API is used to query the number of concurrent and queuing pipelines in each project under a tenant.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{tenant_id}/api/dashboard/concurrency

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
tenant_id	Yes	String	Definition: Tenant ID, that is, domain ID of a user. Constraints: N/A Range: The value contains 32 characters. Default value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
pageNo	No	Integer	Definition: Page number for pagination query. Constraints: N/A Range: NOTE: 0 Default value: 1
pageSize	No	Integer	Definition: Page size. Constraints: N/A Value range: NOTE: 0 Default value:
sort	No	String	Definition: Sorting field. Constraints: N/A Value range: N/A Default value: This parameter is left empty by default, indicating that items are in arbitrary order.
order	No	String	Definition: Sorting order. Constraints: N/A Value range: desc: descending order. asc: ascending order. Default value: This parameter is left empty by default, indicating that items are in arbitrary order.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Definition: Total number. Value range: ≥ 0
pageSize	Integer	Definition: Page size. Value range: ≥ 0
pageNo	Integer	Definition: Page number. Value range: ≥ 1
concurrentlyCount	Integer	Definition: Number of concurrent executions. Value range: ≥ 0
queueUpCount	Integer	Definition: Number of queues. Value range: ≥ 0
concurrentlyList	Array of concurrentlyList objects	Definition: Concurrency list. Value range: N/A

**Table 4** concurrentlyList
Parameter	Type	Description
projectName	String	Definition: Project name. Value range: N/A
projectId	String	Definition: Project ID. Value range: 32 characters.
concurrentlyNumber	Integer	Definition: Concurrency. Value range: ≥ 0
queueUpNumber	Integer	Definition: Number of queues. Value range: ≥ 0
deleted	Boolean	Definition: Whether the item has been deleted. Value range: true: yes false: no

Example Requests

GET https://{endpoint}/v5/ce8df55870164338a72d7e828a966a2a/api/dashboard/concurrency?pageNo=1&pageSize=10&_=1763951243781

Example Responses

Status code: 200

{
  "total" : 1,
  "pageSize" : 10,
  "pageNo" : 1,
  "concurrentlyCount" : 1,
  "queueUpCount" : 1,
  "concurrentlyList" : [ {
    "projectName" : "Test",
    "projectId" : "01bbbbc3582a430fbe975075d911a2a4",
    "concurrentlyNumber" : 2,
    "queueUpNumber" : 0,
    "deleted" : false
  } ]
}