Help Center/ CodeArts Pipeline/ API Reference/ API/ Pipeline Management/ This API is used to query the usage details of the new package for a tenant.
Updated on 2025-12-04 GMT+08:00

This API is used to query the usage details of the new package for a tenant.

Function

This API is used to query the usage details for a tenant of a new package based on the tenant ID.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{tenant_id}/api/package-specs/usage

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

Value range:

The value consists of 32 characters, including only digits and letters.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

domain_id

String

Definition:

Tenant ID, that is, domain ID of a user.

Range:

N/A

user_id

String

Definition:

User ID.

Value range:

N/A

user_name

String

Definition:

Username.

Value range:

N/A

usage

usage object

Definition:

Usage details.

Value range:

N/A

Table 3 usage

Parameter

Type

Description

concurrent_number

String

Definition:

Concurrent pipeline executions

Range:

N/A

execute_duration

String

Definition:

Execution usage.

Value range:

N/A

pipeline_execute_duration

String

Definition:

Pipeline execution usage.

Value range:

N/A

Example Requests

GET https://{endpoint}/v5/{tenant_id}/api/package-specs/usage?project_id=4fca5a98a2814d3e982ca09bd8b43180&_=1763887110995

Example Responses

Status code: 200

OK

{
  "domain_id" : "ce8df55870164338a72d7e828a966a2a",
  "user_id" : "847a5317086c41798469d0868535943a",
  "user_name" : "devcloud_devcloud_h00485561_01",
  "usage" : {
    "concurrent_number" : null,
    "execute_duration" : "0.0000",
    "pipeline_execute_duration" : "0.0000"
  }
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.