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.

GetObjectAttributes

Prev Next
This content is currently unavailable in Ja - 日本語. You are viewing the default (Korean) version.

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

Ncloud Storage 버킷에 저장된 객체의 메타데이터(속성)를 조회합니다.

요청

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

메서드 URI
GET /{Key}?attributes

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

참고

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

필드 필수 여부 설명
x-amz-object-attributes Required 조회할 객체 속성 목록
  • 콤마(,)로 구분하여 여러 개 지정 가능
  • ETag | ObjectSize | StorageClass | Checksum | ObjectParts
x-amz-max-parts Optional 응답에 포함할 최대 파트 수
  • x-amz-object-attributesObjectParts를 지정한 경우에 적용
  • 0~2,147,483,647
  • 미 입력 시 1,000
x-amz-part-number-marker Optional 파트 조회를 시작할 기준 파트 번호
  • 지정한 파트 번호 다음 파트부터 조회
  • 0~2,147,483,647
  • 미 입력 시 0
x-amz-server-side-encryption-customer-algorithm Optional 사용자 암호화 알고리즘 (AES256)
x-amz-server-side-encryption-customer-key Optional 사용자 제공 암호화 키
x-amz-server-side-encryption-customer-key-MD5 Optional 사용자 제공 암호화 키의 MD5 값

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
attributes String Required 객체 속성 조회 요청 구분
  • 값 없이 키만 지정
versionId String Optional 조회할 객체의 버전 ID
  • 미 입력 시 최신 버전 조회

요청 예시

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

GET /object.csv?attributes HTTP/1.1
Host: {Bucket}.kr.ncloudstorage.com
x-amz-object-attributes: ETag,ObjectSize,StorageClass

응답

응답 형식을 설명합니다.

응답 헤더

응답 헤더에 대한 설명은 다음과 같습니다.

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

필드 필수 여부 설명
Last-Modified - 객체의 마지막 수정 일시
x-amz-version-id - 객체의 버전 ID
  • 버전 관리가 활성화된 경우에 표시
x-amz-delete-marker - 삭제 마커 여부
  • 객체가 삭제 마커인 경우 true로 표시

응답 바디

응답 바디에 대한 설명은 다음과 같습니다. 요청한 속성(x-amz-object-attributes)에 해당하는 필드만 응답에 포함됩니다.

필드 타입 필수 여부 설명
GetObjectAttributesResponse Object - 객체 속성 조회 결과
GetObjectAttributesResponse.ETag String - 객체 고유 식별자(Entity Tag)
GetObjectAttributesResponse.ObjectSize Integer - 객체 크기(Byte)
GetObjectAttributesResponse.StorageClass String - 스토리지 클래스
  • STANDARD | DEEP_ARCHIVE
    • STANDARD: Standard Class
    • DEEP_ARCHIVE: Archive Class
GetObjectAttributesResponse.Checksum Object - 체크섬 정보
GetObjectAttributesResponse.ObjectParts Object - 멀티파트 객체의 파트 정보

Checksum

Checksum에 대한 설명은 다음과 같습니다. 객체에 설정된 체크섬 알고리즘에 해당하는 필드만 표시됩니다.

필드 타입 필수 여부 설명
ChecksumCRC32 String - CRC32 체크섬 값
ChecksumCRC32C String - CRC32C 체크섬 값
ChecksumSHA1 String - SHA1 체크섬 값
ChecksumSHA256 String - SHA256 체크섬 값
ChecksumCRC64NVME String - CRC64NVME 체크섬 값
ChecksumType String - 체크섬 타입
  • FULL_OBJECT | COMPOSITE

ObjectParts

ObjectParts에 대한 설명은 다음과 같습니다. 멀티파트 업로드로 생성된 객체에 대해 표시됩니다.

필드 타입 필수 여부 설명
IsTruncated Boolean - 이후 파트 존재 여부
  • true | false
    • true: 존재
    • false: 존재 안 함
MaxParts Integer - 응답에 포함된 최대 파트 수
PartNumberMarker Integer - 파트 조회를 시작한 기준 파트 번호
NextPartNumberMarker Integer - 다음 페이지 조회 기준 파트 번호
  • IsTruncatedtrue인 경우에 표시
PartsCount Integer - 객체의 전체 파트 수
Part Array - 파트 목록

Part

Part에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
PartNumber Integer - 파트 번호
Size Integer - 파트 크기(Byte)

응답 상태 코드

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

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

에러 코드 HTTP 상태 코드 설명
InvalidRequest 400 x-amz-object-attributes 헤더가 없거나 비어 있음
  • SSE-C로 암호화되지 않은 객체에 사용자 암호화 헤더를 지정함
InvalidArgument 400 유효하지 않은 속성 이름을 지정함
  • x-amz-max-parts, x-amz-part-number-marker 값이 유효 범위(0~2,147,483,647)를 벗어남
  • versionId 형식이 올바르지 않음
AccessDenied 403 객체에 접근할 권한이 없음
  • SSE-C 암호화 키가 올바르지 않음
NoSuchKey 404 지정한 객체가 존재하지 않음
NoSuchVersion 404 지정한 버전이 존재하지 않음
MethodNotAllowed 405 삭제 마커의 특정 버전을 조회함

응답 예시

모든 속성(ETag, ObjectSize, StorageClass, Checksum, ObjectParts)을 조회한 경우의 응답 예시는 다음과 같습니다.

HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<GetObjectAttributesResponse xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <ETag>******</ETag>
    <ObjectSize>1024</ObjectSize>
    <StorageClass>STANDARD</StorageClass>
    <Checksum>
        <ChecksumSHA256>******</ChecksumSHA256>
        <ChecksumType>COMPOSITE</ChecksumType>
    </Checksum>
    <ObjectParts>
        <IsTruncated>false</IsTruncated>
        <MaxParts>1000</MaxParts>
        <PartNumberMarker>0</PartNumberMarker>
        <PartsCount>2</PartsCount>
        <Part>
            <PartNumber>1</PartNumber>
            <Size>512</Size>
        </Part>
        <Part>
            <PartNumber>2</PartNumber>
            <Size>512</Size>
        </Part>
    </ObjectParts>
</GetObjectAttributesResponse>