全部产品
Search

搜索本产品

    数据管理 DMS：GetDatabase - 获取具体库详情信息

    文档中心

    数据管理 DMS：GetDatabase - 获取具体库详情信息

    更新时间：Aug 27, 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 的用户 ID。

    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 的用户 ID 列表。

    string

    数据库 Owner 的用户 ID。

    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
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    更多信息，参考变更详情。