接口介绍
获取指定存储桶(Bucket)的合规保留策略信息。
接口约束
无
请求URI
GET /v1/worm/get
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
bucket | 是 | String | 桶名。 | test1 | - |
regionCode | 是 | String | 区域编码。 | 0001 | - |
请求参数
请求头参数
无
请求body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 本次请求的结果码。 | 0 | |
error | 是 | String | 错误码,获取成功时,不返回该字段。 | ||
message | 是 | String | 错误文本信息,获取成功时,为空字符串。 | ||
returnObj | 是 | String of Object | 返回结果。 | returnObj |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
code | 是 | String | 业务返回码,0表示业务成功。 | 0 | |
data | 是 | String of Object | 业务返回数据。 | data | |
message | 是 | String | 业务消息。 |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
userName | 是 | String | 用户名。 | test_user | |
bucket | 是 | String | 桶名。 | test_cde1051efc07 | |
regionCode | 是 | String | 区域编码。 | 0001 | |
remainingDays | 是 | Integer | 保留天数。 | 77 | |
status | 是 | String | 状态。 | F0X | |
id | 是 | Long | 合规保留模板id。 | 18 | |
createTime | 是 | String | 创建时间。 | 1695887462000 | |
updateTime | 是 | String | 关系时间。 | 1695887462000 |
请求示例
GET /v1/worm/get?regionCode=0001&bucket=testBucketName
请求头header
无
请求体body
无
响应示例
{
"statusCode": "0",
"message": "",
"returnObj": {
"code": "0",
"data": {
"userName": "test_user",
"bucket": "test_cde1051efc07",
"regionCode": "0001",
"remainingDays": 77,
"status": "F0X",
"updateTime": "1695887462000",
"id": 18,
"createTime": "1695887462000"
},
"message": ""
}
}
状态码
状态码 | 描述 |
---|---|
0 | 表示业务成功。 |
400 | 请求参数有误。 |
403 | 用户鉴权失败,用户无操作权限。 |
404 | 请求的资源不存在,输入错误的URL。 |
500 | 业务执行异常。 |