getTables
- Print
- PDF
getTables
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Search table of the user catalog
Requests
Request URL
GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/tables
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| catalogId | Yes | String | Unique catalog ID (ref: getCatalogs) | |
| pageNo | No | int | Page number Default: 1 | |
| pageSize | No | int | Maximum: 200 | Size of result list Default: 20 |
| databaseName | No | String | Search keyword for the name pattern of the database | |
| tableName | No | String | Search keyword for the name pattern of the table | |
| location | No | String | Search keyword for the name pattern of the location | |
| tagKeyValue | No | String | In the form of "{key}:{value}" | Search keyword for key and value of tag |
| sort.field | No | String | Field name serving as sort criteria | |
| sort.isAsc | No | String | default: false | Sort by ascending status |
Request headers
Request examples
curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/tables?dataFormats=csv&dataFormats=json&databaseName=d&location=s&pageNo=1&pageSize=20&sort.field=tableName&sort.isAsc=true&tableName=r&tagKeyValue=r" \
-H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}" \
-H "x-ncp-iam-access-key: {x-ncp-iam-access-key}" \
-H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
Responses
Response bodies
- tableResponseList: list of tables in the user’s catalog
| Item | Type | Description |
|---|---|---|
| catalogId | Int | Unique catalog ID |
| tableName | String | Table name |
| databaseName | String | Database name |
| location | String | Position of table |
| dataFormat | String | Data format of table |
| createTime | Date | Table creation date and time |
| updateTime | Date | Table editing date and time |
Response examples
HTTP
| HTTP Status | Description |
|---|---|
| 200 | OK |
JSON
{
"pageNo": 1,
"pageSize": 20,
"totalCount": 1,
"requestId": "8778ceab-2a38-45b0-85e6-90c619be8721",
"tableResponseList": [
{
"catalogId": 2144,
"tableName": "scan_dir",
"databaseName": "default",
"location": "s3a://bububu/scan-dir/",
"dataFormat": "csv",
"createTime": "2023-04-10T11:55:02+0900"
"updateTime": "2023-04-11T08:01:33+0900"
}
]
}
Was this article helpful?