getTablePartitions

VPC環境で利用できます。

テーブルのパーティションリストを照会します。

リクエスト

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

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

リクエストヘッダ

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/log_database/tables/log_table_2/partitions?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形式
`partitionList`	Array	-	パーティションリスト

`partitionList`

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

フィールド	タイプ	必須の有無	説明
`partitionKey`	Object	-	パーティションキー情報
`partitionKey.name`	String	-	パーティションキー名
`partitionValue`	Object	-	パーティション値情報
`partitionValue.valueList`	Array	-	パーティション値リスト

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

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

レスポンス例

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

{
    "pageNo": 1,
    "pageSize": 20,
    "totalCount": 6,
    "requestId": "595f3abc-****-****-****-8c7053506eef",
    "partitionList": [
        {
            "partitionKey": {
                "name": "year"
            },
            "partitionValue": {
                "valueList": [
                    "2022",
                    "2022",
                    "2022",
                    "2023",
                    "2023",
                    "2023"
                ]
            }
        },
        {
            "partitionKey": {
                "name": "month"
            },
            "partitionValue": {
                "valueList": [
                    "10",
                    "11",
                    "12",
                    "01",
                    "02",
                    "03"
                ]
            }
        }
    ]
}