查看對象列表
更新時間 2025-06-11 14:55:25
最近更新時間: 2025-06-11 14:55:25
分享文章
接口介紹
查詢存儲桶內所有對象。
接口約束
支持的線上資源池 :上海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-objects
請求參數
請求 Query 參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| bucket | 是 | String | 桶名 | bucket1 |
| regionID | 是 | String | 區域 ID | 332232eb-63aa-465e-9028-52e5123866f0 |
| delimiter | 否 | String | 定界符是您用來對鍵進行分組的字符 | / |
| marker | 否 | String | 指示從哪里開始列出。ZOS會在這個指定的對象之后開始列出。標記可以是桶中的任何對象 | test1.txt |
| maxKeys | 否 | Integer | 一次返回keys的最大數目(默認值和上限為1000) | 100 |
| prefix | 否 | String | 返回的key的前綴 | test |
文件夾及文件查詢方法 :
可以將 prefix 設為文件夾名,就可以列出該文件夾下遞歸的所有的文件和子文件夾。文件名在 contents 中列出。 如果再把 delimiter 設置為 “/” 時,返回值就只列出該文件夾下的文件和子文件夾,除文件名在 contents 中列出外,該文件夾下的子文件夾在 commonPrefixes 中列出,子文件夾下遞歸的文件和文件夾不被顯示。
假設桶內對象為
d1/
f1
d1/d2/
d1/f2
d1/f3
d1/d2/ff1
d1/d2/d3/
d1/dd2/
需要查詢 d1/ 目錄下的文件時,傳入 prefix=d1/,delimiter=/,返回結果簡寫如下:
contents:[
{"key": "d1/"},
{"key": "d1/f2"},
{"key": "d1/f3"}
],
commonPrefixes:[
{"prefix": "d1/d2/"},
{"prefix": "d1/dd2/"}
]
即,contents 會返回當前目錄下的文件,commonPrefixes 返回當前目錄下的文件夾
響應參數
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回碼 取值范圍:800 成功 |
800 |
| message | String | 狀態描述 | SUCCESS |
| description | String | 狀態描述,一般為中文 | 成功 |
| returnObj | Object | 響應對象 | 見下級對象 |
| errorCode | String | 業務細分碼(僅失敗時具有此參數),為product.module.code三段式碼 | openapi.userPermission.accessFailed |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| isTruncated | Boolean | 指示返回的分段列表是否被截斷。值為 true 表示列表已被截斷。 | true |
| marker | String | 指示存儲桶列表中的開始位置。如果標記是隨請求一起發送的,則標記包含在響應中。 | test1.txt |
| contents | Array of Objects | 對象的容器 | 見下級對象 |
| nextMarker | String | 下一個 Marker | test100.txt |
| name | String | 桶名 | bucket1 |
| prefix | String | 返回的key的前綴 | test |
| delimiter | String | 定界符是您用來對鍵進行分組的字符 | / |
| maxKeys | Integer | 一次返回keys的最大數目 | 100 |
| commonPrefixes | Array of Objects | 在計算返回數時,所有鍵(最多 1,000 個)匯總在一個公共前綴中計為單個返回。僅當指定分隔符時,響應才能包含 commonPrefixes | 見下級對象 |
| encodingType | String | 對響應中的對象鍵進行編碼并指定要使用的編碼方法,目前允許的值只有 url | url |
表 contents
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| ETag | String | ETag | 70ee1738b6b21e2c8a43f3a5ab0eee71 |
| key | String | 對象名 | test1.txt |
| lastModified | String | 最后更改時間, ISO-8601 格式的日期字符串 | 2022-10-18T02:24:40Z |
| owner | Objects | 見下級對象 | |
| size | Integer | 大小 | 11 |
| storageClass | String | 存儲類 | STANDARD |
表 owner
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| displayName | String | 展示名 | myname |
| ID | String | 用戶 ID | 12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc |
表 commonPrefixes
| 參數 | 參數類型 | 說明 | 示例 |
|---|---|---|---|
| prefix | String | 前綴 | test |
請求示例
GET //zos-global.ctapi.daliqc.cn/v4/oss/list-objects?bucket=bucket1®ionID=332232eb-63aa-465e-9028-52e5123866f0&delimiter=%2F&marker=test1.txt&maxKeys=100&prefix=test
響應示例
{
"returnObj": {
"contents": [
{
"ETag": "70ee1738b6b21e2c8a43f3a5ab0eee71",
"key": "test1.txt",
"lastModified": "2022-10-18T02:24:40Z",
"owner": {
"displayName": "myname",
"ID": "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
},
"size": 11,
"storageClass": "STANDARD"
},
{
"ETag": "9c8af9a76df052144598c115ef33e511",
"key": "test2.jpg",
"lastModified": "2022-10-18T02:24:40Z",
"owner": {
"displayName": "myname",
"ID": "12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc"
},
"size": 713193,
"storageClass": "STANDARD"
}
],
"nextMarker": "test100.txt"
},
"message": "SUCCESS",
"description": "成功",
"statusCode": 800
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功。 |
| 900 | 表示請求失敗。 |
錯誤碼
errorCode 枚舉值,見錯誤碼總表