接口介绍
查询对象的版本信息
接口约束
支持的线上资源池 ：上海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/list-object-versions
请求参数
请求 Query 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 |
|---|---|---|---|---|
| bucket | 是 | String | 桶名 | bucket1 |
| regionID | 是 | String | 区域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
| keyMarker | 否 | String | 指示从哪里开始列出。ZOS 会在这个指定的键之后开始列出。标记可以是桶中的任何键。默认值为空字符串 ""。 | test1.txt |
| prefix | 否 | String | 返回的key的前缀，注意 key 与 prefix 完全相同的对象不会返回。默认值为空字符串 ""。 | test |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回码 取值范围：800 成功 |
800 |
| message | String | 状态描述 | SUCCESS |
| description | String | 状态描述，一般为中文 | 成功 |
| returnObj | Object | 响应对象 | 见下级对象 |
| errorCode | String | 业务细分码（仅失败时具有此参数），为product.module.code三段式码 | openapi.userPermission.accessFailed |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| keys | Array of Objects | 具有 prefix 前缀的对象列表。 | 见下级对象 |
| nextKeyMarker | String | 下一个 keyMarker。若没有则为 null。 | test2.txt |
| keyMarker | String | 标记截断响应中返回的最后一个 key。 | test1.txt |
| deleteMarkers | Array of Objects | 作为删除标记的对象的容器。 | 见下级对象 |
表 keys
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| key | String | 对象名 | test0.txt |
| versions | String | 版本信息 | 见下级对象 |
表 versions
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| lastModified | String | 最后修改时间，为 ISO 8601 格式 | 2022-10-18T02:24:40Z |
| versionID | String | 版本ID，在开启多版本时可使用 | PHtexPGjH2y.zBgT8LmB7wwLI2mpbz.k |
| ETag | String | ETag | "93837f55f5f0cf47b7411c522be99684-1" |
| storageClass | String | 存储类型 | STANDARD |
| key | String | 对象名 | test0.txt |
| owner | Object | 所有者 | 见下级对象 |
| isLatest | Boolean | 是否为最新版本 | true |
| size | Integer | 对象的大小，单位为字节 | 10 |
表 deleteMarkers
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| lastModified | String | 最后修改时间，为 ISO 8601 格式 | 2022-10-18T02:24:40Z |
| versionID | String | 版本ID，在开启多版本时可使用 | PHtexPGjH2y.zBgT8LmB7wwLI2mpbs.k |
| key | String | 对象名 | test01.txt |
| owner | Object | 创建删除标记的账户 | 见下级对象 |
| isLatest | Boolean | 是否为最新版本 | true |
表 owner
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| displayName | String | 展示名 | user1 |
| ID | String | 用户 ID | 12345example25102679df27bb0ae12b3f85be6f290b |
请求示例
GET https://zos-global.ctapi.ctyun.cn/v4/oss/list-object-versions?bucket=bucket1®ionID=332232eb-63aa-465e-9028-52e5123866f0&prefix=test
响应示例
{
"returnObj": {
"keys": [
{
"key": "test0.txt",
"versions": [
{
"lastModified": "2022-10-18T02:24:40Z",
"versionID": "PHtexPGjH2y.zBgT8LmB7wwLI2mpbz.k",
"ETag": "\"93837f55f5f0cf47b7411c522be99684-1\"",
"storageClass": "STANDARD",
"key": "test0.txt",
"owner": {
"displayName": "user1",
"ID": "12345example25102679df27bb0ae12b3f85be6f290b"
},
"isLatest": true,
"size": 10
},
{
"lastModified": "2022-10-18T02:24:40Z",
"versionID": "MHtexPGjH2y.zBgT8LmB7wwLI2mpbz.W",
"ETag": "\"93837f55f5f0cf47b7411c522be99633-2\"",
"storageClass": "STANDARD",
"key": "test0.txt",
"owner": {
"displayName": "user1",
"ID": "12345example25102679df27bb0ae12b3f85be6f290b"
},
"isLatest": false,
"size": 12
}
]
},
{
"key": "test0.txt2",
"versions": [
{
"lastModified": "2022-10-18T02:24:40Z",
"versionID": "sHtexPGjH2y.zBgT8LmB7wwLI2mpbz.f",
"ETag": "\"77837f55f5f0cf47b7411c522be99688-6\"",
"storageClass": "STANDARD",
"key": "test0.txt2",
"owner": {
"displayName": "user1",
"ID": "12345example25102679df27bb0ae12b3f85be6f290b"
},
"isLatest": true,
"size": 10
}
]
}
],
"nextKeyMarker": null,
"keyMarker": "",
"deleteMarkers": [
{
"lastModified": "2022-10-18T02:24:40Z",
"versionID": "GGGxPGjH2y.zBgT8LmB7wwLI2mpTT.u",
"key": "test0.txt3",
"owner": {
"displayName": "user2",
"ID": "7890example25102679df27bb0ae12b3f85be6f786d"
},
"isLatest": false
}
]
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功。 |
| 900 | 表示请求失败。 |
错误码
errorCode 枚举值，见错误码总表
