MENU
      getTables

        getTables


        Article summary

        Available in VPC

        Search table of the user catalog

        Requests

        Request URL

        GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/tables
        HTTP

        Request parameters

        Parameter nameRequirement statusTypeRestrictionsDescription
        catalogIdYesStringUnique catalog ID
        (ref: getCatalogs)
        pageNoNointPage number
        Default: 1
        pageSizeNointMaximum: 200Size of result list
        Default: 20
        databaseNameNoStringSearch keyword for the name pattern of the database
        tableNameNoStringSearch keyword for the name pattern of the table
        locationNoStringSearch keyword for the name pattern of the location
        tagKeyValueNoStringIn the form of "{key}:{value}"Search keyword for key and value of tag
        sort.fieldNoStringField name serving as sort criteria
        sort.isAscNoStringdefault: falseSort by ascending status

        Request headers

        See common guide

        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}"
        Bash

        Responses

        Response bodies

        • tableResponseList: list of tables in the user’s catalog
        ItemTypeDescription
        catalogIdIntUnique catalog ID
        tableNameStringTable name
        databaseNameStringDatabase name
        locationStringPosition of table
        dataFormatStringData format of table
        createTimeDateTable creation date and time
        updateTimeDateTable editing date and time

        Response examples

        HTTP

        HTTP StatusDescription
        200OK

        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"
            }
          ]
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.