调用SearchDatabase搜索数据库的详情信息。

调试

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

请求参数

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

系统规定参数。取值：SearchDatabase。

Tid Long 是 3***

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

SearchKey String 是 testdb

搜索数据库名称的关键字。
PageNumber Integer 是 1

第几页。
PageSize Integer 否 10

每页记录数。
EnvType String 否 test

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

SearchRange String 否 HAS_PERMSSION

权限范围，取值如下：

  • HAS_PERMSSION：有权限的数据库
  • OWNER：我Owner的数据库
  • MY_FOCUS：我关注的数据库
  • UNKNOWN：不限
SearchTarget String 否 SINGLE_DB

搜索目标，取值如下：

  • DB：不限（不区分单库或逻辑库）
  • SINGLE_DB：单库
  • LOGIC_DB：逻辑库
DbType String 否 MYSQL

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

RegionId String 否 cn-hangzhou

DMS服务地域，取值请参见RegionID参数说明。

返回数据

名称 类型 示例值 描述
TotalCount Long 1

满足条件的记录总数。
RequestId String E0D21075-CD3E-4D98-8264-FD8AD04A63B6

请求ID。
SearchDatabaseList Array of SearchDatabase

搜索库详情列表。
SearchDatabase
DatabaseId String 2528****

数据库ID。
Host String rm-xxxx.mysql.rds.aliyuncs.com

数据库所在实例的连接地址。
DbaId String 10****

实例DBA角色的用户ID。
SchemaName String test

数据库名称。
Logic Boolean false

是否逻辑库，取值：

  • true：是
  • false：否
DatalinkName String datalink_name

跨库查询Datalink名称。
Port Integer 3306

数据库所在实例的端口。
EnvType String test

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

Sid String testSid

数据库所在实例Sid。
OwnerIdList Array of String 1

数据库Owner的用户ID列表。
Encoding String utf8

数据库的编码方式。
DbType String mysql

数据库类型。
OwnerNameList Array of String user1

库Owner昵称列表。
SearchName String test@xxx.xxx.xxx.xxx:3306

数据库搜索名。
Alias String test_rds

数据库别名。
ErrorCode String UnknownError

错误码。
ErrorMessage String UnknownError

错误信息。
Success Boolean true

请求是否成功，返回值如下：

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

示例

请求示例

http(s)://dms-enterprise.aliyuncs.com/?Action=SearchDatabase
&Tid=3***
&SearchKey=testdb
&PageNumber=1
&PageSize=10
&EnvType=test
&SearchRange=HAS_PERMSSION
&SearchTarget=SINGLE_DB
&DbType=MYSQL
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<SearchDatabaseResponse>
    <TotalCount>1</TotalCount>
    <RequestId>E0D21075-CD3E-4D98-8264-FD8AD04A63B6</RequestId>
    <SearchDatabaseList>
        <DatabaseId>2528****</DatabaseId>
        <Host>rm-xxxx.mysql.rds.aliyuncs.com</Host>
        <DbaId>10****</DbaId>
        <SchemaName>test</SchemaName>
        <Logic>false</Logic>
        <DatalinkName>datalink_name</DatalinkName>
        <Port>3306</Port>
        <EnvType>test</EnvType>
        <Sid>testSid</Sid>
        <OwnerIdList>1</OwnerIdList>
        <Encoding>utf8</Encoding>
        <DbType>mysql</DbType>
        <OwnerNameList>user1</OwnerNameList>
        <SearchName>test@xxx.xxx.xxx.xxx:3306</SearchName>
        <Alias>test_rds</Alias>
    </SearchDatabaseList>
    <Success>true</Success>
</SearchDatabaseResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 1,
  "RequestId" : "E0D21075-CD3E-4D98-8264-FD8AD04A63B6",
  "SearchDatabaseList" : [ {
    "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" : [ "1" ],
    "Encoding" : "utf8",
    "DbType" : "mysql",
    "OwnerNameList" : [ "user1" ],
    "SearchName" : "test@xxx.xxx.xxx.xxx:3306",
    "Alias" : "test_rds"
  } ],
  "Success" : true
}

错误码

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