listBackupOperations

이 가이드는 API 명세를 기반으로 AI가 자동 생성했습니다.

VPC 환경에서 이용 가능합니다.

Ncloud 표준 표현을 적용한 API입니다.

클러스터 백업 작업(백업 내보내기)의 Operation 목록을 조회합니다. operationType으로 필터링할 수 있습니다. 정렬 가능 키는 startDateTime, endDateTime, operationType이며 기본 정렬은 startDateTime,desc입니다. 정렬 키가 고유하지 않은 경우 id 기준으로 안정 정렬합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET	/clusters/{clusterName}/backups/operations

요청 헤더

Cloud DB Serverless API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud DB Serverless 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`clusterName`	String	Required	클러스터 이름 (cluster의 name) 패턴: `^[a-z0-9-]+$` 길이: 3 ~ 30 <예시> new-cluster

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`operationType`	String	Optional	작업 유형 필터 (생략 시 전체) `CREATE` \| `UPDATE` \| `DELETE`
`pageNo`	Integer (int32)	Optional	페이지 번호 (0부터 시작) 범위: 0 ~ 기본값: 0 <예시> 0
`pageSize`	Integer (int32)	Optional	페이지 크기 범위: 1 ~ 100 기본값: 20 <예시> 20
`sort`	List<String>	Optional	정렬 기준 — `<field>,<asc\|desc>` 형식. 반복 지정으로 다중 정렬. 허용 정렬 키와 기본 정렬 순서는 각 operation 설명 참고. <예시> `["name,asc"]`

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://clouddb-serverless.apigw.ntruss.com/mysql/v1/clusters/new-cluster/backups/operations' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`operations`	List<Operation>	-	Operation 목록
`pageNo`	Integer (int32)	-	페이지 번호 (0부터 시작) <예시> 0
`pageSize`	Integer (int32)	-	페이지 크기 <예시> 20
`totalElements`	Integer (int32)	-	전체 항목 수 <예시> 3
`totalPages`	Integer (int32)	-	전체 페이지 수 <예시> 1

Operation

Long-Running Operation. done=true && error 없음 = 성공.

필드	타입	필수 여부	설명
`id`	String (uuid)	-	Operation 식별자 <예시> 550e8400-e29b-41d4-a716-446655440000
`done`	Boolean	-	완료 여부 `true` \| `false` `true`: 완료 `false`: 진행 중 <예시> false
`metadata`	Object	-	작업 유형·대상 리소스·시각 등 Operation 부가 정보
`metadata.operationType`	String	-	작업 유형 `CREATE` \| `UPDATE` \| `DELETE` `CREATE`: 생성 `UPDATE`: 변경 `DELETE`: 삭제 <예시> CREATE
`metadata.resourceType`	String	-	대상 리소스 (REST 경로의 리소스 세그먼트와 일치 — 컬렉션은 복수형, 싱글턴은 경로 그대로) <예시> users
`metadata.startDateTime`	String (date-time)	-	작업 시작 시각 (RFC3339 UTC) <예시> 2026-07-21T10:00:00Z
`metadata.endDateTime`	String (date-time) \| null	-	완료 시각 (진행 중이면 null)
`metadata.progress`	Integer (int32) \| null	-	진행률 (%) — 제공 가능한 작업에 한함 범위: 0 ~ 100
`results`	Map<Object> \| null	-	성공 결과. 요청 인덱스를 키로 하는 Map이며 단건 작업은 "0" 키 하나를 사용. 클러스터 작업(resourceType=clusters: 생성·복원·변경·삭제)만 값을 반환하며, 값은 대상 클러스터의 name 하나를 담은 객체. 그 외 리소스(users, databases, config, backups, imported-backups, logs, processes)의 작업은 null.
`error`	Object	-	실패 사유 (단건 작업)
`error.errorCode`	String	-	에러 코드
`error.message`	String	-	에러 메시지 (기본 영어, 다국어 지원 가능)
`error.detail`	String	-	에러 상세 정보 (기본 영어, 다국어 지원 가능)
`error.fieldErrors`	List<FieldError>	-	입력값 에러가 발생한 경우 각 필드별 에러 상세 정보 목록
`failures`	Map<Error> \| null	-	일괄 작업의 index별 실패 사유

results

필드	타입	필수 여부	설명
`name`	String	-	작업 대상 클러스터 이름 <예시> new-cluster

FieldError

필드 에러 정보

필드	타입	필수 여부	설명
`message`	String	-	필드 에러 메시지 (기본 영어, 다국어 지원 가능)
`field`	String	-	입력값 검증 실패 시 해당 필드 이름

Error

에러 정보

필드	타입	필수 여부	설명
`errorCode`	String	-	에러 코드
`message`	String	-	에러 메시지 (기본 영어, 다국어 지원 가능)
`detail`	String	-	에러 상세 정보 (기본 영어, 다국어 지원 가능)
`fieldErrors`	List<FieldError>	-	입력값 에러가 발생한 경우 각 필드별 에러 상세 정보 목록

응답 상태 코드

Cloud DB Serverless API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud DB Serverless 응답 상태 코드를 참조해 주십시오.

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

HTTP 상태 코드	코드	메시지	설명
200	-	-	Operation 목록
400	InvalidParameter	The specified parameter is invalid.	파라미터 값이 허용 범위나 형식을 벗어난 경우

응답 예시

응답 예시는 다음과 같습니다.

{
  "operations": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "done": false,
      "metadata": {
        "operationType": "CREATE",
        "resourceType": "backups",
        "startDateTime": "2026-07-21T10:00:00Z"
      },
      "results": {
        "key": {
          "name": "new-cluster"
        }
      }
    }
  ],
  "pageNo": 0,
  "pageSize": 20,
  "totalElements": 3,
  "totalPages": 1
}