getTableSchema

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

VPC環境で利用できます。

ユーザー catalogの database/table名で特定の tableの schemaを照会します。

リクエスト

リクエスト URL

GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/databases/{database-name}/tables/{table-name}/schema

リクエストパラメータ

パラメータ名	要否	タイプ	制約事項	説明
catalogId	Yes	String	catalogの固有 id (ref: getCatalogs)
databaseName	Yes	String		database名
tableName	Yes	String		table名
pageNo	No	int		ページ番号デフォルト値: 1
pageSize	No	int	最大値: 200	結果リストサイズのデフォルト値: 20

リクエストヘッダ

共通ガイド参照

リクエスト例

curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/databases/{database-name}/tables/{table-name}/schema?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}"

レスポンス

レスポンスボディ

項目	タイプ	説明
schema.name	String	フィールド名
schema.type	String	データタイプ
schema.description	String	説明

レスポンス例

HTTP

HTTP Status	Description
200	OK

JSON

{
  "pageNo": 1,
  "pageSize": 20,
  "totalCount": 2,
  "requestId": "e69042d1-8b84-4bdc-902f-95b4dd8f0b88",
  "schema": [
    {
      "name": "id",
      "type": "int",
      "description":"string"
    },
    {
      "name": "test",
      "type": "string",
      "description":"string"
    }
  ]
}

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

What's Next

getTableSchemaAndPartitionKeys

リクエスト
レスポンス

タグ

Data Catalog