Get catalog
GEThttp://localhost:8090/api/metalakes/:metalake/catalogs/:catalog
Returns the specified catalog information in the specified metalake
Request
Path Parameters
metalake stringrequired
The name of the metalake
catalog stringrequired
The name of the catalog
Responses
- 200
- 404
- 5xx
Returns included catalog object
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- CatalogResponse
Schema
code int32
Possible values: [0
]
Status code of the response
catalog
object
{
"code": 0,
"catalog": {
"name": "string",
"type": "relational",
"provider": "hive",
"comment": "string",
"audit": {
"creator": "string",
"createTime": "2024-05-15T09:38:08.285Z",
"lastModifier": "string",
"lastModifiedTime": "2024-05-15T09:38:08.285Z"
},
"properties": {}
}
}
{
"code": 0,
"catalog": {
"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"
}
}
}
Not Found - The specified catalog does not exist in the specified metalake
- application/vnd.gravitino.v1+json
- Schema
- Example (from schema)
- NoSuchMetalakeException
- NoSuchCatalogException
Schema
code integerrequired
Possible values: >= 1000
and <= 1100
HTTP response code
type stringrequired
Internal type definition of the error
message stringrequired
A human-readable message
stack string[]
{
"code": 1002,
"type": "string",
"message": "string",
"stack": [
"string"
]
}
{
"code": 1003,
"type": "NoSuchMetalakeException",
"message": "Failed to operate metalake(s) [test] operation [LOAD], reason [NoSuchMetalakeException]",
"stack": [
"com.datastrato.gravitino.exceptions.NoSuchMetalakeException: Metalake test does not exist",
"..."
]
}
{
"code": 1003,
"type": "NoSuchCatalogException",
"message": "Failed to operate catalog(s) [test] operation [LOAD] under metalake [my_test_metalake], reason [NoSuchCatalogException]",
"stack": [
"com.datastrato.gravitino.exceptions.NoSuchCatalogException: Catalog my_test_metalake.test does not exist",
"..."
]
}
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
code integerrequired
Possible values: >= 1000
and <= 1100
HTTP response code
type stringrequired
Internal type definition of the error
message stringrequired
A human-readable message
stack string[]
{
"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
curl -L -X GET 'http://localhost:8090/api/metalakes/:metalake/catalogs/:catalog' \
-H 'Accept: application/vnd.gravitino.v1+json' \
-H 'Authorization: Bearer <TOKEN>'
ResponseClear