すべてのプロダクト
Search

このプロダクト

    :ListDatabases

    ドキュメントセンター

    :ListDatabases

    最終更新日:Oct 15, 2025

    既存のデータベースをリスト表示します。

    操作説明

    メソッド

    GET

    URI

    /openapi/ha3/instances/{instanceId}/sql-studio/databases

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    searchengine:ListDatabases

    list

    *Instance

    acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}

    		 なし なし

    リクエスト構文

    GET /openapi/ha3/instances/{instanceId}/sql-studio/databases HTTP/1.1

    パスパラメータ

    パラメーター

    型

    必須 / 任意

    説明

    例
    instanceId

    string

    必須

    インスタンス ID。

    ha-cn-pl32rf0****

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    リクエストパラメーターは必要ありません。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    requestId

    string

    リクエスト ID。

    E45380E8-994A-5402-9806-F114B3295FCF
    result

    object

    返された結果。

    databases

    array<object>

    データベースのリスト。

    array<object>

    データベースのリスト。

    database

    string

    データベースの名前。

    general
    sqlInstances

    array<object>

    SQL インスタンスに関する情報。

    object

    SQL インスタンスに関する情報。

    id

    integer

    プライマリキー ID。

    12190
    name

    string

    SQL インスタンスの名前。

    general
    type

    string

    table, instance, template, function

    instance
    parent

    integer

    親ノードの ID。

    -1
    children

    array

    サブディレクトリに関する情報。

    any

    サブディレクトリに関する情報。

    1
    isDir

    integer

    項目がフォルダであるかどうかを示します。値 1 は項目がフォルダであることを示します。値 0 はフォルダではないことを示します。

    true
    instanceId

    integer

    インスタンス ID。

    1
    templateId

    integer

    テンプレート ID。

    1
    templates

    array<object>

    テンプレートに関する情報。

    object

    テンプレートに関する情報。

    id

    integer

    プライマリキー ID。

    1
    name

    string

    テンプレートの名前。

    c26_schema
    type

    string

    table, instance, template, function

    template
    parent

    integer

    親ノードの ID。

    -1
    children

    array

    サブディレクトリに関する情報。

    any

    サブディレクトリに関する情報。

    1
    isDir

    integer

    項目がフォルダであるかどうかを示します。値 1 は項目がフォルダであることを示します。値 0 はフォルダではないことを示します。

    true
    instanceId

    integer

    インスタンス ID。

    1
    templateId

    integer

    テンプレート ID。

    1
    functions

    object

    関数に関する情報。

    array<object>

    関数に関する情報。

    object

    関数に関する情報。

    name

    string

    関数の名前。

    test
    signatures

    string

    署名。

    gfasdds2****2wfrkv
    tables

    array<object>

    テーブルに関する情報。

    object

    テーブルに関する情報。

    id

    integer

    プライマリキー ID。

    56
    name

    string

    テーブルの名前。

    general
    type

    string

    table, instance, template, function

    table
    parent

    integer

    親ノードの ID。

    -1
    children

    array

    サブディレクトリに関する情報。

    any

    サブディレクトリに関する情報。

    1
    isDir

    integer

    項目がフォルダであるかどうかを示します。値 1 は項目がフォルダであることを示します。値 0 はフォルダではないことを示します。

    true
    instanceId

    integer

    インスタンス ID。

    1
    templateId

    integer

    テンプレート ID。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
  "result": {
    "databases": [
      {
        "database": "general",
        "sqlInstances": [
          {
            "id": 12190,
            "name": "general",
            "type": "instance",
            "parent": -1,
            "children": [
              "1"
            ],
            "isDir": 0,
            "instanceId": 1,
            "templateId": 1
          }
        ],
        "templates": [
          {
            "id": 1,
            "name": "c26_schema",
            "type": "template",
            "parent": -1,
            "children": [
              "1"
            ],
            "isDir": 0,
            "instanceId": 1,
            "templateId": 1
          }
        ],
        "functions": {
          "key": [
            {
              "name": "test",
              "signatures": "gfasdds2****2wfrkv"
            }
          ]
        },
        "tables": [
          {
            "id": 56,
            "name": "general",
            "type": "table",
            "parent": -1,
            "children": [
              "1"
            ],
            "isDir": 0,
            "instanceId": 1,
            "templateId": 1
          }
        ]
      }
    ]
  }
}

    エラーコード

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

    変更履歴

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