调用SearchDatabase搜索库详情信息

调试

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

请求参数

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

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

PageNumber Integer 1

第几页

SearchKey String testdb

搜索关键字

Tid Long -1

DMS企业版租户ID

DbType String mysql

数据库类型,取值参考RegisterInstance

EnvType String product

库所属环境

PageSize Integer 10

每页记录数

SearchRange String HAS_PERMSSION

权限范围,取值和说明:

  • HAS_PERMSSION: 有权限的
  • OWNER: 我owner的
  • MY_FOCUS: 我关注的
  • UNKNOWN: 不限
SearchTarget String SINGLE_DB

搜索目标,取值和说明如下:

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

返回数据

名称 类型 示例值 描述
ErrorCode String UnknownError

错误码

ErrorMessage String UnknownError

错误信息

RequestId String E0D21075-CD3E-4D98-8264-FD8AD04A63B6

API请求ID

SearchDatabaseList

搜索库详情列表

SearchDatabase

搜索库详情列表

Alias String test

库别名

DatabaseId String 1

库ID

DatalinkName String datalink_name

库所对应datalink

DbType String mysql

数据库类型

DbaId String 1

库的dba id

Encoding String utf8

库编码

EnvType String product

环境类型

Host String xxx.xxx.xxx.xxx

库所实例对应连接地址

Logic Boolean false

是否逻辑库

OwnerIdList 1

库Owner id列表

OwnerIds

库Owner id列表

OwnerNameList user1

库Owner昵称列表

OwnerNames

库Owner昵称列表

Port Integer 3306

库所对应实例端口

SchemaName String test

库名

SearchName String test@xxx.xxx.xxx.xxx:3306

库搜索名

Sid String testSid

库所对应实例sid

Success Boolean true

请求是否成功

TotalCount Long 1

满足条件的记录总数

示例

请求示例


http(s)://[Endpoint]/?Action=SearchDatabase
&PageNumber=1
&SearchKey=testdb
&Tid=-1
&<公共请求参数>

正常返回示例

XML 格式

<TotalCount>1</TotalCount>
<RequestId>E0D21075-CD3E-4D98-8264-FD8AD04A63B6</RequestId>
<SearchDatabaseList>
    <SearchDatabase>
        <Encoding>utf8mb4</Encoding>
        <Host>pc-xxx.mysql.polardb.rds.aliyuncs.com</Host>
        <DbType>polardb</DbType>
        <EnvType>dev</EnvType>
        <OwnerIdList>
            <OwnerIds>88653</OwnerIds>
            <OwnerIds>88656</OwnerIds>
            <OwnerIds>104442</OwnerIds>
        </OwnerIdList>
        <Logic>false</Logic>
        <DbaId>88653</DbaId>
        <OwnerNameList>
            <OwnerNames>dmstest</OwnerNames>
            <OwnerNames>xx</OwnerNames>
            <OwnerNames>xx[子账号]</OwnerNames>
        </OwnerNameList>
        <Port>3306</Port>
        <DatabaseId>117567</DatabaseId>
        <Alias>xx线下库</Alias>
        <SearchName>xxx@pc-xxx.mysql.polardb.rds.aliyuncs.com:3306【xx线下库】</SearchName>
        <DatalinkName>dblink_38</DatalinkName>
        <SchemaName>xxx_0000</SchemaName>
    </SearchDatabase>
</SearchDatabaseList>
<Success>true</Success>

JSON 格式

{
	"TotalCount":1,
	"RequestId":"E0D21075-CD3E-4D98-8264-FD8AD04A63B6",
	"SearchDatabaseList":{
		"SearchDatabase":[
			{
				"Encoding":"utf8mb4",
				"Host":"pc-xxx.mysql.polardb.rds.aliyuncs.com",
				"DbType":"polardb",
				"EnvType":"dev",
				"OwnerIdList":{
					"OwnerIds":[
						88653,
						88656,
						104442
					]
				},
				"Logic":false,
				"DbaId":88653,
				"OwnerNameList":{
					"OwnerNames":[
						"dmstest",
						"xx",
						"xx[子账号]"
					]
				},
				"Port":3306,
				"DatabaseId":117567,
				"Alias":"xx线下库",
				"SearchName":"xxx@pc-xxx.mysql.polardb.rds.aliyuncs.com:3306【xx线下库】",
				"DatalinkName":"dblink_38",
				"SchemaName":"xxx_0000"
			}
		]
	},
	"Success":true
}

错误码

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