---
title: "getTablePartitionKeys"
slug: "analytics-datacatalog-table-gettablepartitionkeys"
updated: 2026-09-17T09:57:35Z
published: 2026-09-17T09:57:35Z
canonical: "api.ncloud-docs.com/analytics-datacatalog-table-gettablepartitionkeys"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# getTablePartitionKeys

VPC環境で利用できます。

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

## リクエスト

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

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

### リクエストヘッダ

Data Catalog APIで共通して使用されるヘッダの詳細は、[Data Catalogのリクエストヘッダ](/docs/ja/analytics-datacatalog#%EC%9A%94%EC%B2%AD%ED%97%A4%EB%8D%94)をご参照ください。

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

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

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `catalogId` | Integer | Required | カタログ ID - [getCatalogs](/docs/ja/analytics-datacatalog-catalog-getcatalogs)を参照 |
| `databaseName` | String | Required | データベース名 - [getDatabases](/docs/ja/analytics-datacatalog-database-getdatabases)を参照 |
| `tableName` | String | Required | テーブル名 - [getTables](/docs/ja/analytics-datacatalog-table-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/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形式 |
| `partitionKeys` | Array | - | パーティションキーリスト: [partitionKeys](/docs/ja/analytics-datacatalog-table-gettablepartitionkeys#partitionKeys) |

#### `partitionKeys`

`partitionKeys`の説明は次の通りです。

| フィールド | タイプ | 必須の有無 | 説明 |
| --- | --- | --- | --- |
| `name` | String | - | フィールド名 |
| `type` | String | - | データ形式 |
| `integerIdx` | Integer | - | パーティションキーの順序 - パーティションの階層構造 - 数字が大きいほど下位分類 |

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

Data Catalog APIで共通して使用されるレスポンスステータスコードの詳細は、[Data Catalogのレスポンスステータスコード](/docs/ja/analytics-datacatalog#%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C)をご参照ください。

### レスポンス例

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

```
{
  "pageNo": 1,
  "pageSize": 20,
  "totalCount": 2,
  "requestId": "ed4cf02b-****-****-****-8639b49fe9a4",
  "partitionKeys": [
    {
      "name": "year",
      "type": "string",
      "integerIdx": 0
    },
    {
      "name": "month",
      "type": "string",
      "integerIdx": 1
    }
  ]
}
```