Data Catalog overview

Prev Next

Available in VPC

Data Catalog is a NAVER Cloud Platform service that integrates and manages metadata to enhance the usability of data assets. The Data Catalog service provides APIs for catalog, database, table, connection, and scanner features in RESTful form.

Common Data Catalog settings

The following describes commonly used request and response formats in Data Catalog APIs.

Request

The following describes the common request format.

API URL

The request API URL is as follows:

https://datacatalog.apigw.ntruss.com

Request headers

The following describes the request headers.

Field Required Description
x-ncp-apigw-timestamp Required This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
  • Request is considered invalid if the timestamp differs from the current time by more than 5 minutes.
x-ncp-iam-access-key Required Access key issued on NAVER Cloud Platform
x-ncp-apigw-signature-v2 Required Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256)

Response

The following describes the common response format.

Response body

The response body includes the following data:

responseError

responseError defines the API call failure information. The following describes responseError.

Field Type Required Description
error Object - Error code and message
errorCode Integer - Errors
message String - Error message

Response status codes

The following describes the response status codes.

HTTP status code Code Message Description Solution
400 11006 Running Metastore is not found No metastores in operation Inquire via Contact us in the NAVER Cloud Platform portal.
400 14443 The operation is not allowed in the current scanner status. Request action not allowed in the current scanner status. Check scanner status before calling.
404 14440 The scanner can't be found. No scanner found. Check call value again.
Note

For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.

Response example

For response examples when a call is successful, see each API specification. The following is a sample response upon a failed call.

{
  "error": {
    "errorCode": "integer",
    "message": "string"
  }
}

Data Catalog API

The following describes the APIs provided by the Data Catalog service.

Catalog

The following describes the catalog-related APIs.

API Description
getCatalogs Get catalog

Database

The following describes the database-related APIs.

API Description
getDatabase Get database details
getDatabases Get database list

Table

The following describes the table-related APIs.

API Description
getTable Get table details.
getTablePartitions Get table partition list.
getTablePartitionKeys Get table partition key list.
getTableProperties Get table property details.
getTableSchema Get table schema list.
getTableSchemaAndPartitionKeys Get table schema and partition key list.
getTableSchemaByVersion Get schema version details.
getTableSchemaVersions Get table schema version list.
getTableTags Get table tag list.
getTables Get table list in catalog.
getTablesByDatabase Get table list in database.

Scanner

The following describes the scanner-related APIs.

API Description
getScanner Get scanner details.
getScannerHistories Get scanner execution history.
getScanners Get scanner list.
runScanner Run scanner.
stopScanner Stop scanner execution.

Connection

The following describes the connection-related APIs.

API Description
getConnection Get connection details.
getConnections Get connection list.

Data Catalog related resources

NAVER Cloud Platform provides a variety of related resources to help users better understand Data Catalog APIs.