Get Bucket Compliance Retention Policy
Last Updated：2021-09-13
Interface Description
This interface is used to get the configuration information on the compliance retention policy.
Request URI
GET /v1/{bucketName}/?objectlock
| Parameter Name | Parameter Type | Required | Description | Example Value | Parameter Position |
|---|---|---|---|---|---|
| bucketName | String | Yes | Bucket name | "bucketName_example" | Path |
Request Body Parameters
Instructions for Data Structure of Request Body Field
Response Body Parameters
Instructions for Data Structure of Response Body Field
| Parameter Name | Parameter Type | Description | Example Value |
|---|---|---|---|
| lockStatus | String | Status of the compliance retention policy | IN_PROGRESS |
| createDate | Integer | Creation time of the compliance retention policy | 1569317168 |
| expirationDate | Integer | Expiration time of the compliance retention policy. The compliance retention policy can expire only when it is in the IN_PROGRESS status. | 1569403568 |
| retentionDays | Integer | Protection period of the compliance retention policy (days) | 3 |
Request Example
GET /v1/bucketName_example/?objectlock
<Common Request Header>
{ }Response Example
HTTP/1.1 200 OK
<Common response header>
{
"lockStatus" : "IN_PROGRESS",
"retentionDays" : 3,
"createDate" : 1569317168,
"expirationDate" : 1569403568
}Error Code
Refer to the universal error code.