getTablePartitions

印刷する
共有
PDF

記事の要約

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

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

VPC環境で利用できます。

ユーザー catalogの database/table名で特定の tableの partition key/valueを照会

リクエスト

リクエスト URL

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

リクエストパラメータ

パラメータ名	要否	タイプ	制約事項	説明
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}/partitions?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}"

レスポンス

レスポンスボディ

partitionList: ユーザー tableの partitionリスト

項目	タイプ	説明
partitionKey.name	String	partition key名
partitionValue.valueList[]	String	partition value名

レスポンス例

HTTP

HTTP Status	Description
200	OK

JSON

{
  "requestId": "d8a6ad30-2d95-4c4d-872a-523cde8356b6",
  "totalCount": 3,
  "partitionList": [
    {
      "partitionKey": {
        "name": "partition_0"
      },
      "partitionValue": {
        "valueList": [
          "test01",
          "test01"
        ]
      }
    },
    {
      "partitionKey": {
        "name": "partition_1"
      },
      "partitionValue": {
        "valueList": [
          "sales",
          "sales"
        ]
      }
    },
    {
      "partitionKey": {
        "name": "partition_2"
      },
      "partitionValue": {
        "valueList": [
          "2021",
          "2022"
        ]
      }
    }
  ]
}

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

What's Next

getTableTags

リクエスト
レスポンス

タグ

Data Catalog