调用DescribeDbList接口查询获取实例下的数据库信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDbList |
系统规定参数。取值为DescribeDbList。 |
DBInstanceName | String | 是 | pxc-**************** |
实例ID。 |
RegionId | String | 是 | cn-hangzhou |
实例所在地域。 |
DBName | String | 否 | db2 |
数据库名称。 说明 该参数值为空时表示查询目标实例下的所有数据库。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
CharacterSetName | String | utf8 |
数据库的字符编码集,您可以调用DescribeCharacterSet接口查看数据库支持的字符集类型。 |
Data | Array of DB |
数据库信息。 |
|
Accounts | Array of Account |
账号信息。 |
|
AccountName | String | test |
账号名称。 |
AccountPrivilege | String | ReadWrite |
账号在该数据库中的权限,取值范围如下:
|
CharacterSetName | String | utf8 |
数据库的字符编码集,您可以调用DescribeCharacterSet接口查看数据库支持的字符集类型。 |
DBDescription | String | test |
数据库描述信息。 |
DBInstanceName | String | pxc-**************** |
实例ID。 |
DBName | String | db1 |
数据库名称。 |
Message | String | **** |
请求返回消息。 说明 请求成功时该参数为空,请求失败时会返回请求异常信息(如错误码等)。
|
RequestId | String | CF66F53D-6A17-4D1D-A5E4-62E077****** |
请求ID。 |
Success | Boolean | true |
请求是否成功。 |
示例
请求示例
http(s)://polardbx.cn-hangzhou.aliyuncs.com/?Action=DescribeDbList
&DBInstanceName=pxc-a3gfhzrcb9nxkmh35k
&RegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
<code>200</code>
<data>
<RequestId>CF66F53D-6A17-4D1D-A5E4-62E077******</RequestId>
<Message/>
<Data>
<CharacterSetName>utf8</CharacterSetName>
<DBName>db1</DBName>
<Accounts>
<AccountPrivilege>ReadWrite</AccountPrivilege>
<AccountName>test</AccountName>
</Accounts>
<DBInstanceName>pxc-****************</DBInstanceName>
</Data>
<Data>
<CharacterSetName>utf8mb4</CharacterSetName>
<DBDescription>test</DBDescription>
<DBName>db2</DBName>
<Accounts>
<AccountPrivilege>ReadWrite</AccountPrivilege>
<AccountName>test</AccountName>
</Accounts>
<DBInstanceName>pxc-****************</DBInstanceName>
</Data>
<Data>
<CharacterSetName>utf8mb4</CharacterSetName>
<DBName>db3</DBName>
<Accounts>
<AccountPrivilege>ReadWrite</AccountPrivilege>
<AccountName>test</AccountName>
</Accounts>
<DBInstanceName>pxc-****************</DBInstanceName>
</Data>
<Success>true</Success>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>CF66F53D-6A17-4D1D-A5E4-62E077******</requestId>
<successResponse>true</successResponse>
JSON
格式
{
"code": "200",
"data": {
"RequestId": "CF66F53D-6A17-4D1D-A5E4-62E077******",
"Message": "",
"Data": [{
"CharacterSetName": "utf8",
"DBName": "db1",
"Accounts": [{
"AccountPrivilege": "ReadWrite",
"AccountName": "test"
}],
"DBInstanceName": "pxc-****************"
}, {
"CharacterSetName": "utf8mb4",
"DBDescription": "test",
"DBName": "db2",
"Accounts": [{
"AccountPrivilege": "ReadWrite",
"AccountName": "test"
}],
"DBInstanceName": "pxc-****************"
}, {
"CharacterSetName": "utf8mb4",
"DBName": "db3",
"Accounts": [{
"AccountPrivilege": "ReadWrite",
"AccountName": "test"
}],
"DBInstanceName": "pxc-****************"
}],
"Success": true
},
"httpStatusCode": "200",
"requestId": "CF66F53D-6A17-4D1D-A5E4-62E077******",
"successResponse": true
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交