接口介绍
调用接口启用合规保留策略。
接口约束
无
请求URI
POST /v1/worm/enable
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| bucket | 是 | String | 桶名。 | testBucketName | - |
| regionCode | 是 | String | 区域编码。 | 0001 | - |
请求参数
请求头参数
无
请求体参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 本次请求的结果码。 | 0 | |
| error | 是 | String | 错误码，开启成功时，不返回该字段。 | ||
| message | 是 | String | 错误文本信息，开启成功时，为空字符串。 | ||
| returnObj | 是 | String of Object | 返回结果。 | returnObj |
表 returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | String | 业务返回码，0表示业务成功。 | 0 | |
| data | 是 | String | 业务返回数据。 | ||
| message | 是 | String | 业务消息。 |
请求示例
POST /v1/worm/enable?regionCode=0001&bucket=testBucketName
请求头header
无
请求体body
无
响应示例
{
"statusCode": "0",
"message": "",
"returnObj": {
"code": "0",
"data": "",
"message": ""
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 0 | 表示业务成功。 |
| 400 | 请求参数有误。 |
| 403 | 用户鉴权失败，用户无操作权限。 |
| 404 | 请求的资源不存在，输入错误的URL。 |
| 500 | 业务执行异常。 |
