– stage: Deploy group: Environments info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments title: 群组级别的受保护环境 API —

{{< details >}}

  • Tier: 专业版, 旗舰版
  • Offering: JihuLab.com, 私有化部署

{{< /details >}}

{{< history >}}

  • 在极狐GitLab 14.0 中引入。使用名为 group_level_protected_environments 的功能标志，默认禁用。
  • 在极狐GitLab 14.3 中移除 group_level_protected_environments 功能标志。
  • 在极狐GitLab 14.3 中 GA。

{{< /history >}}

阅读更多关于群组级别的受保护环境信息。

有效访问级别

访问级别在 ProtectedEnvironments::DeployAccessLevel::ALLOWED_ACCESS_LEVELS 方法中定义。目前，这些级别被识别：

30 => Developer access
40 => Maintainer access
60 => Admin access

列出群组级别的受保护环境

从一个群组获取受保护环境的列表。

GET /groups/:id/protected_environments
属性 类型 必需 描述
id integer/string yes 由认证用户维护的群组的 ID 或 URL 编码路径。 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/protected_environments/"

示例响应：

[
   {
      "name":"production",
      "deploy_access_levels":[
         {
            "id": 12,
            "access_level": 40,
            "access_level_description": "Maintainers",
            "user_id": null,
            "group_id": null
         }
      ],
      "required_approval_count": 0
   }
]

获取单个受保护环境

获取单个受保护环境。

GET /groups/:id/protected_environments/:name
属性 类型 必需 描述
id integer/string yes 由认证用户维护的群组的 ID 或 URL 编码路径。
name string yes 受保护环境的部署等级。可以是 production、staging、testing、development 或 other。阅读更多关于部署等级的信息。 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/protected_environments/production"

示例响应：

{
   "name":"production",
   "deploy_access_levels":[
      {
         "id": 12,
         "access_level":40,
         "access_level_description":"Maintainers",
         "user_id":null,
         "group_id":null
      }
   ],
   "required_approval_count": 0
}

保护单个环境

保护单个环境。

POST /groups/:id/protected_environments
属性 类型 必需 描述
id integer/string yes 由认证用户维护的群组的 ID 或 URL 编码路径。
name string yes 受保护环境的部署等级。可以是 production、staging、testing、development 或 other。阅读更多关于部署等级的信息。
deploy_access_levels array yes 允许部署的访问级别数组，每个由一个哈希描述。可以是 user_id、group_id 或 access_level。它们的形式分别为 {user_id: integer}、{group_id: integer} 或 {access_level: integer}。
approval_rules array no 允许批准的访问级别数组，每个由一个哈希描述。可以是 user_id、group_id 或 access_level。它们的形式分别为 {user_id: integer}、{group_id: integer} 或 {access_level: integer}。您还可以通过 required_approvals 字段指定来自指定实体所需的批准数量。查看更多多重批准规则的信息。

可分配的 user_id 是属于给定群组且具有 Maintainer 角色（或以上）的用户。可分配的 group_id 是给定群组下的子群组。

curl --header 'Content-Type: application/json' --request POST --data '{"name": "production", "deploy_access_levels": [{"group_id": 9899826}]}' --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/22034114/protected_environments"

示例响应：

{
   "name":"production",
   "deploy_access_levels":[
      {
         "id": 12,
         "access_level": 40,
         "access_level_description": "protected-access-group",
         "user_id": null,
         "group_id": 9899826
      }
   ],
   "required_approval_count": 0
}

一个具有多个批准规则的示例：

curl --header 'Content-Type: application/json' --request POST \
     --data '{"name": "production", "deploy_access_levels": [{"group_id": 138}], "approval_rules": [{"group_id": 134}, {"group_id": 135, "required_approvals": 2}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/groups/128/protected_environments"

在此配置中，操作员群组 "group_id": 138 只能在 QA 群组 "group_id": 134 和安全群组 "group_id": 135 批准部署后执行到 production 的部署任务。

更新受保护环境

{{< history >}}

  • 引入于极狐GitLab 15.4。

{{< /history >}}

更新单个环境。

