그룹 수준 보호 환경 API

Tier: Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

그룹 수준 보호 환경에 대해 자세히 알아보세요.

유효한 액세스 레벨

액세스 레벨은 ProtectedEnvironments::DeployAccessLevel::ALLOWED_ACCESS_LEVELS 메서드에서 정의됩니다. 현재 다음 레벨을 인식합니다: 

30 => 개발자 액세스
40 => 유지 보수자 액세스
60 => 관리자 액세스

그룹 수준 보호 환경 디렉터리

그룹에서 보호된 환경 디렉터리을 가져옵니다. 

GET /groups/:id/protected_environments
속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 유지하는 그룹의 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": "유지 보수자",
            "user_id": null,
            "group_id": null
         }
      ],
      "required_approval_count": 0
   }
]

단일 보호된 환경 가져오기

단일 보호된 환경을 가져옵니다. 

GET /groups/:id/protected_environments/:name
속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 유지하는 그룹의 ID 또는 URL 인코딩된 경로.
name 문자열 예 보호된 환경의 배치 티어 중 하나. 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":"유지 보수자",
         "user_id":null,
         "group_id":null
      }
   ],
   "required_approval_count": 0
}

단일 환경 보호하기

단일 환경을 보호합니다. 

POST /groups/:id/protected_environments
속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 유지하는 그룹의 ID 또는 URL 인코딩된 경로.
name 문자열 예 보호된 환경의 배치 티어 중 하나. production, staging, testing, development, 또는 other 중 하나. 배포 티어에 대해 자세히 알아보세요.
deploy_access_levels 배열 예 각각이 해시로 설명되는 허용된 배포 액세스 레벨의 배열. user_id, group_id, 또는 access_level 중 하나. {user_id: 정수}, {group_id: 정수}, 또는 {access_level: 정수} 형식을 취합니다.
required_approval_count 정수 아니오 이 환경으로의 배포를 위해 필요한 승인 수.
approval_rules 배열 아니오 각각이 해시로 설명되는 승인 허용된 액세스 레벨의 배열. user_id, group_id, 또는 access_level 중 하나. {user_id: 정수}, {group_id: 정수}, 또는 {access_level: 정수} 형식을 취합니다. 또한 지정된 엔터티로부터 필요한 승인수를 required_approvals 필드로 지정할 수 있습니다. 자세한 정보는 다중 승인 규칙을 참조하세요.

할당할 수 있는 user_id는 유지 보수자 권한 또는 그 이상을 가진 지정된 그룹에 속한 사용자입니다. 할당할 수 있는 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": "보호된 액세스 그룹",
         "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으로의 배포 작업을 실행할 수 있습니다.

보호 환경 업데이트

단일 환경을 업데이트합니다. 

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}], "required_approval_count": 1}' \
     --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}], "required_approval_count": 2}' \
     --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}], "required_approval_count": 0}' \
     --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-encoded path입니다.
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 코드를 반환해야 합니다.