getCatalogs

VPC環境で利用できます。

カタログ情報を照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/catalogs

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs?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}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`catalogId`	Integer	-	カタログ ID
`catalogStatus`	String	-	カタログの除隊 `CREATED` \| `DELETED` `CREATED`: 作成完了 `DELETED`: 削除完了
`metastoreStatus`	String	-	カタログメタストアの状態 `METASTORE_STARTING` \| `METASTORE_RUNNING` \| `METASTORE_CONFIGURING` \| `METASTORE_STOPPING` \| `METASTORE_STOPPED` \| `METASTORE_FAILED_START` `METASTORE_STARTING`: 起動中 `METASTORE_RUNNING`: 正常 `METASTORE_CONFIGURING`: 再設定中 `METASTORE_STOPPING`: 停止中 `METASTORE_STOPPED`: 停止 `METASTORE_FAILED_START`: 起動失敗
`createTime`	String	-	カタログの作成日時 ISO 8601形式
`updateTime`	String	-	更新日時 ISO 8601形式

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

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

レスポンス例

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

[
    {
        "catalogId": 4**,
        "catalogStatus": "CREATED",
        "metastoreStatus": "METASTORE_RUNNING",
        "createTime": "2025-03-17T14:29:52+0900",
        "updateTime": "2025-03-17T14:30:40+0900"
    }
]