동결 기간 API
Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
이 API를 사용하여 배포 동결 기간과 상호 작용합니다. created_at 기준 오름차순으로 정렬된 동결 기간의 페이지화된 목록입니다. 지정된 freeze_period_id에 대한 동결 기간을 가져옵니다. 지정된 프로젝트에 대한 동결 기간을 만듭니다.
이 API를 사용하여 배포 동결 기간과 상호 작용합니다.
동결 기간 나열#
created_at 기준 오름차순으로 정렬된 동결 기간의 페이지화된 목록입니다.
필수 요건:
- 프로젝트에 대한 Reporter, Developer, Maintainer 또는 Owner 역할이 있어야 합니다.
GET /projects/:id/freeze_periods
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 또는 문자열 | yes | 프로젝트의 ID 또는 URL 인코딩된 경로. |
예시 요청:
curl --request GET \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/19/freeze_periods"
예시 응답:
[
{
"id":1,
"freeze_start":"0 23 * * 5",
"freeze_end":"0 8 * * 1",
"cron_timezone":"UTC",
"created_at":"2020-05-15T17:03:35.702Z",
"updated_at":"2020-05-15T17:06:41.566Z"
}
]
동결 기간 가져오기#
지정된 freeze_period_id에 대한 동결 기간을 가져옵니다.
필수 요건:
- 프로젝트에 대한 Reporter, Developer, Maintainer 또는 Owner 역할이 있어야 합니다.
GET /projects/:id/freeze_periods/:freeze_period_id
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 또는 문자열 | yes | 프로젝트의 ID 또는 URL 인코딩된 경로. |
freeze_period_id |
정수 | yes | 동결 기간의 ID. |
예시 요청:
curl --request GET \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/19/freeze_periods/1"
예시 응답:
{
"id":1,
"freeze_start":"0 23 * * 5",
"freeze_end":"0 8 * * 1",
"cron_timezone":"UTC",
"created_at":"2020-05-15T17:03:35.702Z",
"updated_at":"2020-05-15T17:06:41.566Z"
}
동결 기간 만들기#
지정된 프로젝트에 대한 동결 기간을 만듭니다.
필수 요건:
- 프로젝트에 대한 Maintainer 또는 Owner 역할이 있어야 합니다.
POST /projects/:id/freeze_periods
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 또는 문자열 | yes | 프로젝트의 ID 또는 URL 인코딩된 경로. |
freeze_start |
문자열 | yes | cron 형식의 동결 기간 시작. |
freeze_end |
문자열 | yes | cron 형식의 동결 기간 종료. |
cron_timezone |
문자열 | no | cron 필드의 시간대. 제공하지 않으면 기본값은 UTC입니다. |
예시 요청:
curl --request POST \
--header 'Content-Type: application/json' \
--header "PRIVATE-TOKEN: <your_access_token>" \
--data '{ "freeze_start": "0 23 * * 5", "freeze_end": "0 7 * * 1", "cron_timezone": "UTC" }' \
--url "https://gitlab.example.com/api/v4/projects/19/freeze_periods"
예시 응답:
{
"id":1,
"freeze_start":"0 23 * * 5",
"freeze_end":"0 7 * * 1",
"cron_timezone":"UTC",
"created_at":"2020-05-15T17:03:35.702Z",
"updated_at":"2020-05-15T17:03:35.702Z"
}
동결 기간 업데이트#
지정된 freeze_period_id에 대한 동결 기간을 업데이트합니다.
필수 요건:
- 프로젝트에 대한 Maintainer 또는 Owner 역할이 있어야 합니다.
PUT /projects/:id/freeze_periods/:freeze_period_id
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 또는 문자열 | yes | 프로젝트의 ID 또는 URL 인코딩된 경로. |
freeze_period_id |
정수 | yes | 동결 기간의 ID. |
freeze_start |
문자열 | no | cron 형식의 동결 기간 시작. |
freeze_end |
문자열 | no | cron 형식의 동결 기간 종료. |
cron_timezone |
문자열 | no | cron 필드의 시간대. |
예시 요청:
curl --request PUT \
--header 'Content-Type: application/json' \
--header "PRIVATE-TOKEN: <your_access_token>" \
--data '{ "freeze_end": "0 8 * * 1" }' \
--url "https://gitlab.example.com/api/v4/projects/19/freeze_periods/1"
예시 응답:
{
"id":1,
"freeze_start":"0 23 * * 5",
"freeze_end":"0 8 * * 1",
"cron_timezone":"UTC",
"created_at":"2020-05-15T17:03:35.702Z",
"updated_at":"2020-05-15T17:06:41.566Z"
}
동결 기간 삭제#
지정된 freeze_period_id에 대한 동결 기간을 삭제합니다.
필수 요건:
- 프로젝트에 대한 Maintainer 또는 Owner 역할이 있어야 합니다.
DELETE /projects/:id/freeze_periods/:freeze_period_id
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
id |
정수 또는 문자열 | yes | 프로젝트의 ID 또는 URL 인코딩된 경로. |
freeze_period_id |
정수 | yes | 동결 기간의 ID. |
예시 요청:
curl --request DELETE \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/projects/19/freeze_periods/1"
