getTableTags
- Print
- PDF
getTableTags
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Searches for all tags in the table with the database/table name of the user's catalog.
Requests
Request URL
GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/databases/{database-name}/tables/{table-name}/tags
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| catalogId | Yes | String | Unique catalog ID (ref: getCatalogs) | |
| databaseName | Yes | String | Database name | |
| tableName | Yes | String | Table name | |
| pageNo | No | int | Default of the page number: 1 | |
| pageSize | No | int | Maximum: 200 | Default of the result list size: 20 |
Request header
Request examples
curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/databases/{database-name}/tables/{table-name}/tags?pageNo=1&pageSize=20" \
-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
| Item | Type | Description |
|---|---|---|
| catalogId | Int | Unique catalog ID |
| tableName | String | Table name |
| databaseName | String | Database name |
| tagKeyTypeValueList[].tagKey | String | Key of the tag |
| tagKeyTypeValueList[].tagType | String | Type of the tag |
| tagKeyTypeValueList[].tagValue | String | Value of the tag |
| tagKeyTypeValueList[].tagTemplateTagId | Int | Unique tag ID |
Response examples
HTTP
| HTTP Status | Description |
|---|---|
| 200 | OK |
JSON
{
"totalCount": 2,
"catalogId": 2144,
"tableName": "scan_dir",
"databaseName": "default",
"tagKeyTypeValueList": [
{
"tagKey": "k2",
"tagType": "BOOLEAN",
"tagValue": "true",
"tagTemplateTagId": 0
},
{
"tagKey": "k1",
"tagType": "STRING",
"tagValue": "v1",
"tagTemplateTagId": 0
}
]
}
Was this article helpful?