getDatabase
- 印刷する
- PDF
getDatabase
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
ユーザー catalogの database名で特定の databaseを照会します。
リクエスト
リクエスト URL
GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/databases/{database-name}
リクエストパラメータ
| パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
|---|---|---|---|---|
| catalogId | Yes | String | catalogの固有 id (ref: getCatalogs) | |
| databaseName | Yes | String | database名 | |
| includeTags | Yes | Boolean | レスポンス値内の tag情報有無 |
リクエストヘッダ
リクエスト例
curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/databases/{database-name}?includeTags=true" \
-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}"
レスポンス
レスポンスボディ
| 項目 | タイプ | 説明 |
|---|---|---|
| catalogId | Int | catalogの固有 id |
| name | String | database名 |
| databaseName | String | database名 |
| description | String | databaseの説明 |
| location | String | databaseの位置 |
| tagKeyTypeValueList[].tagKey | String | tagの key |
| tagKeyTypeValueList[].tagType | String | tagの type |
| tagKeyTypeValueList[].tagValue | String | tagの value |
| tagKeyTypeValueList[].tagTemplateTagId | Int | tagの固有 id |
| createTime | Date | databaseの作成日時 |
| updateTime | Date | databaseの修正日時 |
レスポンス例
HTTP
| HTTP Status | Description |
|---|---|
| 200 | OK |
JSON
{
"catalogId": 2144,
"name": "default",
"databaseName": "default",
"description": "Default Data Catalog database1",
"location": "s3a://datacatalog-c2144-a0211690/default",
"tagKeyTypeValueList": [
{
"tagKey": "key",
"tagType": "STRING",
"tagValue": "value",
"tagTemplateTagId": 0
}
],
"createTime": "2023-02-21T15:35:09+0900",
"updateTime": "2023-02-21T16:22:00+0900"
}
この記事は役に立ちましたか?