
# 查询OBS桶下对象列表 - ListObsBucketObjects
#### 功能介绍
查询OBS桶下对象列表。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CloudRTC/doc?api=ListObsBucketObjects)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-rtc/rtc_07_0022.html)。
#### URI
GET /v2/rtc-ops/buckets/objects
表1Query参数 
| 参数       | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|:---|:---|:---|:---|
| bucket   | 是    | String | 要查询的桶名                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| prefix   | 否    | String | 对象名前缀，可以理解为文件夹路径                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| type     | 是    | String | 查询类型。取值如下： folders：查询目录 objects：查询对象                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| location | 是    | String | 查询bucket所在的region： - cn-north-4   - cn-north-1   - cn-north-5   - cn-north-6   - cn-south-1   - cn-east-2    |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
   
#### 响应参数
**状态码：200**
表3响应Header参数 
| 参数           | 参数类型   | 描述                 |
|:---|:---|:---|
| X-request-Id | String | 此字段携带请求ID号，以便任务跟踪。 |
   
表4响应Body参数 
| 参数      | 参数类型                                                                    | 描述    |
|:---|:---|:---|
| count   | Integer                                                                 | 对象的总数 |
| objects | Array of [ObsObject] objects | OBS文件 |
   
 表5ObsObject 
| 参数            | 参数类型    | 描述                                       |
|:---|:---|:---|
| file_name     | String  | 对象名                                      |
| size          | Integer | 文件大小，单位KB                                |
| last_modified | String  | 上次修改时间，格式如：2020/07/16 15:11:55 GMT+08:00 |
   
**状态码：401**
表6响应Header参数 
| 参数           | 参数类型   | 描述                 |
|:---|:---|:---|
| X-request-Id | String | 此字段携带请求ID号，以便任务跟踪。 |
   
表7响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
**状态码：404**
表8响应Header参数 
| 参数           | 参数类型   | 描述                 |
|:---|:---|:---|
| X-request-Id | String | 此字段携带请求ID号，以便任务跟踪。 |
   
表9响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
**状态码：500**
表10响应Header参数 
| 参数           | 参数类型   | 描述                 |
|:---|:---|:---|
| X-request-Id | String | 此字段携带请求ID号，以便任务跟踪。 |
   
表11响应Body参数 
| 参数         | 参数类型   | 描述   |
|:---|:---|:---|
| error_code | String | 错误码  |
| error_msg  | String | 错误描述 |
   
#### 请求示例
无
#### 响应示例
**状态码：200**
查询OBS桶下对象成功
```
{
  "count" : 1,
  "objects" : [ {
    "file_name" : "test file"
  }, {
    "size" : 7254700
  }, {
    "last_modified" : "20230815085859"
  } ]
}
```
**状态码：401**
请求失败，携带的X-Auth-Token错误
```
{
  "error_code" : "RTC.00001003",
  "error_msg" : "InvalidParameterValue"
}
```
**状态码：404**
查询失败，任务编号不存在
```
{
  "error_code" : "RTC.00001003",
  "error_msg" : "InvalidParameterValue"
}
```
**状态码：500**
查询失败，服务器端错误
```
{
  "error_code" : "RTC.00002xxx",
  "error_msg" : "InternalError"
}
```
#### 状态码
| 状态码 | 描述                     |
|:---|:---|
| 200 | 查询OBS桶下对象成功            |
| 401 | 请求失败，携带的X-Auth-Token错误 |
| 404 | 查询失败，任务编号不存在           |
| 500 | 查询失败，服务器端错误            |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-rtc/ErrorCode.html)。
