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.

PutObjectLockConfiguration

Prev Next

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

Ncloud Storageバケットに Object Lock設定を適用します。Object Lockを使用すると、オブジェクトを一定期間、あるいは無期限に削除・変更されないように保管することができます。

リクエスト

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

メソッド URI
PUT -

リクエストヘッダ

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

参考

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

フィールド 必須の有無 説明
Content-MD5 Conditional リクエストボディの Base64エンコードした128ビット MD5ハッシュ値
  • リクエストボディの完全性検証に使用
  • x-amz-checksum-*を入力しなかった場合、必ず入力
x-amz-checksum-* Conditional チェックサムのハッシュ値
  • キーの*に使用したアルゴリズムを入力
    • サポートアルゴリズム: crc32 | crc32c | sha1 | sha256 | crc64nvme
  • Content-MD5を入力しなかった場合、必ず入力

リクエストボディ

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

フィールド タイプ 必須の有無 説明
ObjectLockConfiguration Object Required Object Lockを設定
ObjectLockConfiguration.ObjectLockEnabled String Required Object Lockを有効化するか
  • Enabled (有効な値)
ObjectLockConfiguration.Rule Object Optional デフォルトのリテンションルール
  • 指定しないとデフォルトのリテンション期間を設定しない
ObjectLockConfiguration.Rule.DefaultRetention Object Optional デフォルトのリテンション設定
  • Rule指定時、必須
ObjectLockConfiguration.Rule.DefaultRetention.Mode String Optional デフォルトのリテンションモード
  • GOVERNANCE | COMPLIANCE
    • GOVERNANCE: 特別な権限でバイパス可能
    • COMPLIANCE: いかなるユーザーもバイパス不可
ObjectLockConfiguration.Rule.DefaultRetention.Days Integer Optional デフォルトのリテンション期間(日)
  • 1~36,500
  • Yearsと同時に指定できない(1つ選択)
ObjectLockConfiguration.Rule.DefaultRetention.Years Integer Optional デフォルトのリテンション期間(年)
  • 1~100
  • Daysと同時に指定できない(1つ選択)

リクエスト例

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

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

<?xml version="1.0" encoding="UTF-8"?>
<ObjectLockConfiguration>
    <ObjectLockEnabled>Enabled</ObjectLockEnabled>
    <Rule>
        <DefaultRetention>
            <Mode>GOVERNANCE</Mode>
            <Days>30</Days>
        </DefaultRetention>
    </Rule>
</ObjectLockConfiguration>

レスポンス

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

レスポンスヘッダ

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

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

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

参考

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

エラーコード HTTPステータスコード 説明
InvalidArgument 400 デフォルトのリテンション期間が有効範囲外
  • Days/Yearsが正の整数ではない
  • Days(36,500)/Years(100)上限を超過
MalformedXML 400 リクエストの XMLがスキーマに準拠していない
  • ObjectLockEnabledEnabledではない
  • ModeGOVERNANCE/COMPLIANCEではない
  • DaysYearsを同時に指定したか、どちらも指定していない

レスポンス例

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

HTTP/1.1 200 OK