환경 API

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

GitLab 16.2에서 GitLab CI/CD 작업 토큰 인증을 지원합니다.

환경 목록

특정 프로젝트의 모든 환경을 가져옵니다.

GET /projects/:id/environments

속성	유형	필수	설명
`id`	정수/문자열	예	프로젝트의 ID 또는 URL 인코딩된 경로입니다.
`name`	문자열	아니요	해당 이름의 환경을 반환합니다. `search`와 상호 배타적입니다.
`search`	문자열	아니요	검색 기준과 일치하는 환경 목록을 반환합니다. `name`과 상호 배타적이며 적어도 3자 이상이어야 합니다.
`states`	문자열	아니요	특정 상태와 일치하는 모든 환경을 나열합니다. 허용되는 값: `available`, `stopping`, 또는 `stopped`입니다. 상태 값이 주어지지 않으면 모든 환경을 반환합니다.

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.gitlab.example.com",
    "state": "available",
    "tier": "development",
    "created_at": "2019-05-25T18:55:13.252Z",
    "updated_at": "2019-05-27T18:55:13.252Z",
    "enable_advanced_logs_querying": false,
    "logs_api_path": "/project/-/logs/k8s.json?environment_name=review%2Ffix-foo"
  }
]

특정 환경 가져오기

GET /projects/:id/environments/:environment_id

속성	유형	필수	설명
`id`	정수/문자열	예	프로젝트의 ID 또는 URL 인코딩된 경로입니다.
`environment_id`	정수	예	환경의 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.gitlab.example.com",
  "state": "available",
  "tier": "development",
  "created_at": "2019-05-25T18:55:13.252Z",
  "updated_at": "2019-05-27T18:55:13.252Z",
  "enable_advanced_logs_querying": false,
  "logs_api_path": "/project/-/logs/k8s.json?environment_name=review%2Ffix-foo",
  "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,
      "project": {
        "ci_job_token_scope_enabled": false
      },
      "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
    }
  }
}

새로운 환경 만들기

지정된 이름과 external_url로 새 환경을 만듭니다.

환경이 성공적으로 생성된 경우 201을 반환하고, 잘못된 매개변수인 경우 400을 반환합니다.

POST /projects/:id/environments

속성	타입	필수 여부	설명
`id`	정수/문자열	예	프로젝트의 ID 또는 URL-encoded path.
`name`	문자열	예	환경의 이름입니다.
`external_url`	문자열	아니오	이 환경에 대한 링크가 위치합니다.
`tier`	문자열	아니오	새 환경의 티어입니다. 허용된 값은 `production`, `staging`, `testing`, `development`, 및 `other`입니다.

curl --data "name=deploy&external_url=https://deploy.gitlab.example.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.gitlab.example.com",
  "state": "available",
  "tier": "production",
  "created_at": "2019-05-25T18:55:13.252Z",
  "updated_at": "2019-05-27T18:55:13.252Z"
}

기존 환경 업데이트하기

파라미터 name은 GitLab 16.0에서 제거됨.

기존 환경의 이름과/또는 external_url을 업데이트합니다.

환경이 성공적으로 업데이트된 경우 200을 반환합니다. 에러가 발생한 경우 400 상태 코드가 반환됩니다.

PUT /projects/:id/environments/:environments_id

속성	타입	필수 여부	설명
`id`	정수/문자열	예	프로젝트의 ID 또는 URL-encoded path.
`environment_id`	정수	예	환경의 ID입니다.
`external_url`	문자열	아니오	새 `external_url`입니다.
`tier`	문자열	아니오	새 환경의 티어입니다. 허용된 값은 `production`, `staging`, `testing`, `development`, 및 `other`입니다.

curl --request PUT --data "external_url=https://staging.gitlab.example.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.gitlab.example.com",
  "state": "available",
  "tier": "staging",
  "created_at": "2019-05-25T18:55:13.252Z",
  "updated_at": "2019-05-27T18:55:13.252Z"
}

환경 삭제하기

