getDatabases

VPC環境で利用できます。

カタログ内のデータベースリストを照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/catalogs/{catalogId}/databases

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`catalogId`	Integer	Required	カタログ ID getCatalogsを参照

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

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

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号 1~N (デフォルト: 1)
`pageSize`	Integer	Optional	ページの出力数 1~200 (デフォルト: 20)
`searchValue`	String	Optional	検索キーワードデータベース名で検索可能

リクエスト例

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

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases?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形式
`databaseResponseList`	Array	-	データベースリスト

`databaseResponseList`

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

フィールド	タイプ	必須の有無	説明
`catalogId`	Integer	-	カタログ ID
`name`	String	-	データベースの名前
`description`	String	-	データベースの説明
`createTime`	String	-	データベースの作成日時 ISO 8601形式

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

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

レスポンス例

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

{
    "pageNo": 1,
    "pageSize": 20,
    "totalCount": 2,
    "requestId": "aff80286-****-****-****-6ac1d306b14a",
    "databaseResponseList": [
        {
            "catalogId": 4**,
            "name": "my_database",
            "description": "my database",
            "createTime": "2025-03-17T16:30:08+0900"
        },
        {
            "catalogId": 4**,
            "name": "default",
            "description": "Default Data Catalog database for test",
            "createTime": "2025-03-17T14:30:26+0900"
        }
    ]
}