# 获取通用存储列表-GetDataWarehouseList
#### 功能介绍
获取通用存储列表
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-octopus/Permission.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                        | 访问级别 | 资源类型（\*为必须）  | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | octopus:dataWarehouse:list | List | workspace \* | -   | -  | -      |
     
  
 
#### URI
GET /v1.0/{project_id}/common/warehouses
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释**： 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-octopus/octopus-10-0020.html)。 **约束限制**： 不涉及 **取值范围**： 只能用小写字母 a-z 和数字 0-9组成，且长度为32个字符 **默认取值**： 不涉及 |
   
表2Query参数 
| 参数           | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| name         | 否    | String  | **参数解释**： 根据名称模糊查询 **约束限制**： 不涉及 **取值范围**： 只能用中文字符、大小写英文字母、数字、"_"、"-"组成，且长度为\[0\~64\]个字符 **默认取值**： 不涉及 |
| offset       | 否    | Integer | **参数解释**： 查询偏移量 **约束限制**： 与limit配合使用 **取值范围**： 最小值为0 **默认取值**： 0                                                     |
| limit        | 否    | Integer | **参数解释**： 返回个数上限 **约束限制**： 与offset配合使用 **取值范围**： 最小值为1，最大值为50 **默认取值**： 10                                         |
| workspace_id | 是    | String  | **参数解释**： 工作空间id **约束限制**： 不涉及 **取值范围**： 小写带横杠UUID或小写无横杠UUID或单个0 **默认取值**： 不涉及                                        |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释**： 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） **约束限制**： 不涉及 **取值范围**： 不涉及 **默认取值**： 不涉及 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数        | 参数类型                                                                                                | 描述                                                            |
|:---|:---|:---|
| payload   | [listDataWarehousePayload] object | **参数解释**： 实际返回信息 |
| meta_info | [MetaInfo] object                                 | **参数解释**： 元数据 |
   
 表5listDataWarehousePayload 
| 参数        | 参数类型                                                                                          | 描述                                                                 |
|:---|:---|:---|
| page_info | [PageInfo] object                           | **参数解释**： 分页信息    |
| list      | Array of [DataWarehouseDto] objects | **参数解释**： 通用存储列表信息 |
   
 表6PageInfo 
| 参数     | 参数类型 | 描述                                                                                                                                                                         |
|:---|:---|:---|
| total  | Long | **参数解释**： 资源总数 **取值范围**： 不涉及 |
| offset | Long | **参数解释**： 查询偏移量 **取值范围**： 不涉及 |
| limit  | Long | **参数解释**： 返回个数上限 **取值范围**： 不涉及   |
   
 表7DataWarehouseDto 
| 参数             | 参数类型   | 描述                                                                                                                                                                                  |
|:---|:---|:---|
| id             | String | **参数解释**： 通用存储id **取值范围**： 不涉及          |
| name           | String | **参数解释**： 名称 **取值范围**： 不涉及               |
| description    | String | **参数解释**： 描述 **取值范围**： 不涉及                |
| workspace_id   | String | **参数解释**： 工作空间id **取值范围**： 不涉及              |
| project_id     | String | **参数解释**： 项目id **取值范围**： 不涉及              |
| create_time    | Long   | **参数解释**： 创建时间，UTC标准时间毫秒时间戳 **取值范围**： 不涉及 |
| object_count   | Long   | **参数解释**： 对象数量 **取值范围**： 不涉及        |
| raw_data_count | Long   | **参数解释**： 数据包数量 **取值范围**： 不涉及       |
   
 表8MetaInfo 
| 参数           | 参数类型   | 描述                                                                                                                                                                                              |
|:---|:---|:---|
| current_time | String | **参数解释**： 请求时间，UTC时间格式，时间为UTC标准时间 **取值范围**： 不涉及 |
   
#### 请求示例
获取通用存储列表信息
```
GET https://{endpoint}/v1.0/{project_id}/common/warehouses?offset=0&limit=10&name=warehouse_name&workspace_id=0
```
#### 响应示例
**状态码：200**
查询成功
获取通用存储列表信息
```
{
  "meta_info" : {
    "current_time" : "2024-01-02T02:04:22Z"
  },
  "payload" : {
    "list" : [ {
      "id" : "ee9784a5-dde5-4a47-a006-fac074c5bee8",
      "name" : "WAREHOUSE_NAME",
      "description" : "仓库1",
      "create_at" : 1701170680048,
      "object_count" : 317,
      "raw_data_count" : 4
    } ],
    "page_info" : {
      "total" : 1,
      "offset" : 0,
      "limit" : 10
    }
  }
}
```
#### 状态码
| 状态码 | 描述     |
|:---|:---|
| 200 | 查询成功   |
| 400 | 参数校验失败 |
| 500 | 系统内部错误 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-octopus/ErrorCode.html)。