Checking the Pipeline Creation Status

Function

This API is used to check the pipeline creation status.

Calling Method

For details, see Calling APIs.

URI

GET /v3/templates/{task_id}/status

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
task_id	Yes	String	Instance ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
task_id	String	ID of the pipeline creation instance.
task_status	String	Instance creation status. The value can be initializing, processing, finished, or succeeded.
pipeline_id	String	Pipeline ID.
pipeline_name	String	Pipeline name.
pipeline_url	String	URL of the pipeline details page.

Status code: 400

**Table 4** Response body parameters
Parameter	Type	Description
error_msg	String	Error message.
error_code	String	Error code.

Example Requests

GET https://{endpoint}/v3/templates/eafaff0bf9094d3d8456d13dddf67b40/status

GET https://{endpoint}/v3/templates/eafaff0bf9094d3d8456d13dddf67b40/status

Example Responses

Status code: 200

{
  "task_id" : "eafaff0bf9094d3d8456d13dddf67b40",
  "task_status" : "succeeded",
  "pipeline_id" : "4f73c81f5d98455eab7a2fda2f3d2434",
  "pipeline_name" : "pipeline-20200316144601",
  "pipeline_url" : "https://example.com/3560a08e3c5143c5bb0236e0ef910926/pipeline/detail/4f73c81f5d98455eab7a2fda2f3d2434"
}