List catalogs (names)
GEThttp://localhost:8090/api/metalakes/:metalake/catalogs
List catalogs (names)
Request
Path Parameters
The name of the metalake
Query Parameters
Include detailed information about the catalogs
Responses
- 200
- 400
- 5xx
Returns the list of catalog objects if {details} is true, otherwise returns the list of catalog identifiers
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- CatalogListResponse
- CatalogInfoListResponse
Schema
- CatalogListResponse
- CatalogInfoListResponse
oneOf
Possible values: [0
]
Status code of the response
identifiers
object[]
Possible values: [0
]
Status code of the response
catalogs
object[]
{}
{
"code": 0,
"identifiers": [
{
"namespace": [
"my_metalake"
],
"name": "my_hive_catalog"
}
]
}
{
"code": 0,
"catalogs": [
{
"name": "my_hive_catalog",
"type": "relational",
"provider": "hive",
"comment": "This is my hive catalog",
"properties": {
"key1": "value1",
"gravitino.bypass.hive.metastore.client.capability.check": "false",
"metastore.uris": "thrift://127.0.0.1:9083"
},
"audit": {
"creator": "gravitino",
"createTime": "2023-12-08T03:41:25.595Z"
}
},
{
"name": "my_hadoop_catalog",
"type": "fileset",
"provider": "hadoop",
"comment": "This is my hadoop catalog",
"properties": {
"key2": "value2"
},
"audit": {
"creator": "gravitino",
"createTime": "2023-12-08T06:41:25.595Z"
}
}
]
}
Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- Example
Schema
Possible values: >= 1000
and <= 1100
HTTP response code
Internal type definition of the error
A human-readable message
{
"code": 1002,
"type": "string",
"message": "string",
"stack": [
"string"
]
}
{
"code": 1003,
"type": "BadRequestException",
"message": "Malformed request"
}
A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes.
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- Example
Schema
Possible values: >= 1000
and <= 1100
HTTP response code
Internal type definition of the error
A human-readable message
{
"code": 1002,
"type": "string",
"message": "string",
"stack": [
"string"
]
}
{
"code": 1002,
"type": "RuntimeException",
"message": "Internal Server Error",
"stack": [
"java.lang.RuntimeException: Internal Server Error"
]
}
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL