すべてのプロダクト
Search

このプロダクト

    Data Management:ListDataLakeDatabase

    ドキュメントセンター

    Data Management:ListDataLakeDatabase

    最終更新日:Mar 21, 2026

    データレイク内のデータベース一覧をクエリします。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dms:ListDataLakeDatabase

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DataRegion

    string

    必須

    データレイクが存在するリージョンです。

    cn-hangzhou
    CatalogName

    string

    必須

    データカタログの名前です。DLF コンソールでデータカタログの名前を確認できます。

    hive
    SearchKey

    string

    任意

    データベースを検索するために使用するキーワードです。

    default
    Tid

    integer

    任意

    テナント ID です。

    説明

    テナント ID を確認するには、Data Management (DMS) コンソールにアクセスし、右上隅のプロフィール画像にポインターを合わせてください。詳細については、「現在のテナントに関する情報の確認」（「DMS テナントの管理」トピック内）をご参照ください。

    3****
    NextToken

    string

    任意

    次のリクエストで新しいページの結果を取得するために使用するページネーショントークンです。有効な値は以下のとおりです。

    • NextToken が空の場合、次のページは存在しません。

    • NextToken の値が返された場合、その値は次のクエリで使用するトークンを示します。

    f056501ada12c1cc
    MaxResults

    integer

    任意

    1 ページあたりのエントリ数です。有効な値：1～100。

    20
    WorkspaceId

    integer

    任意

    ワークスペース ID です。

    12****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンススキーマ

    RequestId

    string

    リクエスト ID です。この ID を使用してログを特定し、問題をトラブルシューティングできます。

    4E1D2B4D-3E53-4ABC-999D-1D2520B3471A
    Success

    boolean

    リクエストが成功したかどうかを示します。有効な値：

    • true：リクエストが成功しました。

    • false：リクエストが失敗しました。

    true
    ErrorCode

    string

    呼び出しが失敗した場合に返されるエラーコードです。

    400
    ErrorMessage

    string

    リクエストが失敗した場合に返されるエラーメッセージです。

    UnknownError
    DatabaseList

    array

    データベースの一覧です。

    DLDatabase

    データベースに関する情報です。

    NextToken

    string

    次のリクエストで新しいページの結果を取得するために使用するページネーショントークンです。NextToken が空の場合、次のページは存在しません。このパラメーターには、前回のクエリから取得した NextToken の値を設定してください。

    NesLoKLEdIZrKhDT7I2gSw==
    MaxResults

    integer

    1 回のリクエストで返される最大エントリ数です。このパラメーターと NextToken を使用してページングを実装できます。

    20

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "4E1D2B4D-3E53-4ABC-999D-1D2520B3471A",
  "Success": true,
  "ErrorCode": "400",
  "ErrorMessage": "UnknownError",
  "DatabaseList": [
    {
      "Description": "Default database for catalog hive",
      "Parameters": {
        "test": "test",
        "test2": 1
      },
      "DbId": 19,
      "CatalogName": "hive",
      "Name": "default",
      "Location": "oss://xxx"
    }
  ],
  "NextToken": "NesLoKLEdIZrKhDT7I2gSw==",
  "MaxResults": 20
}

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。