InfoGrab DocsInfoGrab Docs

배치 백그라운드 마이그레이션 API

요약

이 API를 사용해 배치 백그라운드 마이그레이션을 모니터링하고 관리합니다. 모든 배치 백그라운드 마이그레이션을 나열합니다. 성공하면 200 OK와 다음 응답 속성을 반환합니다. 배치 백그라운드 마이그레이션 하나를 조회합니다.

이 API를 사용해 배치 백그라운드 마이그레이션을 모니터링하고 관리합니다.

사전 요구 사항:

  • 인스턴스에 대한 관리자 액세스 권한이 있어야 합니다.

최근 20개의 배치 백그라운드 마이그레이션 목록 조회#

모든 배치 백그라운드 마이그레이션을 나열합니다.

GET /api/v4/admin/batched_background_migrations

지원되는 속성:

속성 유형 필수 설명
database string 아니요 데이터베이스의 이름입니다. 기본값은 main입니다.
job_class_name string 아니요 job 클래스 이름으로 마이그레이션을 필터링합니다.

성공하면 200 OK와 다음 응답 속성을 반환합니다.

속성 유형 설명
column_name string 마이그레이션이 순회하는 열의 이름입니다.
created_at datetime 마이그레이션이 생성된 타임스탬프입니다.
estimated_time_remaining string 마이그레이션이 완료될 때까지 예상 시간입니다. 값이 null일 수 있습니다.
id integer 배치 백그라운드 마이그레이션의 ID입니다.
job_class_name string 마이그레이션 job 클래스의 이름입니다.
progress float 마이그레이션의 완료 비율입니다.
status string 마이그레이션의 상태입니다. paused, active, finished, failed, finalizing, finalized 중 하나일 수 있습니다.
table_name string 마이그레이션이 순회하는 테이블의 이름입니다.

요청 예시:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/batched_background_migrations"

응답 예시:

[
  {
    "id": 1234,
    "job_class_name": "CopyColumnUsingBackgroundMigrationJob",
    "table_name": "events",
    "column_name": "id",
    "status": "active",
    "progress": 50.0,
    "created_at": "2022-11-28T16:26:39+02:00",
    "estimated_time_remaining": "1 day"
  }
]

배치 백그라운드 마이그레이션 조회#

배치 백그라운드 마이그레이션 하나를 조회합니다.

GET /api/v4/admin/batched_background_migrations/:id

지원되는 속성:

속성 유형 필수 설명
id integer 예 배치 백그라운드 마이그레이션의 ID입니다.
database string 아니요 데이터베이스의 이름입니다. 기본값은 main입니다.

성공하면 200 OK와 다음 응답 속성을 반환합니다.

속성 유형 설명
column_name string 마이그레이션이 순회하는 열의 이름입니다.
created_at datetime 마이그레이션이 생성된 타임스탬프입니다.
estimated_time_remaining string 마이그레이션이 완료될 때까지 예상 시간입니다.
id integer 배치 백그라운드 마이그레이션의 ID입니다.
job_class_name string 마이그레이션 job 클래스의 이름입니다.
progress float 마이그레이션의 완료 비율입니다.
status string 마이그레이션의 상태입니다. paused, active, finished, failed, finalizing, finalized 중 하나일 수 있습니다.
table_name string 마이그레이션이 순회하는 테이블의 이름입니다.

요청 예시:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/batched_background_migrations/1234"

응답 예시:

{
  "id": 1234,
  "job_class_name": "CopyColumnUsingBackgroundMigrationJob",
  "table_name": "events",
  "column_name": "id",
  "status": "active",
  "progress": 50.0,
  "created_at": "2022-11-28T16:26:39+02:00",
  "estimated_time_remaining": "1 day"
}

배치 백그라운드 마이그레이션 일시 중지#

배치 백그라운드 마이그레이션을 일시 중지합니다. 상태가 active인 마이그레이션만 일시 중지할 수 있습니다.

PUT /api/v4/admin/batched_background_migrations/:id/pause

지원되는 속성:

속성 유형 필수 설명
id integer 예 배치 백그라운드 마이그레이션의 ID입니다.
database string 아니요 데이터베이스의 이름입니다. 기본값은 main입니다.

성공하면 200 OK와 다음 응답 속성을 반환합니다.

속성 유형 설명
column_name string 마이그레이션이 순회하는 열의 이름입니다.
created_at datetime 마이그레이션이 생성된 타임스탬프입니다.
estimated_time_remaining string 마이그레이션이 완료될 때까지 예상 시간입니다.
id integer 배치 백그라운드 마이그레이션의 ID입니다.
job_class_name string 마이그레이션 job 클래스의 이름입니다.
progress float 마이그레이션의 완료 비율입니다.
status string 마이그레이션의 상태입니다. paused, active, finished, failed, finalizing, finalized 중 하나일 수 있습니다.
table_name string 마이그레이션이 순회하는 테이블의 이름입니다.

