Querying Pipeline Execution Records
Function
This API is used to query pipeline execution records.
Calling Method
For details, see Calling APIs.
URI
GET /v3/pipelines/{pipeline_id}/build-records
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
pipeline_id |
Yes |
String |
Definition: Pipeline ID. Obtain the ID by calling the API for querying pipelines. pipelines.pipelineId indicates the pipeline ID. Constraints: N/A Value range: The value consists of 32 characters, including only digits and letters. Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
start_date |
No |
String |
Definition: Start date. Constraints: The interval between the start date and end date cannot exceed one month. The start date is included. Value range: N/A Default value: N/A |
end_date |
No |
String |
Definition: Start date. Constraints: The interval between the start date and end date cannot exceed one month. The start date is included. Value range: N/A Default value: N/A |
offset |
No |
Integer |
Definition: Offset where the query starts. Constraints: N/A Value range: The offset value must be no less than 0. Default value: N/A |
limit |
No |
Integer |
Definition: Number of records of each query. Constraints: N/A Value range: The value is no less than 0. Default value: N/A |
status |
No |
String |
Definition: Pipeline execution status. Constraints: N/A Value range:
Default value: N/A |
outcome |
No |
String |
Definition: Pipeline execution result. Constraints: N/A Value range:
Default value: N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition: User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API forobtaining a user token. Constraints: N/A Value range: N/A Default value: N/A |
X-Language |
No |
String |
Definition: Language type. Constraints: N/A Value range:
Default value: en-us. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Definition: Total number of items. Value range: N/A |
records |
Array of PipelineBuildRecordInfo objects |
Definition: Information of pipeline execution records. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
pipeline_id |
String |
Definition: Pipeline ID. Value range: The value consists of 32 characters, including digits and letters. |
pipeline_name |
String |
Definition: Pipeline name. Value range: N/A |
build_id |
String |
Definition: Execution ID. Value range: N/A |
start_time |
String |
Definition: Start time. Value range: N/A |
end_time |
String |
Definition: End time. Value range: N/A |
elapse_time |
String |
Definition: Execution duration. Value range: N/A |
execute_type |
String |
Definition: Job type. Value range: N/A |
executor_id |
String |
Definition: ID of the user who executes the pipeline. Value range: N/A |
executor_name |
String |
Definition: Name of the user who executes the pipeline. Value range: N/A |
status |
String |
Definition: Pipeline status. Value range: N/A |
outcome |
String |
Definition: Pipeline execution result. Value range: N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Parameter description: Error message. Value range: N/A |
error_code |
String |
Parameter description: Error code. Value range: N/A |
Example Requests
None
Example Responses
None
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot