接口介绍
获取对象的合规保留配置。
接口约束
支持的线上资源池 ：上海7、南京3、南京5、杭州2、合肥2、九江、广州6、武汉4、福州25、厦门3、郴州2、海口2、北京5、雄安2、石家庄20、内蒙6、晋中、辽阳1、西安5、乌鲁木齐4、乌鲁木齐27、中卫5、兰州2、西宁2、拉萨3、昆明2、重庆2、成都4、贵州3、上海33、宁波边缘云、华东1、上海36、南昌5、青岛20、武汉41、长沙42、长沙37、南宁23、北京行业云20、华北2、西南1、上海32。
URI
GET /v4/oss/get-object-retention
请求参数
请求 Query 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| bucket | 是 | String | 桶名 | bucket1 |
| regionID | 是 | String | 区域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
| key | 是 | String | 对象名称 | obj1 |
| versionID | 是 | String | 版本ID，在开启多版本时可使用 | USzD.sN0vODAsQ84ncdT20oRiY2lFCD |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回码 取值范围：800 成功 |
800 |
| message | String | 状态描述 | SUCCESS |
| description | String | 状态描述，一般为中文 | 成功 |
| returnObj | Object | 响应对象 | 见下级对象 |
| errorCode | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码 | openapi.userPermission.accessFailed |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| retention | Object | 保留配置 | 见下级对象 |
表 retention
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| mode | String | 保留模式，COMPLIANCE 或 GOVERNANCE | GOVERNANCE |
| retainUntilDate | Integer | 保留截止日期 | 45455454 |
请求示例
GET https://zos-global.ctapi.ctyun.cn/v4/oss/get-object-retention?bucket=bucket1®ionID=332232eb-63aa-465e-9028-52e5123866f0&key=obj1&versionID=USzD.sN0vODAsQ84ncdT20oRiY2lFCD
响应示例
{
"returnObj": {
"retention": {
"mode": "GOVERNANCE",
"retainUntilDate": 45455454
}
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
| 900 | 表示请求失败。 |
错误码
errorCode 枚举值，见错误码总表
