リクエスト

リクエスト URL

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

リクエストパラメータ

パラメータ名	要否	タイプ	制約事項	説明
catalogId	Yes	String	catalogの固有 id (ref: getCatalogs)
pageNo	No	int		ページ番号デフォルト値: 1
pageSize	No	int	最大値: 200	結果リストのサイズデフォルト値: 20
databaseName	No	String		databaseの nameパターン検索キーワード
tableName	No	String		tableの nameパターン検索キーワード
location	No	String		locationの nameパターン検索キーワード
tagKeyValue	No	String	'{key}:{value}’形式	tagの key、value検索キーワード
sort.field	No	String		ソート基準となるフィールド名
sort.isAsc	No	String	default: false	ソート昇順の有無

リクエストヘッダ

共通ガイド参照

リクエスト例

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

レスポンス

レスポンスボディ

tableResponseList: ユーザー catalogの tableリスト

項目	タイプ	説明
catalogId	Int	catalogの固有 id
tableName	String	table名
databaseName	String	database名
location	String	tableの位置
dataFormat	String	tableのデータ形式
createTime	Date	tableの作成日時
updateTime	Date	tableの修正日時

レスポンス例

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

この記事は役に立ちましたか?

リクエスト
レスポンス
- レスポンスボディ
- レスポンス例

タグ

Data Catalog