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.

GetObjectLockConfiguration

Prev Next

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

Ncloud Storageバケットに適用された Object Lock設定を照会します。

リクエスト

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

メソッド URI
GET -

リクエストヘッダ

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

リクエスト例

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

GET /?object-lock HTTP/1.1
Host: {Bucket}.kr.ncloudstorage.com

レスポンス

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

レスポンスヘッダ

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
ObjectLockConfiguration Object - Object Lockを設定
ObjectLockConfiguration.ObjectLockEnabled String - Object Lockを有効化するか
  • Enabled
ObjectLockConfiguration.Rule Object - デフォルトのリテンションルール
  • デフォルトのリテンション期間が設定されている場合に表示
ObjectLockConfiguration.Rule.DefaultRetention Object - デフォルトのリテンション設定
ObjectLockConfiguration.Rule.DefaultRetention.Mode String - デフォルトのリテンションモード
  • GOVERNANCE | COMPLIANCE
ObjectLockConfiguration.Rule.DefaultRetention.Days Integer - デフォルトのリテンション期間(日)
  • Days設定時、表示
ObjectLockConfiguration.Rule.DefaultRetention.Years Integer - デフォルトのリテンション期間(年)
  • Years設定時、表示

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

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

参考

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

エラーコード HTTPステータスコード 説明
ObjectLockConfigurationNotFoundError 404 バケットに Object Lockの設定が存在しない

レスポンス例

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

HTTP/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<ObjectLockConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
    <ObjectLockEnabled>Enabled</ObjectLockEnabled>
    <Rule>
        <DefaultRetention>
            <Mode>GOVERNANCE</Mode>
            <Days>30</Days>
        </DefaultRetention>
    </Rule>
</ObjectLockConfiguration>