Pipelines API

原文：https://docs.gitlab.com/ee/api/pipelines.html

• Single Pipeline Requests
• Pipelines pagination
• List project pipelines
• Get a single pipeline
  • Get variables of a pipeline
  • Get a pipeline’s test report
• Create a new pipeline
• Retry jobs in a pipeline
• Cancel a pipeline’s jobs
• Delete a pipeline

Pipelines API

Single Pipeline Requests

在 GitLab 13.2 中引入 .

请求有关单个管道的信息的端点返回任何管道的数据. 在 13.2 之前， 对子管道的请求返回了 404 错误.

Pipelines pagination

默认情况下，因为 API 结果是分页的，所以GET请求一次返回 20 个结果.

阅读有关分页的更多信息.

List project pipelines

在 GitLab 8.11 中引入

GET /projects/:id/pipelines

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipelines"

回应范例

[  {  "id":  47,  "status":  "pending",  "ref":  "new-pipeline",  "sha":  "a91957a858320c0e17f3a0eca7cfacbff50ea29a",  "web_url":  "https://example.com/foo/bar/pipelines/47",  "created_at":  "2016-08-11T11:28:34.085Z",  "updated_at":  "2016-08-11T11:32:35.169Z",  },  {  "id":  48,  "status":  "pending",  "ref":  "new-pipeline",  "sha":  "eb94b618fb5865b26e80fdd8ae531b7a63ad851a",  "web_url":  "https://example.com/foo/bar/pipelines/48",  "created_at":  "2016-08-12T10:06:04.561Z",  "updated_at":  "2016-08-12T10:09:56.223Z",  }  ]

Get a single pipeline

在 GitLab 8.11 中引入

GET /projects/:id/pipelines/:pipeline_id

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipelines/46"

回应范例

{  "id":  46,  "status":  "success",  "ref":  "master",  "sha":  "a91957a858320c0e17f3a0eca7cfacbff50ea29a",  "before_sha":  "a91957a858320c0e17f3a0eca7cfacbff50ea29a",  "tag":  false,  "yaml_errors":  null,  "user":  {  "name":  "Administrator",  "username":  "root",  "id":  1,  "state":  "active",  "avatar_url":  "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",  "web_url":  "http://localhost:3000/root"  },  "created_at":  "2016-08-11T11:28:34.085Z",  "updated_at":  "2016-08-11T11:32:35.169Z",  "started_at":  null,  "finished_at":  "2016-08-11T11:32:35.145Z",  "committed_at":  null,  "duration":  null,  "coverage":  "30.0",  "web_url":  "https://example.com/foo/bar/pipelines/46"  }

Get variables of a pipeline

GET /projects/:id/pipelines/:pipeline_id/variables

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipelines/46/variables"

回应范例

[  {  "key":  "RUN_NIGHTLY_BUILD",  "variable_type":  "env_var",  "value":  "true"  },  {  "key":  "foo",  "value":  "bar"  }  ]

Get a pipeline’s test report

在 GitLab 13.0 中引入 .

警告：此 API 路由是JUnit 测试报告功能的一部分. 它受一个功能标志保护，该功能标志由于非常大的数据集的性能问题而被禁用 .

GET /projects/:id/pipelines/:pipeline_id/test_report

样品要求：

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipelines/46/test_report"

样本回复：

{  "total_time":  5,  "total_count":  1,  "success_count":  1,  "failed_count":  0,  "skipped_count":  0,  "error_count":  0,  "test_suites":  [  {  "name":  "Secure",  "total_time":  5,  "total_count":  1,  "success_count":  1,  "failed_count":  0,  "skipped_count":  0,  "error_count":  0,  "test_cases":  [  {  "status":  "success",  "name":  "Security Reports can create an auto-remediation MR",  "classname":  "vulnerability_management_spec",  "execution_time":  5,  "system_output":  null,  "stack_trace":  null  }  ]  }  ]  }

Create a new pipeline

在 GitLab 8.14 中引入

POST /projects/:id/pipeline

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipeline?ref=master"

回应范例

{  "id":  61,  "sha":  "384c444e840a515b23f21915ee5766b87068a70d",  "ref":  "master",  "status":  "pending",  "before_sha":  "0000000000000000000000000000000000000000",  "tag":  false,  "yaml_errors":  null,  "user":  {  "name":  "Administrator",  "username":  "root",  "id":  1,  "state":  "active",  "avatar_url":  "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",  "web_url":  "http://localhost:3000/root"  },  "created_at":  "2016-11-04T09:36:13.747Z",  "updated_at":  "2016-11-04T09:36:13.977Z",  "started_at":  null,  "finished_at":  null,  "committed_at":  null,  "duration":  null,  "coverage":  null,  "web_url":  "https://example.com/foo/bar/pipelines/61"  }

Retry jobs in a pipeline

在 GitLab 8.11 中引入

POST /projects/:id/pipelines/:pipeline_id/retry

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipelines/46/retry"

Response:

{  "id":  46,  "status":  "pending",  "ref":  "master",  "sha":  "a91957a858320c0e17f3a0eca7cfacbff50ea29a",  "before_sha":  "a91957a858320c0e17f3a0eca7cfacbff50ea29a",  "tag":  false,  "yaml_errors":  null,  "user":  {  "name":  "Administrator",  "username":  "root",  "id":  1,  "state":  "active",  "avatar_url":  "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",  "web_url":  "http://localhost:3000/root"  },  "created_at":  "2016-08-11T11:28:34.085Z",  "updated_at":  "2016-08-11T11:32:35.169Z",  "started_at":  null,  "finished_at":  "2016-08-11T11:32:35.145Z",  "committed_at":  null,  "duration":  null,  "coverage":  null,  "web_url":  "https://example.com/foo/bar/pipelines/46"  }

Cancel a pipeline’s jobs

在 GitLab 8.11 中引入

POST /projects/:id/pipelines/:pipeline_id/cancel

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipelines/46/cancel"

Response:

{  "id":  46,  "status":  "canceled",  "ref":  "master",  "sha":  "a91957a858320c0e17f3a0eca7cfacbff50ea29a",  "before_sha":  "a91957a858320c0e17f3a0eca7cfacbff50ea29a",  "tag":  false,  "yaml_errors":  null,  "user":  {  "name":  "Administrator",  "username":  "root",  "id":  1,  "state":  "active",  "avatar_url":  "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",  "web_url":  "http://localhost:3000/root"  },  "created_at":  "2016-08-11T11:28:34.085Z",  "updated_at":  "2016-08-11T11:32:35.169Z",  "started_at":  null,  "finished_at":  "2016-08-11T11:32:35.145Z",  "committed_at":  null,  "duration":  null,  "coverage":  null,  "web_url":  "https://example.com/foo/bar/pipelines/46"  }

Delete a pipeline

在 GitLab 11.6 中引入 .

DELETE /projects/:id/pipelines/:pipeline_id

curl --header "PRIVATE-TOKEN: <your_access_token>" --request "DELETE" "https://gitlab.example.com/api/v4/projects/1/pipelines/46"