
# 获取用户OBS桶列表 - ListObsBucket
#### 功能介绍
获取用户OBS桶列表。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0100.html)。
#### URI
GET /v1/{project_id}/customer-buckets
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释**： 项目ID，您可以从[获取项目ID](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0033.html)中获取。 **约束限制**： 不涉及 **取值范围**： 仅支持字母、数字、中划线和下划线，长度为\[1-128\]个字符。 **默认取值**： 不涉及 |
表2Query参数 
| 参数   | 是否必选 | 参数类型   | 描述                                                                             |
|:---|:---|:---|:---|
| type | 否    | String | **参数解释**： 桶类型。 **约束限制**： 不涉及 **取值范围**： - OBJECT：桶列表 - PFS：并行文件系统 **默认取值**： 不涉及 |
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                   |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释**： 用户Token。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限，[获取Token](https://support.huaweicloud.com/api-ai4sservice/ai4sservice_03_0011.html)接口响应消息头中X-Subject-Token的值即为Token。 **约束限制**： 不涉及 **取值范围**： 长度为\[1-32768\]个字符。 **默认取值**： 不涉及 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数      | 参数类型                                                             | 描述                                                       |
|:---|:---|:---|
| count   | Integer                                                          | **参数解释**： 桶个数。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 |
| buckets | Array of [BucketDto] objects | **参数解释**： 桶列表。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 |
   
 表5BucketDto 
| 参数     | 参数类型   | 描述                                                                             |
|:---|:---|:---|
| name   | String | **参数解释**： 桶名称。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及                       |
| region | String | **参数解释**： 区域。 **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及                        |
| type   | String | **参数解释**： 桶类型。 **约束限制**： 不涉及 **取值范围**： - OBJECT：桶列表 - PFS：并行文件系统 **默认取值**： 不涉及 |
   
#### 请求示例
获取用户OBS桶列表。
```
https://{endpoint}/v1/{project_id}/customer-buckets
```
#### 响应示例
**状态码：200**
OK
```
{
  "count" : 1,
  "buckets" : [ {
    "name" : "bucket",
    "region" : "region",
    "type" : "PFS"
  } ]
}
```
#### 状态码
| 状态码 | 描述 |
|:---|:---|
| 200 | OK |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-ai4sservice/ErrorCode.html)。
