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.

PutObjectLegalHold

Prev Next

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

Ncloud Storageオブジェクトにリーガルホールド(Legal Hold)状態を設定したり、解除したりします。リーガルホールドが設定されているオブジェクトは、リテンション期間にかかわらず、削除・変更することができません。

リクエスト

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

メソッド URI
PUT /{Key}

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

参考

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

フィールド 必須の有無 説明
Content-MD5 Required リクエストボディの Base64エンコードした128ビット MD5ハッシュ値
  • リクエストボディの完全性検証に使用
  • x-amz-checksum-*チェックサムヘッダで置き換え可能

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

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

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

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

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

フィールド タイプ 必須の有無 説明
versionId String Optional リーガルホールドを設定するオブジェクトのバージョン ID
  • 未入力時、最新バージョンに設定

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
LegalHold Object Required リーガルホールドの設定
LegalHold.Status String Required リーガルホールドの状態
  • ON | OFF
    • ON: 設定
    • OFF: 解除

リクエスト例

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

PUT /object.csv?legal-hold HTTP/1.1
Host: {Bucket}.kr.ncloudstorage.com
Content-MD5: {MD5ハッシュ値}

<?xml version="1.0" encoding="UTF-8"?>
<LegalHold>
    <Status>ON</Status>
</LegalHold>

レスポンス

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

レスポンスヘッダ

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

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

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

参考

Ncloud Storage APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Storageのレスポンスステータスコードをご参照ください。

エラーコード HTTPステータスコード 説明
InvalidRequest 400 バケットに Object Lockの設定がない
MalformedXML 400 リクエストの XMLがスキーマに準拠していない
  • StatusON/OFFではない
NoSuchKey 404 指定したオブジェクトは存在しない
NoSuchVersion 404 指定したバージョンは存在しない
MethodNotAllowed 405 削除マーカーにリーガルホールドを設定した

レスポンス例

レスポンスのサンプルコードは次の通りです。

HTTP/1.1 200 OK