getTableSchema

VPC環境で利用できます。

テーブルスキーマを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/api/v1/catalogs/{catalogId}/databases/{databaseName}/tables/{tableName}/schema

リクエストヘッダ

Data Catalog APIで共通して使用されるヘッダの詳細は、Data Catalogのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`catalogId`	Integer	Required	カタログ ID getCatalogsを参照
`databaseName`	String	Required	データベース名 getDatabasesを参照
`tableName`	String	Required	テーブル名 getTablesを参照

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号 1~N (デフォルト: 1)
`pageSize`	Integer	Optional	ページの出力数 1~200 (デフォルト: 20)

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases/default/tables/goods/schema?pageNo=1&pageSize=20' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	-	ページ番号
`pageSize`	Integer	-	ページ表示数
`totalCount`	Integer	-	レスポンス結果数
`requestId`	String	-	リクエスト ID UUID形式
`schema`	Array	-	スキーマ情報

`schema`

schemaの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`name`	String	-	フィールド名
`type`	String	-	データ形式
`typeValue`	String	-	データ形式の制限事項値が存在する場合、表示 `type`が`array`の場合、下位フィールドを表示
`description`	String	-	フィールドの説明値が存在する場合、表示

レスポンスステータスコード

Data Catalog APIで共通して使用されるレスポンスステータスコードの詳細は、Data Catalogのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "pageNo": 1,
    "pageSize": 20,
    "totalCount": 7,
    "requestId": "24b9642d-****-****-****-b9f50ff795c8",
    "schema": [
        {
            "name": "goods_id",
            "type": "int"
        },
        {
            "name": "name",
            "type": "varchar",
            "typeValue": "100"
        },
        {
            "name": "category",
            "type": "varchar",
            "typeValue": "50"
        },
        {
            "name": "price",
            "type": "decimal",
            "typeValue": "10,2",
            "description": "US dollar"
        },
        {
            "name": "stock_quantity",
            "type": "int"
        },
        {
            "name": "supplier",
            "type": "varchar",
            "typeValue": "100"
        },
        {
            "name": "added_date",
            "type": "timestamp",
            "description": "unix timestamp"
        }
    ]
}