文档

GetDatabase - 获取具体库详情信息

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:GetDatabaseRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
Tidlong

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

-1
Hoststring

数据库连接地址。

192.168.XX.XX
Portinteger

数据库的连接端口。

3306
Sidstring

数据库 Sid。

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

数据库名称。

mysql

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

数据库详情信息。

DatabaseIdstring

数据库 ID。

984****
Hoststring

数据库连接地址。

192.168.XX.XX
CatalogNamestring

数据库目录名。

def
DbaNamestring

目标数据库的 DBA 昵称。

dba_name
Statestring

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

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

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

27****
SchemaNamestring

数据库名称。

mysql
InstanceIdstring

实例 ID。

149****
Portinteger

数据库连接端口。

3306
EnvTypestring

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

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

数据库 Sid。

说明 仅 Oracle 数据库显示。
test_sid
OwnerIdListarray

数据库 Owner 的用户 ID 列表。

string

数据库 Owner 的用户 ID。

27****
Encodingstring

数据库编码。

utf8mb4
DbTypestring

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

mysql
OwnerNameListarray

数据库 Owner 昵称列表。

string

数据库 Owner 昵称。

test
SearchNamestring

数据库的搜索名称。

mysql@192.168.XX.XX:3306
InstanceAliasstring

实例别名。

test
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

错误信息。

An unknown error occurred.
Successboolean

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

  • 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
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-18OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