Environments API

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

• List environments
• Get a specific environment
• Create a new environment
• Edit an existing environment
• Delete an environment
• Stop an environment

Environments API

List environments

获取给定项目的所有环境.

GET /projects/:id/environments

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments?name=review%2Ffix-foo"

响应示例：

[  {  "id":  1,  "name":  "review/fix-foo",  "slug":  "review-fix-foo-dfjre3",  "external_url":  "https://review-fix-foo-dfjre3.example.gitlab.com",  "state":  "available"  }  ]

Get a specific environment

GET /projects/:id/environments/:environment_id

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

回应范例

{  "id":  1,  "name":  "review/fix-foo",  "slug":  "review-fix-foo-dfjre3",  "external_url":  "https://review-fix-foo-dfjre3.example.gitlab.com"  "state":  "available",  "last_deployment":  {  "id":  100,  "iid":  34,  "ref":  "fdroid",  "sha":  "416d8ea11849050d3d1f5104cf8cf51053e790ab",  "created_at":  "2019-03-25T18:55:13.252Z",  "status":  "success",  "user":  {  "id":  1,  "name":  "Administrator",  "state":  "active",  "username":  "root",  "avatar_url":  "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",  "web_url":  "http://localhost:3000/root"  }  "deployable":  {  "id":  710,  "status":  "success",  "stage":  "deploy",  "name":  "staging",  "ref":  "fdroid",  "tag":  false,  "coverage":  null,  "created_at":  "2019-03-25T18:55:13.215Z",  "started_at":  "2019-03-25T12:54:50.082Z",  "finished_at":  "2019-03-25T18:55:13.216Z",  "duration":  21623.13423,  "user":  {  "id":  1,  "name":  "Administrator",  "username":  "root",  "state":  "active",  "avatar_url":  "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",  "web_url":  "http://gitlab.dev/root",  "created_at":  "2015-12-21T13:14:24.077Z",  "bio":  null,  "location":  null,  "public_email":  "",  "skype":  "",  "linkedin":  "",  "twitter":  "",  "website_url":  "",  "organization":  null  }  "commit":  {  "id":  "416d8ea11849050d3d1f5104cf8cf51053e790ab",  "short_id":  "416d8ea1",  "created_at":  "2016-01-02T15:39:18.000Z",  "parent_ids":  [  "e9a4449c95c64358840902508fc827f1a2eab7df"  ],  "title":  "Removed fabric to fix #40",  "message":  "Removed fabric to fix #40\n",  "author_name":  "Administrator",  "author_email":  "admin@example.com",  "authored_date":  "2016-01-02T15:39:18.000Z",  "committer_name":  "Administrator",  "committer_email":  "admin@example.com",  "committed_date":  "2016-01-02T15:39:18.000Z"  },  "pipeline":  {  "id":  34,  "sha":  "416d8ea11849050d3d1f5104cf8cf51053e790ab",  "ref":  "fdroid",  "status":  "success",  "web_url":  "http://localhost:3000/Commit451/lab-coat/pipelines/34"  },  "web_url":  "http://localhost:3000/Commit451/lab-coat/-/jobs/710",  "artifacts":  [  {  "file_type":  "trace",  "size":  1305,  "filename":  "job.log",  "file_format":  null  }  ],  "runner":  null,  "artifacts_expire_at":  null  }  }  }

Create a new environment

使用给定名称和external_url创建一个新环境.

如果成功创建了环境，则返回201否则返回400 .

POST /projects/:id/environments

curl --data "name=deploy&external_url=https://deploy.example.gitlab.com" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments"

响应示例：

{  "id":  1,  "name":  "deploy",  "slug":  "deploy",  "external_url":  "https://deploy.example.gitlab.com",  "state":  "available"  }

Edit an existing environment

更新现有环境的名称和/或external_url .

如果成功更新了环境，它将返回200 . 如果出现错误，则返回状态码400 .

PUT /projects/:id/environments/:environments_id

curl --request PUT --data "name=staging&external_url=https://staging.example.gitlab.com" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments/1"

响应示例：

{  "id":  1,  "name":  "staging",  "slug":  "staging",  "external_url":  "https://staging.example.gitlab.com",  "state":  "available"  }

Delete an environment

如果成功删除了环境，则返回204如果环境不存在，则返回404 .

DELETE /projects/:id/environments/:environment_id

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

Stop an environment

如果成功停止了环境，则返回200如果环境不存在，则返回404 .

POST /projects/:id/environments/:environment_id/stop

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

响应示例：

{  "id":  1,  "name":  "deploy",  "slug":  "deploy",  "external_url":  "https://deploy.example.gitlab.com",  "state":  "stopped"  }