Data Catalog overview
- Print
- PDF
Data Catalog overview
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Overview
If you request subscription to Data Catalog, a catalog and built-in database are automatically created. A database is a set of tables, which stores metadata. The Database menu allows you to check the status of your catalog and create and manage databases.
Common settings
API URL
https://datacatalog.apigw.ntruss.com/api/v1/
Request header
| Header name | Description |
|---|---|
| Content-Type | Specifies the request body content type as application/json (POST) |
| x-ncp-apigw-timestamp | Time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid |
| x-ncp-iam-access-key | API Key issued by NAVER Cloud Platform or Access Key issued by IAM |
| x-ncp-apigw-signature-v2 | A signature that encrypts the body of the example above with the Secret Key mapped to Access Key HmacSHA256 is used as the HMAC encryption algorithm |
Note
For more information, refer to the NAVER Cloud Platform API Guide.
Operation
Catalog
| API name | Description |
|---|---|
| getCatalogs | Searches for all catalog IDs of the user |
Connection
| API name | Description |
|---|---|
| getConnections | Searches for all connections in the user’s catalog |
| getConnection | Searches for the connection with a specific connection ID in the user’s catalog |
Scanner
| API name | Description |
|---|---|
| getScanners | Searches for all scanners in the user’s catalog |
| getScanner | Searches for the scanner with a specific scanner ID in the user’s catalog |
| getScannerHistories | Checks the execution history of a specific scanner in the user’s catalog |
| runScanner | Runs a specific scanner in the user’s catalog |
| stopScanner | Stops a running scanner in the user’s catalog |
Database
| API name | Description |
|---|---|
| getDatabases | Searches for all databases in the user’s catalog |
| getDatabase | Searches for a specific database with the database name of the user's catalog |
Table
| API name | Description |
|---|---|
| getTables | Searches for all tables in the user’s catalog |
| getTable | Searches for a specific table with the database/table name of the user's catalog |
| getTablesByDatabase | Searches for all tables in a specific database with the database name of the user's catalog |
| getTablePartitions | Searches for the partition key/value of a specific table with the database/table name of the user's catalog |
| getTableTags | Searches for all tags in the table with the database/table name of the user's catalog |
| getTableSchema | Searches for the schema of a specific table with the database/table name of the user's catalog |
| getTableSchemaVersions | Searches for the schema version of a specific table with the database/table name of the user's catalog |
| getTableSchemaByVersion | Searches for the table schema with database/table name and schema version of the user’s catalog |
| getTableSchemaAndPartitionKeys | Searches for the schema/partition key of a specific table with the database/table name of the user catalog |
Error response format
If a wrong API request is sent, or an error occurs during its processing, then the success/failure result is returned as an HTTP status code. The detailed message is then returned in JSON format.
Response examples
{
"error": {
"errorCode": "integer",
"message": "string"
}
}
Error response
| HTTP status | Error code | Message | Description | Solutions |
|---|---|---|---|---|
| 400 | 11006 | Running Metastore is not found | No metastore is running | Send an inquiry in Customer Support > Contact Us |
| 400 | 14443 | This operation is not allowed in the current scanner state. | Occurs when the requested operation is not allowed in the scanner status | Call the operation after checking the scanner status |
| 404 | 14440 | The scanner can't be found. | There is no information on the scanner you are searching for | Reconfirm the call value |
Was this article helpful?