Help Center/ CodeArts Build/ API Reference/ Task APIs/ View the build task construction success rate based on the start time and end time.
Updated on 2023-12-06 GMT+08:00
View PDF

View the build task construction success rate based on the start time and end time.

Function

View the build task construction success rate based on the start time and end time.

Calling Method

For details, see Calling APIs.

URI

GET /v3/jobs/{job_id}/success-ratio

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

job_id

Yes

String

Indicates the ID of the build task. The value is a string of 32 characters consisting of digits and letters at the end of the browser URL when you edit the build task file.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

start_time

Yes

String

Start time of a time range. The format is yyyy-MM-dd.

end_time

Yes

String

End time of a time range. The format is yyyy-MM-dd.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. Obtain the value by calling the IAM service interface. (value of X-Subject-Token in the response header). Global tenant tokens are not supported. Use a region-level token whose scope is project.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

success_count

Integer

Number of Successful Task Constructions

total_count

Integer

Total number of task construction times

success_ratio

Double

Task success rate, accurate to two decimal places.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

GET https://{endpoint}/v3/jobs/{job_id}/success-ratio?start_time=2021-12-01&end_time=2021-12-01

Example Responses

Status code: 200

OK

{
  "success_count" : 2,
  "total_count" : 3,
  "success_ratio" : 0.67
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Task APIs