getDatabases

印刷する
共有
PDF

記事の要約

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

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

VPC環境で利用できます。

ユーザー catalogが持つすべての databaseを照会します。

リクエスト

リクエスト URL

GET {DATA_CATALOG API_URL}/catalogs/{catalog-id}/databases

リクエストパラメータ

パラメータ名	要否	タイプ	制約事項	説明
catalogId	Yes	String	catalogの固有 id (ref: getCatalogs)
pageNo	No	int		ページ番号デフォルト値: 1
pageSize	No	int	最大値: 200	結果リストのサイズデフォルト値: 20
searchValue	No	String		databaseの name検索キーワード

リクエストヘッダ

共通ガイド参照

リクエスト例

curl -X GET "https://datacatalog.apigw.ntruss.com/api/v1/catalogs/{catalog-id}/databases?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}"

レスポンス

レスポンスボディ

databaseResponseList: ユーザー catalogの databaseリスト

項目	タイプ	説明
catalogId	Int	catalogの固有 id
name	String	database名
description	String	databaseの説明
createTime	Date	databaseの作成日時

レスポンス例

HTTP

HTTP Status	Description
200	OK

JSON

{
  "pageNo": 1,
  "pageSize": 20,
  "totalCount": 1,
  "requestId": "7cf2c366-986e-461a-afae-4cc081c153dd",
  "databaseResponseList": [
    {
      "catalogId": 2144,
      "name": "default",
      "description": "Default Data Catalog database1",
      "createTime": "2023-02-21T15:35:30+0900"
    }
  ]
}

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

What's Next

getDatabase

リクエスト
レスポンス

タグ

Data Catalog