调用GetDatabase获取具体库详情信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetDatabase

系统规定参数。取值:GetDatabase

Host String 192.168.XX.XX

数据库连接地址。

Port Integer 3306

数据库的连接端口。

SchemaName String mysql

数据库名称。

Tid Long -1

租户ID。您可以通过调用GetUserActiveTenant接口获取该参数。

Sid String test_sid

数据库Sid。

说明 数据库Sid是Oracle数据库的唯一标识符。当建立一个数据库时,系统将自动赋予一个初始ID。

返回数据

名称 类型 示例值 描述
Database Struct

数据库详情信息。

CatalogName String def

数据库目录名。

DatabaseId String 984****

数据库ID。

DbType String mysql

数据库类型,返回值请参见DbType参数说明

DbaId String 27****

目标数据库的DBA的用户ID。

DbaName String dba_name

目标数据库的DBA昵称。

Encoding String utf8mb4

数据库编码。

EnvType String product

数据库环境类型,返回值如下:

  • product:生产环境。
  • dev:开发环境。
  • pre:预发环境。
  • test:测试环境。
  • sit:SIT环境。
  • uat:UAT环境。
  • pet:压测环境。
  • stag:STAG环境。
Host String 192.168.XX.XX

数据库连接地址。

InstanceId String 149****

实例ID。

OwnerIdList List 27****

数据库Owner的用户ID。

OwnerNameList List test

数据库Owner昵称。

Port Integer 3306

数据库连接端口。

SchemaName String mysql

数据库名称。

SearchName String mysql@192.168.XX.XX:3306

数据库的搜索名称。

Sid String test_sid

数据库Sid。

说明 仅Oracle数据库显示。
State String NORMAL

数据库状态,返回值说明如下:

  • NORMAL: 正常。
  • DISABLE:禁用。
  • OFFLINE:下线。
  • NOT_EXIST:不存在。
ErrorCode String UnknownError

错误码。

ErrorMessage String An unknown error occurred.

错误信息。

RequestId String 3CDB8601-AD74-4A47-8114-08E08CD6****

请求ID。

Success Boolean true

请求是否成功,返回值说明如下:

  • true:请求成功。
  • false:请求失败。

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=GetDatabase
&Host=192.168.XX.XX
&Port=3306
&SchemaName=mysql
&Tid=-1
&<公共请求参数>

正常返回示例

XML格式

<GetDatabaseResponse>
  <RequestId>2EF65A2C-FCDC-5E14-A8B5-8D28F33A****</RequestId>
  <Database>
        <SearchName>mysql@192.168.XX.XX:3306【bw-mysql-el8】</SearchName>
        <InstanceId>149****</InstanceId>
        <Port>3306</Port>
        <Encoding>utf8mb4</Encoding>
        <Host>192.168.XX.XX</Host>
        <DatabaseId>984****</DatabaseId>
        <DbType>mysql</DbType>
        <EnvType>product</EnvType>
        <DbaName>dba_name</DbaName>
        <DbaId>27****</DbaId>
        <State>NORMAL</State>
        <CatalogName>def</CatalogName>
        <OwnerNameList>
              <OwnerNames>test</OwnerNames>
        </OwnerNameList>
        <SchemaName>mysql</SchemaName>
        <OwnerIdList>
              <OwnerIds>27****</OwnerIds>
        </OwnerIdList>
  </Database>
  <Success>true</Success>
</GetDatabaseResponse>

JSON格式

{
    "RequestId": "2EF65A2C-FCDC-5E14-A8B5-8D28F33A****",
    "Database": {
        "SearchName": "mysql@192.168.XX.XX:3306【bw-mysql-el8】",
        "InstanceId": "149****",
        "Port": "3306",
        "Encoding": "utf8mb4",
        "Host": "192.168.XX.XX",
        "DatabaseId": "984****",
        "DbType": "mysql",
        "EnvType": "product",
        "DbaName": "dba_name",
        "DbaId": "27****",
        "State": "NORMAL",
        "CatalogName": "def",
        "OwnerNameList": {
            "OwnerNames": [
                "test"
            ]
        },
        "SchemaName": "mysql",
        "OwnerIdList": {
            "OwnerIds": [
                "27****"
            ]
        }
    },
    "Success": true
}

错误码

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