Documentation Index

Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

GetObjectLegalHold

Prev Next

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

Ncloud Storage 객체에 설정된 법적 보존(Legal Hold) 상태를 조회합니다.

요청

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

메서드 URI
GET /{Key}

요청 헤더

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

요청 경로 파라미터

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

필드 타입 필수 여부 설명
Key String Required 객체 이름

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
versionId String Optional 법적 보존 상태를 조회할 객체의 버전 ID
  • 미 입력 시 최신 버전 조회

요청 예시

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

GET /object.csv?legal-hold HTTP/1.1
Host: {Bucket}.kr.ncloudstorage.com

응답

응답 형식을 설명합니다.

응답 헤더

Ncloud Storage API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Storage 응답 헤더를 참조해 주십시오.

응답 바디

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

필드 타입 필수 여부 설명
LegalHold Object - 법적 보존 설정
LegalHold.Status String - 법적 보존 상태
  • ON | OFF

응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

참고

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

에러 코드 HTTP 상태 코드 설명
InvalidRequest 400 버킷에 Object Lock 설정이 없음
NoSuchObjectLockConfiguration 404 객체에 법적 보존 설정이 없음
NoSuchKey 404 지정한 객체가 존재하지 않음
NoSuchVersion 404 지정한 버전이 존재하지 않음

응답 예시

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

HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<LegalHold xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Status>ON</Status>
</LegalHold>