getTableSchemaAndPartitionKeys

VPC環境で利用できます。

テーブルスキーマとパーティションキーを同時に照会します。

リクエスト

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

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

リクエストヘッダ

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/atmosphere_data/schema-and-partition-keys?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	-	フィールドの説明値が存在する場合、表示
`integerIdx`	Integer	-	パーティションキーの順序パーティションの階層構造数字が大きいほど下位分類

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

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

レスポンス例

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

{
    "pageNo": 1,
    "pageSize": 20,
    "totalCount": 14,
    "requestId": "f70c9e23-****-****-****-5dabfc1d9e56",
    "schema": [
        {
            "name": "date",
            "type": "bigint"
        },
        {
            "name": "area_code",
            "type": "bigint"
        },
        {
            "name": "area_name",
            "type": "string"
        },
        {
            "name": "measure_center_code",
            "type": "bigint"
        },
        {
            "name": "measure_center_name",
            "type": "string"
        },
        {
            "name": "fine_dust_per_hour",
            "type": "bigint"
        },
        {
            "name": "fine_dust_per_day",
            "type": "bigint"
        },
        {
            "name": "ultrafine_dust_per_day",
            "type": "bigint"
        },
        {
            "name": "ozone_ppm",
            "type": "double"
        },
        {
            "name": "nitrogen_dioxide_concentration_ppm",
            "type": "double"
        },
        {
            "name": "carbon_monoxide_concentration_ppm",
            "type": "double"
        },
        {
            "name": "sulfurous_acid_gas_concentration_ppm",
            "type": "double"
        },
        {
            "name": "year",
            "type": "string",
            "integerIdx": 0
        },
        {
            "name": "month",
            "type": "string",
            "integerIdx": 1
        }
    ]
}