# 获取项目下所有Catalog信息 - ListCatalogs
#### 功能介绍
该API获取指定项目下所有Catalog信息。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DLI/doc?api=ListCatalogs)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限及授权项说明](https://support.huaweicloud.com/api-dli/dli_02_0375.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项 Action | 访问级别 Access Level | 资源类型（\*为必须） Resource Type (\*: required) | 条件键 Condition Key | 别名 Alias | 依赖的授权项 Dependencies |
  |:---|:---|:---|:---|:---|:---|
  | dli:catalog:list                        | List                                            | -                                                                      | -                                              | -                                      | -                                                 |
     
  
 
#### URI
GET /v3/{project_id}/catalogs
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                     |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目编号，用于资源隔离。获取方式请参考[获取项目ID](https://support.huaweicloud.com/api-dli/dli_02_0183.html)。 |
   
表2Query参数 
| 参数     | 是否必选 | 参数类型    | 描述                      |
|:---|:---|:---|:---|
| offset | 否    | Integer | 偏移量，默认值为"0"。            |
| limit  | 否    | Integer | 每页显示的返回信息的个数，默认值为"100"。 |
   
#### 请求参数
无
#### 响应参数
**状态码： 200**
表3响应Body参数 
| 参数          | 参数类型             | 描述                                                                                                    |
|:---|:---|:---|
| is_success  | Boolean          | 是否成功。                                                                                                 |
| total_count | Long             | Catalog总数量。                                                                                           |
| catalogs    | Array of objects | 项目下所有Catalog信息。请参考[CatalogEntity]。 |
   
 表4catalogs参数说明 
| 参数          | 参数类型                 | 描述                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|
| name        | String               | DLI侧Catalog映射名称。                                                                                                                                                                                                                                                                                                                   |
| create_time | Long                 | Catalog创建时间。                                                                                                                                                                                                                                                                                                                       |
| parameters  | Map\<String,String\> | Catalog属性中包含type和externalCatalog。                                                                                                                                                                                                                                                                                                  |
| description | String               | Catalog的描述信息。                                                                                                                                                                                                                                                                                                                      |
| status      | String               | Catalog状态。 - CREATING：catalog创建中。  - ACTIVE：catalog可使用。  - FAILED：catalog创建失败。   |
   
**状态码： 400**
表5响应Body参数 
| 参数         | 参数类型   | 描述      |
|:---|:---|:---|
| error_code | String | 错误码。    |
| error_msg  | String | 错误描述信息。 |
   
**状态码： 500**
表6响应Body参数 
| 参数         | 参数类型   | 描述    |
|:---|:---|:---|
| error_code | String | 错误码。  |
| error_msg  | String | 失败原因。 |
   
#### 请求示例
无
#### 响应示例
```
{
 "is_success": true,
 "total_count": 2,
 "catalogs": [
  {
   "name": "catalog_test1",
   "create_time": 1697179174000,
   "status": "ACTIVE",
   "parameters": {
    "type": "lakeformation",
    "external_catalog_name": "lakeformation_catalog_test1"
   },
   "description": "dli default catalog"
  },
  {
   "name": "catalog_test2",
   "create_time": 1706595479942,
   "status": "ACTIVE",
   "parameters": {
    "type": "lakeformation",
    "external_catalog_name": "lakeformation_catalog_test2"
   },
   "description": ""
  }
 ]
}
```
#### 状态码
| 状态码 | 描述             |
|:---|:---|
| 200 | 请求成功。          |
| 400 | 请求错误。          |
| 403 | 对被请求页面的访问被禁止。  |
| 404 | 服务器无法找到被请求的页面。 |
| 500 | 内部服务器错误。       |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-dli/dli_02_0056.html)。