全部產品
Search

搜尋本產品

    Data Management：GetDatabase - 擷取具體庫詳情資訊

    文件中心

    Data Management：GetDatabase - 擷取具體庫詳情資訊

    更新時間：Mar 21, 2026

    調用GetDatabase擷取具體庫詳情資訊。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dms:GetDatabase

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Tid

    integer

    否

    租戶 ID。您可以通過調用 GetUserActiveTenant 介面擷取該參數。

    -1
    Host

    string

    是

    資料庫連接地址。

    192.168.XX.XX
    Port

    integer

    是

    資料庫的串連連接埠。

    3306
    Sid

    string

    否

    資料庫 Sid。

    說明

    資料庫 Sid 是 Oracle 資料庫的唯一識別碼。當建立一個資料庫時，系統將自動賦予一個初始 ID。

    test_sid
    SchemaName

    string

    是

    資料庫名稱。

    mysql
    RealLoginUserUid

    string

    否

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    3CDB8601-AD74-4A47-8114-08E08CD6****
    Database

    object

    資料庫詳情資訊。

    DatabaseId

    string

    資料庫 ID。

    984****
    Host

    string

    資料庫連接地址。

    192.168.XX.XX
    CatalogName

    string

    資料庫目錄名。

    def
    DbaName

    string

    目標資料庫的 DBA 暱稱。

    dba_name
    State

    string

    資料庫狀態，傳回值說明如下：

    • NORMAL： 正常。

    • DISABLE：禁用。

    • OFFLINE：下線。

    • NOT_EXIST：不存在。

    NORMAL
    DbaId

    string

    目標資料庫的 DBA 的使用者識別碼。

    27****
    SchemaName

    string

    資料庫名稱。

    mysql
    InstanceId

    string

    執行個體 ID。

    149****
    Port

    integer

    資料庫連接連接埠。

    3306
    EnvType

    string

    資料庫環境類型，傳回值如下：

    • product：生產環境。

    • dev：開發環境。

    • pre：預發環境。

    • test：測試環境。

    • sit：SIT 環境。

    • uat：UAT 環境。

    • pet：壓測環境。

    • stag：STAG 環境。

    product
    Sid

    string

    資料庫 Sid。

    說明

    僅 Oracle 資料庫顯示。

    test_sid
    OwnerIdList

    object

    OwnerIds

    array

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

    string

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

    27****
    Encoding

    string

    資料庫編碼。

    utf8mb4
    DbType

    string

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

    mysql
    OwnerNameList

    object

    OwnerNames

    array

    資料庫 Owner 暱稱列表。

    string

    資料庫 Owner 暱稱。

    test
    SearchName

    string

    資料庫的搜尋名稱。

    mysql@192.168.XX.XX:3306
    InstanceAlias

    string

    執行個體別名。

    test
    ErrorCode

    string

    錯誤碼。

    UnknownError
    ErrorMessage

    string

    錯誤資訊。

    An unknown error occurred.
    Success

    boolean

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

    • true：請求成功。

    • false：請求失敗。

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "3CDB8601-AD74-4A47-8114-08E08CD6****",
  "Database": {
    "DatabaseId": "984****",
    "Host": "192.168.XX.XX",
    "CatalogName": "def",
    "DbaName": "dba_name",
    "State": "NORMAL",
    "DbaId": "27****",
    "SchemaName": "mysql",
    "InstanceId": "149****",
    "Port": 3306,
    "EnvType": "product",
    "Sid": "test_sid",
    "OwnerIdList": {
      "OwnerIds": [
        "27****"
      ]
    },
    "Encoding": "utf8mb4",
    "DbType": "mysql",
    "OwnerNameList": {
      "OwnerNames": [
        "test"
      ]
    },
    "SearchName": "mysql@192.168.XX.XX:3306",
    "InstanceAlias": "test"
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "An unknown error occurred.",
  "Success": true
}

    錯誤碼

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

    變更歷史

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