마이그레이션 상태가 active가 아니면 422 Unprocessable Entity를 반환합니다.

요청 예시:

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/batched_background_migrations/1234/pause"

응답 예시:

{
  "id": 1234,
  "job_class_name": "CopyColumnUsingBackgroundMigrationJob",
  "table_name": "events",
  "column_name": "id",
  "status": "paused",
  "progress": 50.0,
  "created_at": "2022-11-28T16:26:39+02:00",
  "estimated_time_remaining": "1 day"
}

배치 백그라운드 마이그레이션 재개#

배치 백그라운드 마이그레이션을 재개합니다. 상태가 paused인 마이그레이션만 재개할 수 있습니다.

PUT /api/v4/admin/batched_background_migrations/:id/resume

지원되는 속성:

속성 유형 필수 설명
id integer 예 배치 백그라운드 마이그레이션의 ID입니다.
database string 아니요 데이터베이스의 이름입니다. 기본값은 main입니다.

성공하면 200 OK와 다음 응답 속성을 반환합니다.

속성 유형 설명
column_name string 마이그레이션이 순회하는 열의 이름입니다.
created_at datetime 마이그레이션이 생성된 타임스탬프입니다.
estimated_time_remaining string 마이그레이션이 완료될 때까지 예상 시간입니다.
id integer 배치 백그라운드 마이그레이션의 ID입니다.
job_class_name string 마이그레이션 job 클래스의 이름입니다.
progress float 마이그레이션의 완료 비율입니다.
status string 마이그레이션의 상태입니다. paused, active, finished, failed, finalizing, finalized 중 하나일 수 있습니다.
table_name string 마이그레이션이 순회하는 테이블의 이름입니다.

마이그레이션 상태가 paused가 아니면 422 Unprocessable Entity를 반환합니다.

요청 예시:

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/batched_background_migrations/1234/resume"

응답 예시:

{
  "id": 1234,
  "job_class_name": "CopyColumnUsingBackgroundMigrationJob",
  "table_name": "events",
  "column_name": "id",
  "status": "active",
  "progress": 50.0,
  "created_at": "2022-11-28T16:26:39+02:00",
  "estimated_time_remaining": "1 day"
}

배치 백그라운드 마이그레이션 API

GitLab v19.6
Tier: Free, Premium, Ultimate
Offering: GitLab Self-Managed
원문 보기

요약

이 API를 사용해 배치 백그라운드 마이그레이션을 모니터링하고 관리합니다. 모든 배치 백그라운드 마이그레이션을 나열합니다. 성공하면 200 OK와 다음 응답 속성을 반환합니다. 배치 백그라운드 마이그레이션 하나를 조회합니다.

이 API를 사용해 배치 백그라운드 마이그레이션을 모니터링하고 관리합니다.

사전 요구 사항:

  • 인스턴스에 대한 관리자 액세스 권한이 있어야 합니다.

최근 20개의 배치 백그라운드 마이그레이션 목록 조회#

모든 배치 백그라운드 마이그레이션을 나열합니다.

GET /api/v4/admin/batched_background_migrations

지원되는 속성:

속성 유형 필수 설명
database string 아니요 데이터베이스의 이름입니다. 기본값은 main입니다.
job_class_name string 아니요 job 클래스 이름으로 마이그레이션을 필터링합니다.

성공하면 200 OK와 다음 응답 속성을 반환합니다.

속성 유형 설명
column_name string 마이그레이션이 순회하는 열의 이름입니다.
created_at datetime 마이그레이션이 생성된 타임스탬프입니다.
estimated_time_remaining string 마이그레이션이 완료될 때까지 예상 시간입니다. 값이 null일 수 있습니다.
id integer 배치 백그라운드 마이그레이션의 ID입니다.
job_class_name string 마이그레이션 job 클래스의 이름입니다.
progress float 마이그레이션의 완료 비율입니다.
status string 마이그레이션의 상태입니다. paused, active, finished, failed, finalizing, finalized 중 하나일 수 있습니다.
table_name string 마이그레이션이 순회하는 테이블의 이름입니다.

요청 예시:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/batched_background_migrations"

응답 예시:

[
  {
    "id": 1234,
    "job_class_name": "CopyColumnUsingBackgroundMigrationJob",
    "table_name": "events",
    "column_name": "id",
    "status": "active",
    "progress": 50.0,
    "created_at": "2022-11-28T16:26:39+02:00",
    "estimated_time_remaining": "1 day"
  }
]

배치 백그라운드 마이그레이션 조회#

배치 백그라운드 마이그레이션 하나를 조회합니다.

