GetObjectRetention

Classic/VPC環境で利用できます。

Ncloud Storageオブジェクトに設定したリテンション(Retention)情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/{Key}

リクエストヘッダ

Ncloud Storage APIで共通して使用されるヘッダの詳細は、Ncloud Storageのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`Key`	String	Required	オブジェクト名

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`versionId`	String	Optional	リテンション情報を照会するオブジェクトのバージョン ID 未入力時、最新バージョンを照会

リクエスト例

リクエストのサンプルコードは次の通りです。

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

レスポンス

レスポンス形式を説明します。

レスポンスヘッダ

Ncloud Storage APIで共通して使用されるヘッダの詳細は、Ncloud Storageのレスポンスヘッダをご参照ください。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`Retention`	Object	-	リテンションを設定
`Retention.Mode`	String	-	リテンションモード `GOVERNANCE` \| `COMPLIANCE`
`Retention.RetainUntilDate`	String	-	リテンション期限 ISO 8601形式

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

参考

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"?>
<Retention xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <Mode>GOVERNANCE</Mode>
    <RetainUntilDate>2025-12-31T00:00:00.000Z</RetainUntilDate>
</Retention>

Documentation Index