getTables

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

VPC 환경에서 이용 가능합니다.

사용자 catalog의 table 검색

요청

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

이 문서가 도움이 되었습니까?

What's Next

getTable

요청
응답