환경이 성공적으로 삭제된 경우 204를 반환하며, 환경이 존재하지 않는 경우 404를 반환합니다. 환경은 먼저 중지되어야 하며, 그렇지 않은 경우 요청은 403을 반환합니다.

DELETE /projects/:id/environments/:environment_id

속성	타입	필수 여부	설명
`id`	정수/문자열	예	프로젝트의 ID 또는 URL-encoded path.
`environment_id`	정수	예	환경의 ID입니다.

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

중지된 여러 리뷰 앱 삭제하기

GitLab 14.2에서 도입됨.

이미 중지된 리뷰 앱 폴더에 있는 여러 환경을 삭제하기 위해 일정을 잡습니다. 실제 삭제는 실행 시간으로부터 1주일 후에 수행됩니다. 기본적으로 30일 이전의 환경만 삭제합니다. before 매개변수를 사용하여 이 기본값을 변경할 수 있습니다.

DELETE /projects/:id/environments/review_apps

속성	타입	필수 여부	설명
`id`	정수/문자열	예	프로젝트의 ID 또는 URL-encoded path.
`before`	날짜/시간	아니오	환경이 삭제될 날짜 이전입니다. 기본값은 30일 전입니다. ISO 8601 형식 (`YYYY-MM-DDTHH:MM:SSZ`)으로 예상됩니다.
`limit`	정수	아니오	삭제할 환경의 최대 수입니다. 기본값은 100입니다.
`dry_run`	부울	아니오	안전을 위해 기본적으로 `true`입니다. 실제 삭제되지 않는 시뮬레이션을 수행합니다. 환경을 실제로 삭제하려면 `false`로 설정합니다.

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

예시 응답:

{
  "scheduled_entries": [
    {
      "id": 387,
      "name": "review/023f1bce01229c686a73",
      "slug": "review-023f1bce01-3uxznk",
      "external_url": null
    },
    {
      "id": 388,
      "name": "review/85d4c26a388348d3c4c0",
      "slug": "review-85d4c26a38-5giw1c",
      "external_url": null
    }
  ],
  "unprocessable_entries": []
}

환경 중지

환경이 성공적으로 중지되면 200을 반환하고, 환경이 없는 경우 404를 반환합니다.

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

속성	타입	필수	설명
`id`	integer/string	yes	프로젝트의 ID 또는 URL 인코딩 경로
`environment_id`	integer	yes	환경의 ID
`force`	boolean	no	`on_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.gitlab.example.com",
  "state": "stopped",
  "created_at": "2019-05-25T18:55:13.252Z",
  "updated_at": "2019-05-27T18:55:13.252Z"
}

오래된 환경 중지

지정된 날짜 이전에 마지막으로 수정되거나 배포된 모든 환경에 중지 요청을 발행합니다. 보호된 환경은 제외됩니다. 중지 요청이 성공하면 200을 반환하고, 이전 날짜가 잘못된 경우 400을 반환합니다. 환경이 정확히 언제 중지되는지에 대한 자세한 내용은 환경 중지를 참조하세요.

POST /projects/:id/environments/stop_stale

속성	타입	필수	설명
`id`	integer/string	yes	프로젝트의 ID 또는 URL 인코딩 경로
`before`	date	yes	지정된 날짜 이전에 수정되거나 배포된 환경을 중지합니다. ISO 8601 형식(`2019-03-15T08:00:00Z`)으로 예상됩니다. 올바른 입력 범위는 10년 전부터 1주일 전까지입니다.

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/environments/stop_stale?before=10%2F10%2F2021"

예시 응답:

{
  "message": "모든 오래된 환경에 대한 중지 요청이 성공적으로 수행되었습니다"
}

환경 API

환경 목록

특정 환경 가져오기

새로운 환경 만들기

기존 환경 업데이트하기

환경 삭제하기

중지된 여러 리뷰 앱 삭제하기

환경 중지

오래된 환경 중지

도움말

기능 사용 가능성과 제품 평가판

도움받기