getDatabase

VPC環境で利用できます。

データベースの詳細情報を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`catalogId`	Integer	Required	カタログ ID getCatalogsを参照
`databaseName`	String	Required	データベース名 getDatabasesを参照

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

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

フィールド	タイプ	必須の有無	説明
`includeTags`	Boolean	Required	レスポンスにタグを含めるかどうか `true` \| `false` `true`: 含める `false`: 含めない

リクエスト例

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

curl --location --request GET 'https://datacatalog.apigw.ntruss.com/api/v1/catalogs/4**/databases/my_database?includeTags=true' \
--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
`name`	String	-	データベースの名前
`databaseName`	String	-	データベースの名前
`description`	String	-	データベースの説明
`location`	String	-	データベースの位置
`tagKeyTypeValueList`	Array	-	タグリストリクエストで`includeTags`が`true`の場合、表示
`createTime`	String	-	データベースの作成日時 ISO 8601形式
`updateTime`	String	-	データベースの更新日時 ISO 8601形式

`tagKeyTypeValueList`

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

フィールド	タイプ	必須の有無	説明
`tagKey`	String	-	タグキー
`tagType`	String	-	タグのタイプ
`tagValue`	String	-	タグの値
`tagTemplateTagId`	Integer	-	タグ ID タグテンプレートに保存されたタグの固有番号タグテンプレートに保存されていない場合: `0`

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

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

レスポンス例

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

{
    "catalogId": 4**,
    "name": "my_database",
    "databaseName": "my_database",
    "description": "my database",
    "location": "s3a://datacatalog-c***-e******f/my_database",
    "tagKeyTypeValueList": [
        {
            "tagKey": "name",
            "tagType": "STRING",
            "tagValue": "name",
            "tagTemplateTagId": 464
        }
    ],
    "createTime": "2025-03-17T16:30:08+0900",
    "updateTime": "2025-03-17T16:57:43+0900"
}