GET /api/v4/admin/batched_background_migrations/:id

지원되는 속성:

속성 유형 필수 설명
id integer 예 배치 백그라운드 마이그레이션의 ID입니다.
database string 아니요 데이터베이스의 이름입니다. 기본값은 main입니다.

성공하면 200 OK와 다음 응답 속성을 반환합니다.

속성 유형 설명
column_name string 마이그레이션이 순회하는 열의 이름입니다.
created_at datetime 마이그레이션이 생성된 타임스탬프입니다.
estimated_time_remaining string 마이그레이션이 완료될 때까지 예상 시간입니다.
id integer 배치 백그라운드 마이그레이션의 ID입니다.
job_class_name string 마이그레이션 job 클래스의 이름입니다.
progress float 마이그레이션의 완료 비율입니다.
status string 마이그레이션의 상태입니다. paused, active, finished, failed, finalizing, finalized 중 하나일 수 있습니다.
table_name string 마이그레이션이 순회하는 테이블의 이름입니다.

요청 예시:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/batched_background_migrations/1234"

응답 예시:

{
  "id": 1234,
  "job_class_name": "CopyColumnUsingBackgroundMigrationJob",
  "table_name": "events",
  "column_name": "id",
  "status": "active",
  "progress": 50.0,
  "created_at": "2022-11-28T16:26:39+02:00",
  "estimated_time_remaining": "1 day"
}

배치 백그라운드 마이그레이션 일시 중지#

배치 백그라운드 마이그레이션을 일시 중지합니다. 상태가 active인 마이그레이션만 일시 중지할 수 있습니다.

PUT /api/v4/admin/batched_background_migrations/:id/pause

지원되는 속성:

속성 유형 필수 설명
id integer 예 배치 백그라운드 마이그레이션의 ID입니다.
database string 아니요 데이터베이스의 이름입니다. 기본값은 main입니다.

성공하면 200 OK와 다음 응답 속성을 반환합니다.

속성 유형 설명
column_name string 마이그레이션이 순회하는 열의 이름입니다.
created_at datetime 마이그레이션이 생성된 타임스탬프입니다.
estimated_time_remaining string 마이그레이션이 완료될 때까지 예상 시간입니다.
id integer 배치 백그라운드 마이그레이션의 ID입니다.
job_class_name string 마이그레이션 job 클래스의 이름입니다.
progress float 마이그레이션의 완료 비율입니다.
status string 마이그레이션의 상태입니다. paused, active, finished, failed, finalizing, finalized 중 하나일 수 있습니다.
table_name string 마이그레이션이 순회하는 테이블의 이름입니다.

마이그레이션 상태가 active가 아니면 422 Unprocessable Entity를 반환합니다.

요청 예시:

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/batched_background_migrations/1234/pause"

응답 예시:

{
  "id": 1234,
  "job_class_name": "CopyColumnUsingBackgroundMigrationJob",
  "table_name": "events",
  "column_name": "id",
  "status": "paused",
  "progress": 50.0,
  "created_at": "2022-11-28T16:26:39+02:00",
  "estimated_time_remaining": "1 day"
}

배치 백그라운드 마이그레이션 재개#

배치 백그라운드 마이그레이션을 재개합니다. 상태가 paused인 마이그레이션만 재개할 수 있습니다.

PUT /api/v4/admin/batched_background_migrations/:id/resume

지원되는 속성:

속성 유형 필수 설명
id integer 예 배치 백그라운드 마이그레이션의 ID입니다.
database string 아니요 데이터베이스의 이름입니다. 기본값은 main입니다.

성공하면 200 OK와 다음 응답 속성을 반환합니다.

속성 유형 설명
column_name string 마이그레이션이 순회하는 열의 이름입니다.
created_at datetime 마이그레이션이 생성된 타임스탬프입니다.
estimated_time_remaining string 마이그레이션이 완료될 때까지 예상 시간입니다.
id integer 배치 백그라운드 마이그레이션의 ID입니다.
job_class_name string 마이그레이션 job 클래스의 이름입니다.
progress float 마이그레이션의 완료 비율입니다.
status string 마이그레이션의 상태입니다. paused, active, finished, failed, finalizing, finalized 중 하나일 수 있습니다.
table_name string 마이그레이션이 순회하는 테이블의 이름입니다.

마이그레이션 상태가 paused가 아니면 422 Unprocessable Entity를 반환합니다.

요청 예시:

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/batched_background_migrations/1234/resume"

응답 예시:

{
  "id": 1234,
  "job_class_name": "CopyColumnUsingBackgroundMigrationJob",
  "table_name": "events",
  "column_name": "id",
  "status": "active",
  "progress": 50.0,
  "created_at": "2022-11-28T16:26:39+02:00",
  "estimated_time_remaining": "1 day"
}