PUT /groups/:id/protected_environments/:name
属性 类型 必需 描述
id integer/string yes 由认证用户维护的群组的 ID 或 URL 编码路径。
name string yes 受保护环境的部署等级。可以是 production、staging、testing、development 或 other。阅读更多关于部署等级的信息。
deploy_access_levels array no 允许部署的访问级别数组，每个由一个哈希描述。可以是 user_id、group_id 或 access_level。它们的形式分别为 {user_id: integer}、{group_id: integer} 或 {access_level: integer}。
required_approval_count integer no 部署到此环境所需的批准数量。
approval_rules array no 允许批准的访问级别数组，每个由一个哈希描述。可以是 user_id、group_id 或 access_level。它们的形式分别为 {user_id: integer}、{group_id: integer} 或 {access_level: integer}。您还可以通过 required_approvals 字段指定来自指定实体所需的批准数量。查看更多多重批准规则的信息。

要更新：

  • user_id: 确保更新的用户属于给定群组且具有 Maintainer 角色（或以上）。您还必须在相应的哈希中传递 deploy_access_level 或 approval_rule 的 id。
  • group_id: 确保更新的群组是该受保护环境所属群组的子群组。您还必须在相应的哈希中传递 deploy_access_level 或 approval_rule 的 id。

要删除：

  • 您必须传递 _destroy 设置为 true。请参见以下示例。

示例：创建一个 deploy_access_level 记录 

curl --header 'Content-Type: application/json' --request PUT \
     --data '{"deploy_access_levels": [{"group_id": 9899829, access_level: 40}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/groups/22034114/protected_environments/production"

示例响应：

{
   "name": "production",
   "deploy_access_levels": [
      {
         "id": 12,
         "access_level": 40,
         "access_level_description": "protected-access-group",
         "user_id": null,
         "group_id": 9899829,
         "group_inheritance_type": 1
      }
   ],
   "required_approval_count": 0
}

示例：更新一个 deploy_access_level 记录 

curl --header 'Content-Type: application/json' --request PUT \
     --data '{"deploy_access_levels": [{"id": 12, "group_id": 22034120}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/22034114/protected_environments/production"

{
   "name": "production",
   "deploy_access_levels": [
      {
         "id": 12,
         "access_level": 40,
         "access_level_description": "protected-access-group",
         "user_id": null,
         "group_id": 22034120,
         "group_inheritance_type": 0
      }
   ],
   "required_approval_count": 2
}

示例：删除一个 deploy_access_level 记录 

curl --header 'Content-Type: application/json' --request PUT \
     --data '{"deploy_access_levels": [{"id": 12, "_destroy": true}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/22034114/protected_environments/production"

示例响应：

{
   "name": "production",
   "deploy_access_levels": [],
   "required_approval_count": 0
}

示例：创建一个 approval_rule 记录 

curl --header 'Content-Type: application/json' --request PUT \
     --data '{"approval_rules": [{"group_id": 134, "required_approvals": 1}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/groups/22034114/protected_environments/production"

示例响应：

{
   "name": "production",
   "approval_rules": [
      {
         "id": 38,
         "user_id": null,
         "group_id": 134,
         "access_level": null,
         "access_level_description": "qa-group",
         "required_approvals": 1,
         "group_inheritance_type": 0
      }
   ]
}

示例：更新一个 approval_rule 记录 

curl --header 'Content-Type: application/json' --request PUT \
     --data '{"approval_rules": [{"id": 38, "group_id": 135, "required_approvals": 2}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/22034114/protected_environments/production"

{
   "name": "production",
   "approval_rules": [
      {
         "id": 38,
         "user_id": null,
         "group_id": 135,
         "access_level": null,
         "access_level_description": "security-group",
         "required_approvals": 2,
         "group_inheritance_type": 0
      }
   ]
}

示例：删除一个 approval_rule 记录 

curl --header 'Content-Type: application/json' --request PUT \
     --data '{"approval_rules": [{"id": 38, "_destroy": true}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/22034114/protected_environments/production"

示例响应：

{
   "name": "production",
   "approval_rules": []
}

取消保护单个环境

取消保护给定的受保护环境。

DELETE /groups/:id/protected_environments/:name
属性 类型 必需 描述
id integer/string yes 由认证用户维护的群组的 ID 或 URL 编码路径。
name string yes 受保护环境的部署等级。可以是 production、staging、testing、development 或 other。阅读更多关于部署等级的信息。 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/protected_environments/staging"

响应应该返回 200 代码。