环境API
列表的环境
获取给定项目的所有环境。
/项目/:id /环境
属性 | 类型 | 要求 | 描述 |
---|---|---|---|
id |
整数或字符串 | 是的 | ID或项目的url编码路径被认证的用户所有 |
旋度——头“PRIVATE-TOKEN: 9 koxpg98eahejpvbs5tk”https://gitlab.example.com/api/v4/projects/1/environments
示例响应:
[{“id”:1,“名称”:“审查/ fix-foo”,“鼻涕虫”:“review-fix-foo-dfjre3”,“external_url”:“https://review-fix-foo-dfjre3.example.gitlab.com”}]
创造一个新环境
使用给定的名称和external_url创建一个新环境。
它返回201
如果环境被成功创建,400
错误的参数。
POST /项目/:id /环境
属性 | 类型 | 要求 | 描述 |
---|---|---|---|
id |
整数或字符串 | 是的 | ID或项目的url编码路径被认证的用户所有 |
名字 |
字符串 | 是的 | 环境的名称 |
external_url |
字符串 | 没有 | 此环境中要链接到的位置 |
旋度——数据“name = deploy&external_url = https://deploy.example.gitlab.com”——头“PRIVATE-TOKEN: 9 koxpg98eahejpvbs5tk”“https://gitlab.example.com/api/v4/projects/1/environments”
示例响应:
{“id”:1,“名称”:“部署”,“鼻涕虫”:“部署”,“external_url”:“https://deploy.example.gitlab.com”}
编辑现有环境
更新现有环境的名称和/或external_url。
它返回200
如果环境已成功更新。如果发生错误,则使用状态码400
返回。
/项目/:id /环境/:environments_id
属性 | 类型 | 要求 | 描述 |
---|---|---|---|
id |
整数或字符串 | 是的 | ID或项目的url编码路径被认证的用户所有 |
environment_id |
整数 | 是的 | 环境的ID |
名字 |
字符串 | 没有 | 环境的新名称 |
external_url |
字符串 | 没有 | 新的external_url |
旋度——请求把——数据“name = staging&external_url = https://staging.example.gitlab.com”——头“PRIVATE-TOKEN: 9 koxpg98eahejpvbs5tk”“https://gitlab.example.com/api/v4/projects/1/environments/1”
示例响应:
{“id”:1,“名称”:“暂存”,“鼻涕虫”:“暂存”,“external_url”:“https://staging.example.gitlab.com”}
删除环境
它返回204
如果环境已成功删除,则404
如果环境不存在。
删除/项目/:id /环境/:environment_id
属性 | 类型 | 要求 | 描述 |
---|---|---|---|
id |
整数或字符串 | 是的 | ID或项目的url编码路径被认证的用户所有 |
environment_id |
整数 | 是的 | 环境的ID |
旋度——请求删除——头“PRIVATE-TOKEN: 9 koxpg98eahejpvbs5tk”“https://gitlab.example.com/api/v4/projects/1/environments/1”
停止一个环境
它返回200
如果环境已成功停止,则404
如果环境不存在。
POST /项目/身份证/环境/:environment_id /停止
属性 | 类型 | 要求 | 描述 |
---|---|---|---|
id |
整数或字符串 | 是的 | ID或项目的url编码路径被认证的用户所有 |
environment_id |
整数 | 是的 | 环境的ID |
旋度——请求帖子——头“PRIVATE-TOKEN: 9 koxpg98eahejpvbs5tk”“https://gitlab.example.com/api/v3/projects/1/environments/1/stop”
示例响应:
{“id”:1,“名称”:“部署”,“鼻涕虫”:“部署”,“external_url”:“https://deploy.example.gitlab.com”}