全部產品
Search

搜尋本產品

    Data Management：ListDatabases - 擷取執行個體的資料庫詳情列表

    文件中心

    Data Management：ListDatabases - 擷取執行個體的資料庫詳情列表

    更新時間：Feb 06, 2026

    調用ListDatabases擷取一個執行個體下的資料庫列表詳情資訊。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dms:ListDatabases

    list

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Tid

    integer

    否

    租戶 ID。

    說明

    取自系統右上方頭像處懸停展示的租戶 ID 資訊，詳情請參見查看租戶資訊。

    3***
    InstanceId

    string

    是

    執行個體 ID，取值來自 ListInstances 介面返回的執行個體資訊中的執行個體 ID，注意不是 RDS 的執行個體 ID。

    12***
    PageNumber

    integer

    否

    第幾頁。

    1
    PageSize

    integer

    否

    每頁記錄數。

    10
    SearchKey

    string

    否

    返回參數

    名稱

    類型

    描述

    樣本值

    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

    庫 Owner ID 列表。

    string

    庫 Owner ID。

    1
    Encoding

    string

    庫編碼。

    utf-8
    DbType

    string

    資料庫類型。

    mysql
    OwnerNameList

    object

    OwnerNames

    array

    庫 Owner 暱稱列表。

    string

    庫 Owner 暱稱。

    owner_name
    SearchName

    string

    搜尋資料庫的名稱。

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

    string

    錯誤碼。

    UnknownError
    ErrorMessage

    string

    錯誤資訊。

    UnknownError
    Success

    boolean

    請求是否成功。

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "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
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。