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

调试

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

请求参数

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

系统规定参数。取值：GetDatabase。
Host String 是 xxx.xxx.xxx.xxx

实例连接地址
Port Integer 是 3306

实例连接端口
SchemaName String 是 test_db

库名
Tid Long 是 -1

DMS企业版租户ID
Sid String 否 test_sid

实例sid

返回数据

名称 类型 示例值 描述
Database

库详情信息
CatalogName String def

CatalogName
DatabaseId String 1

库ID
DbType String mysql

数据库类型
DbaId String 1

dba id
DbaName String dba_name

dba昵称
Encoding String utf8mb4

库编码
EnvType String test

库环境类型
Host String xxx.xxx.xxx.xxx

实例连接地址
InstanceId String 1

实例id
OwnerIdList 1

库owner id 列表
OwnerIds

库owner id 列表
OwnerNameList test

库owner 昵称列表
OwnerNames

库owner 昵称列表
Port Integer 3306

实例连接端口
SchemaName String test_db

库名
SearchName String test_db@xxx.xxx.xxx.xxx:3306

库搜索名
Sid String test_sid

实例sid
State String NORMAL

库状态，取值参考ListDatabases
ErrorCode String UnknownError

错误码
ErrorMessage String UnknownError

错误信息
RequestId String 3CDB8601-AD74-4A47-8114-08E08CD6319D

请求ID
Success Boolean true

请求是否成功

示例

请求示例


http(s)://[Endpoint]/?Action=GetDatabase
&Host=xxx.xxx.xxx.xxx
&Port=3306
&SchemaName=test_db
&Tid=-1
&<公共请求参数>

正常返回示例

XML 格式 

<Database>
    <Encoding>utf8mb4</Encoding>
    <Host>pc-xxx.rwlb.rds.aliyuncs.com</Host>
    <InstanceId>24710</InstanceId>
    <DbType>polardb</DbType>
    <OwnerIdList>
        <OwnerIds>88653</OwnerIds>
        <OwnerIds>104442</OwnerIds>
    </OwnerIdList>
    <EnvType>product</EnvType>
    <DbaId>104442</DbaId>
    <OwnerNameList>
        <OwnerNames>xxx</OwnerNames>
        <OwnerNames>xxx[子账号]</OwnerNames>
    </OwnerNameList>
    <Port>3306</Port>
    <DatabaseId>116367</DatabaseId>
    <State>NORMAL</State>
    <SearchName>xxx_test@pc-xxx.rwlb.rds.aliyuncs.com:3306【xxx_test】</SearchName>
    <DbaName>xxx[子账号]</DbaName>
    <SchemaName>xxx_test</SchemaName>
</Database>
<RequestId>3CDB8601-AD74-4A47-8114-08E08CD6319D</RequestId>
<Success>true</Success>

JSON 格式 

{
	"Database":{
		"Encoding":"utf8mb4",
		"Host":"pc-xxx.rwlb.rds.aliyuncs.com",
		"InstanceId":24710,
		"DbType":"polardb",
		"OwnerIdList":{
			"OwnerIds":[
				88653,
				104442
			]
		},
		"EnvType":"product",
		"DbaId":104442,
		"OwnerNameList":{
			"OwnerNames":[
				"xxx",
				"xxx[子账号]"
			]
		},
		"Port":3306,
		"DatabaseId":116367,
		"State":"NORMAL",
		"SearchName":"xxx_test@pc-xxx.rwlb.rds.aliyuncs.com:3306【xxx_test】",
		"DbaName":"xxx[子账号]",
		"SchemaName":"xxx_test"
	},
	"RequestId":"3CDB8601-AD74-4A47-8114-08E08CD6319D",
	"Success":true
}

错误码

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