GetObjectLockConfiguration

Available in Classic and VPC

Get the object lock settings set on an Ncloud Storage bucket.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	-

Request headers

For information about the headers common to all Ncloud Storage APIs, see Ncloud Storage request headers.

Request example

The request example is as follows:

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

Response

This section describes the response format.

Response headers

For information about the headers common to all Ncloud Storage APIs, see Ncloud Storage response headers.

Response body

The response body includes the following data:

Field	Type	Required	Description
`ObjectLockConfiguration`	Object	-	Object lock settings
`ObjectLockConfiguration.ObjectLockEnabled`	String	-	Whether object lock is enabled `Enabled`
`ObjectLockConfiguration.Rule`	Object	-	Default retention rule Displayed if the default retention period is set
`ObjectLockConfiguration.Rule.DefaultRetention`	Object	-	Default retention settings
`ObjectLockConfiguration.Rule.DefaultRetention.Mode`	String	-	Default retention mode `GOVERNANCE` \| `COMPLIANCE`
`ObjectLockConfiguration.Rule.DefaultRetention.Days`	Integer	-	Default retention period (days) Displayed if `Days` is set
`ObjectLockConfiguration.Rule.DefaultRetention.Years`	Integer	-	Default retention period (years) Displayed if `Years` is set

Response status codes

The following describes the response status codes.

Note

For information about the HTTP status codes common to all Ncloud Storage APIs, see Common Ncloud Storage response status codes.

Error code	HTTP status code	Description
`ObjectLockConfigurationNotFoundError`	404	No object lock settings exist in the bucket.

Response example

The response example is as follows:

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>

Documentation Index