GetObjectAttributes

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-attributes`に`ObjectParts`を指定した場合に適用 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	-	オブジェクトの固有 ID(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	-	次のページの照会基準となるパート番号 `IsTruncated`が`true`の場合に表示
`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>

Documentation Index