すべてのプロダクト
Search

このプロダクト

    Data Management:ListDatabases

    ドキュメントセンター

    Data Management:ListDatabases

    最終更新日:Feb 06, 2026

    ListDatabases API を呼び出して、インスタンスに属するデータベースの一覧を取得します。

    今すぐお試しください

    この 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:ListDatabases

    list

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Tid

    integer

    任意

    テナント ID。

    説明

    右上隅のプロフィール画像にカーソルを合わせると、テナント ID を確認できます。詳細については、「テナント情報の表示」をご参照ください。

    3***
    InstanceId

    string

    必須

    インスタンス ID。これは、ListInstances API の応答で返されるインスタンス情報内のインスタンス ID から取得します。RDS インスタンス ID ではありません。

    12***
    PageNumber

    integer

    任意

    ページ番号。

    1
    PageSize

    integer

    任意

    1 ページあたりのレコード数。

    10

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalCount

    integer

    インスタンスに属するデータベースの数。

    1
    RequestId

    string

    リクエスト ID。

    5541CDA6-F674-435C-81BD-40C2FB926CE3
    DatabaseList

    object

    Database

    array<object>

    データベースの詳細情報一覧。

    array<object>

    DatabaseId

    string

    データベース ID。

    1
    Host

    string

    データベースが属するインスタンスのエンドポイント。

    xxx.xxx.xxx.xxx
    CatalogName

    string

    データベースのカタログ名。

    1
    DbaName

    string

    データベースが属する DBA のニックネーム。

    dba_user
    State

    string

    データベースのステータス。値と説明は以下のとおりです。

    • NORMAL：正常

    • DISABLE：無効化

    • OFFLINE：オフライン

    • NOT_EXIST：存在しない

    NORMAL
    DbaId

    string

    DBA ID。

    1
    SchemaName

    string

    データベース名。

    test
    InstanceId

    string

    データベースが属するインスタンスの ID。

    1
    Port

    integer

    データベースが属するインスタンスの接続ポート。

    3306
    EnvType

    string

    データベースが属する環境タイプ。

    dev
    Sid

    string

    データベースが属するインスタンスの SID。

    test
    OwnerIdList

    object

    OwnerIds

    array

    データベース所有者 ID の一覧。

    string

    データベース所有者 ID。

    1
    Encoding

    string

    データベースのエンコーディング。

    utf-8
    DbType

    string

    データベースの種類。

    mysql
    OwnerNameList

    object

    OwnerNames

    array

    データベース所有者のニックネーム一覧。

    string

    データベース所有者のニックネーム。

    owner_name
    SearchName

    string

    データベース検索に使用する名前。

    test@xxx.xxx.xxx.xxx:3306
    ErrorCode

    string

    エラーコード。

    UnknownError
    ErrorMessage

    string

    エラーメッセージ。

    UnknownError
    Success

    boolean

    リクエストが成功したかどうかを示します。

    true

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 1,
  "RequestId": "5541CDA6-F674-435C-81BD-40C2FB926CE3",
  "DatabaseList": {
    "Database": [
      {
        "DatabaseId": "1",
        "Host": "xxx.xxx.xxx.xxx",
        "CatalogName": "1",
        "DbaName": "dba_user",
        "State": "NORMAL",
        "DbaId": "1",
        "SchemaName": "test",
        "InstanceId": "1",
        "Port": 3306,
        "EnvType": "dev",
        "Sid": "test",
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "Encoding": "utf-8",
        "DbType": "mysql",
        "OwnerNameList": {
          "OwnerNames": [
            "owner_name"
          ]
        },
        "SearchName": "test@xxx.xxx.xxx.xxx:3306"
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    エラーコード

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

    変更履歴

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