全部產品
Search
文件中心

Data Management:ListLogicDatabases - 返回邏輯庫詳情列表

更新時間:Mar 21, 2026

調用ListLogicDatabases介面,返回邏輯庫詳情列表。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

dms:ListLogicDatabases

list

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

Tid

integer

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

3***

PageNumber

integer

第幾頁。

1

PageSize

integer

每頁記錄數。

50

返回參數

名稱

類型

描述

樣本值

object

TotalCount

integer

邏輯庫總數。

7

LogicDatabaseList

object

LogicDatabase

array<object>

邏輯庫列表。

array<object>

邏輯庫列表。

DatabaseId

string

邏輯庫 ID。

1***

OwnerIdList

object

OwnerIds

array

邏輯庫 Owner 的使用者識別碼 列表。

string

邏輯庫 Owner 的使用者識別碼。

51****

DbType

string

邏輯庫的資料庫類型,傳回值請參見 DbType 參數說明

POLARDB

OwnerNameList

object

OwnerNames

array

邏輯庫 Owner 的暱稱列表。

string

邏輯庫 Owner 的暱稱。

owner_name

Logic

boolean

是否為邏輯庫,傳回值為 True。

true

SchemaName

string

邏輯庫名。

logic_db

SearchName

string

邏輯庫搜尋名。

說明

建議您的業務不要強依賴該參數,後續版本的格式可能會發生變化。

logic_db[logic_db_alias]

EnvType

string

邏輯庫所屬環境類型,傳回值如下:

  • product:生產環境

  • dev:開發環境

  • pre:預發環境

  • test:測試環境

  • sit:SIT 環境

  • uat:UAT 環境

  • pet:壓測環境

  • stag:STAG 環境

test

Alias

string

邏輯庫別名。

logic_db_alias

DatabaseIds

object

DatabaseIds

array

邏輯庫分庫 ID 列表。

integer

邏輯庫分庫 ID。

12****

RequestId

string

請求 ID。

8068AF82-8A1A-592C-AC2E-6B75338BAB87

ErrorCode

string

錯誤碼。

UnknownError

ErrorMessage

string

錯誤資訊。

UnknownError

Success

boolean

請求是否成功,傳回值如下:

  • true:請求成功

  • false:請求失敗

true

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 7,
  "LogicDatabaseList": {
    "LogicDatabase": [
      {
        "DatabaseId": "1***",
        "OwnerIdList": {
          "OwnerIds": [
            "51****"
          ]
        },
        "DbType": "POLARDB",
        "OwnerNameList": {
          "OwnerNames": [
            "owner_name"
          ]
        },
        "Logic": true,
        "SchemaName": "logic_db",
        "SearchName": "logic_db[logic_db_alias]",
        "EnvType": "test",
        "Alias": "logic_db_alias",
        "DatabaseIds": {
          "DatabaseIds": [
            0
          ]
        }
      }
    ]
  },
  "RequestId": "8068AF82-8A1A-592C-AC2E-6B75338BAB87",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情