Querying Queuing Records in the Current Pipeline
Function
This API is used to query the queuing records in the current pipeline.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/api/pipelines/{pipeline_id}/queued-pipeline
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Definition: Project ID. For details, see Obtaining a Project ID. Constraints: N/A Value range: The value consists of 32 characters, including digits and letters. Default value: N/A |
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 digits and letters. Default value: N/A |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
offset |
Yes |
Long |
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 |
Yes |
Long |
Definition: Number of records of each query. Constraints: N/A Value range: The value is no less than 0. Default value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
offset |
Integer |
Definition: Offset where the query starts. Value range: The offset value must be no less than 0. |
limit |
Integer |
Definition: Number of records of each query. Value range: The value is no less than 0. |
total |
Integer |
Definition: Total number of items. Value range: The value is no less than 0. |
queuedPipelines |
Array of queuedPipelines objects |
Definition: Queuing record list. Value range: N/A |
Parameter |
Type |
Description |
---|---|---|
id |
Integer |
Definition: Queuing record ID. Value range: N/A |
pipeline_id |
String |
Definition: Pipeline ID. Value range: The value consists of 32 characters, including digits and letters. |
pipeline_run_id |
String |
Definition: Pipeline run ID. Value range: The value consists of 32 characters, including digits and letters. |
region |
String |
Definition: Region. Value range: N/A |
enqueue_time |
Integer |
Definition: Enqueuing time. Value range: N/A |
trigger_type |
String |
Definition: Trigger type. Value range: N/A |
creator_id |
String |
Definition: ID of the user who triggers the pipeline. Value range: The value consists of 32 characters, including digits and letters. |
creator_name |
String |
Definition: Name of the user who triggers the pipeline. Value range: N/A |
status |
String |
Definition: Queuing status. QUEUED: queuing; QUEUED_TIME_OUT: queuing timed out. Value range: QUEUED, QUEUED_TIME_OUT. |
merge_id |
String |
Definition: ID of a queued MR. Value range: N/A |
Example Requests
GET https://(endpoint)/v5/071112d87d3e4ed49130c691936202e9/api/pipelines/c173d99dbbb54626b64cf5694c0a4e8e/queued-pipeline?offset=0&limit=10
Example Responses
Status code: 200
OK
{ "offset" : 0, "limit" : 10, "total" : 1, "queuedPipelines" : [ { "id" : 136, "pipeline_id" : "c173d99dbbb54626b64cf5694c0a4e8e", "pipeline_run_id" : "b5c22bc545144ea7bf761191821c8b36", "region" : "{region}", "enqueue_time" : 1718951334000, "trigger_type" : "Manual", "creator_id" : "123456", "creator_name" : "123-5", "status" : "QUEUED", "merge_id" : 123456 } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
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