全部产品
Search
文档中心

数据管理 DMS:SearchDatabase - 搜索数据库详情列表

更新时间:Mar 17, 2023

搜索库详情信息。

调试

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

调试

授权信息

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

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

请求参数

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

租户ID,可通过调用接口GetUserActiveTenant获取该参数的值。

3***
SearchKeystring

搜索数据库名称的关键字。

testdb
PageNumberinteger

第几页。

1
PageSizeinteger

每页记录数。

10
EnvTypestring

数据库的环境类型,更多信息,请参见实例环境说明

test
SearchRangestring

权限范围,取值如下:

  • HAS_PERMSSION:有权限的数据库
  • OWNER:我Owner的数据库
  • MY_FOCUS:我关注的数据库
  • UNKNOWN:不限
HAS_PERMSSION
SearchTargetstring

搜索目标,取值如下:

  • DB:不限(不区分单库或逻辑库)
  • SINGLE_DB:单库
  • LOGIC_DB:逻辑库
SINGLE_DB
DbTypestring

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

MYSQL

返回参数

名称类型描述示例值
object
TotalCountlong

满足条件的记录总数。

1
RequestIdstring

请求ID。

E0D21075-CD3E-4D98-8264-FD8AD04A63B6
SearchDatabaseListarray

搜索库详情列表。

object

搜索库详情列表。

DatabaseIdstring

数据库ID。

2528****
Hoststring

数据库所在实例的连接地址。

rm-xxxx.mysql.rds.aliyuncs.com
DbaIdstring

实例DBA角色的用户ID。

10****
SchemaNamestring

数据库名称。

test
Logicboolean

是否逻辑库,取值:

  • true:是
  • false:否
false
DatalinkNamestring

跨库查询Datalink名称。

datalink_name
Portinteger

数据库所在实例的端口。

3306
EnvTypestring

数据库的环境类型,更多信息,请参见实例环境说明

test
Sidstring

数据库所在实例Sid。

testSid
OwnerIdListarray

数据库Owner的用户ID。

string

数据库Owner的用户ID列表。

1
Encodingstring

数据库的编码方式。

utf8
DbTypestring

数据库类型。

mysql
OwnerNameListarray

库owner昵称列表。

string

库Owner昵称列表。

user1
SearchNamestring

数据库搜索名。

test@xxx.xxx.xxx.xxx:3306
Aliasstring

数据库别名。

test_rds
CatalogNamestring

数据库目录名。

说明PG系列的数据库将显示数据库名。
dmstest
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

错误信息。

UnknownError
Successboolean

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

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

示例

正常返回示例

JSON格式

{
  "TotalCount": 1,
  "RequestId": "E0D21075-CD3E-4D98-8264-FD8AD04A63B6",
  "SearchDatabaseList": {
    "SearchDatabase": [
      {
        "DatabaseId": "2528****",
        "Host": "rm-xxxx.mysql.rds.aliyuncs.com",
        "DbaId": "10****",
        "SchemaName": "test",
        "Logic": false,
        "DatalinkName": "datalink_name",
        "Port": 3306,
        "EnvType": "test",
        "Sid": "testSid",
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "Encoding": "utf8",
        "DbType": "mysql",
        "OwnerNameList": {
          "OwnerNames": [
            "user1"
          ]
        },
        "SearchName": "test@xxx.xxx.xxx.xxx:3306",
        "Alias": "test_rds",
        "CatalogName": "dmstest"
      }
    ]
  },
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

错误码

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