全部產品
Search

搜尋本產品

    Data Management：SearchDatabase - 搜尋資料庫詳情列表

    文件中心

    Data Management：SearchDatabase - 搜尋資料庫詳情列表

    更新時間：Mar 21, 2026

    搜尋庫詳情資訊。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dms:SearchDatabase

    list

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Tid

    integer

    否

    租戶 ID，可通過調用介面 GetUserActiveTenant 擷取該參數的值。

    3***
    SearchKey

    string

    否

    搜尋資料庫名稱的關鍵字。

    testdb
    PageNumber

    integer

    否

    第幾頁。

    1
    PageSize

    integer

    否

    每頁記錄數。

    10
    EnvType

    string

    否

    資料庫的環境類型，更多資訊，請參見執行個體環境說明。

    test
    SearchRange

    string

    否

    許可權範圍，取值如下：

    • HAS_PERMSSION：有許可權的資料庫

    • OWNER：我 Owner 的資料庫

    • MY_FOCUS：我關注的資料庫

    • UNKNOWN：不限

    HAS_PERMSSION
    SearchTarget

    string

    否

    搜尋目標，取值如下：

    • DB：不限（不區分單庫或邏輯庫）

    • SINGLE_DB：單庫

    • LOGIC_DB：邏輯庫

    SINGLE_DB
    DbType

    string

    否

    資料庫類型，取值請參見 DbType 參數說明。

    MYSQL
    RealLoginUserUid

    string

    否

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    TotalCount

    integer

    滿足條件的記錄總數。

    1
    RequestId

    string

    請求 ID。

    E0D21075-CD3E-4D98-8264-FD8AD04A63B6
    SearchDatabaseList

    object

    SearchDatabase

    array<object>

    搜尋庫詳情列表。

    array<object>

    搜尋庫詳情列表。

    DatabaseId

    string

    資料庫 ID。

    2528****
    Host

    string

    資料庫所在執行個體的串連地址。

    rm-xxxx.mysql.rds.aliyuncs.com
    DbaId

    string

    執行個體 DBA 角色的使用者識別碼。

    10****
    SchemaName

    string

    資料庫名稱。

    test
    Logic

    boolean

    是否邏輯庫，取值：

    • true：是

    • false：否

    false
    DatalinkName

    string

    跨庫查詢 Datalink 名稱。

    datalink_name
    Port

    integer

    資料庫所在執行個體的連接埠。

    3306
    EnvType

    string

    資料庫的環境類型，更多資訊，請參見執行個體環境說明。

    test
    Sid

    string

    資料庫所在執行個體 Sid。

    testSid
    OwnerIdList

    object

    OwnerIds

    array

    資料庫 Owner 的使用者識別碼。

    string

    資料庫 Owner 的使用者識別碼 列表。

    1
    Encoding

    string

    資料庫的編碼方式。

    utf8
    DbType

    string

    資料庫類型。

    mysql
    OwnerNameList

    object

    OwnerNames

    array

    庫 owner 暱稱列表。

    string

    庫 Owner 暱稱列表。

    user1
    SearchName

    string

    資料庫搜尋名。

    test@xxx.xxx.xxx.xxx:3306
    Alias

    string

    資料庫別名。

    test_rds
    CatalogName

    string

    資料庫目錄名。

    說明

    PG 系列的資料庫將顯示資料庫名。

    dmstest
    ErrorCode

    string

    錯誤碼。

    UnknownError
    ErrorMessage

    string

    錯誤資訊。

    UnknownError
    Success

    boolean

    請求是否成功，傳回值如下：

    • true：請求成功

    • false：請求失敗

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "TotalCount": 1,
  "RequestId": "E0D21075-CD3E-4D98-8264-FD8AD04A63B6",
  "SearchDatabaseList": {
    "SearchDatabase": [
      {
        "DatabaseId": "2528****",
        "Host": "rm-xxxx.mysql.rds.aliyuncs.com",
        "DbaId": "10****",
        "SchemaName": "test",
        "Logic": false,
        "DatalinkName": "datalink_name",
        "Port": 3306,
        "EnvType": "test",
        "Sid": "testSid",
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "Encoding": "utf8",
        "DbType": "mysql",
        "OwnerNameList": {
          "OwnerNames": [
            "user1"
          ]
        },
        "SearchName": "test@xxx.xxx.xxx.xxx:3306",
        "Alias": "test_rds",
        "CatalogName": "dmstest"
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    錯誤碼

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

    變更歷史

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