調用DescribeDbList接口獲取數據庫列表。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDbList |
系統規定參數。取值:DescribeDbList。 |
RegionId | String | 是 | cn-hangzhou |
實例所屬的地域ID。 |
DBInstanceName | String | 是 | pxc-******** |
實例名稱。 |
DBName | String | 否 | db_name |
數據庫名字。 |
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
Message | String | Success |
返回信息,成功返回success,錯誤返回對應錯誤碼。 |
RequestId | String | C458B1E8-1683-3645-B154-6BA32080EEA |
請求ID。 |
Success | Boolean | true |
請求是否成功。 |
Data | Array of DB |
數據庫列表。 |
|
DBName | String | test |
數據庫名稱。 |
DBDescription | String | test |
數據庫描述。 |
DBInstanceName | String | pxc-******** |
實例名稱。 |
CharacterSetName | String | utf8mb4 |
字符集。 |
Accounts | Array of Account |
賬戶列表。 |
|
AccountPrivilege | String | ReadWrite |
權限。 |
AccountName | String | root4test |
賬戶名稱。 |
示例
請求示例
http(s)://[Endpoint]/?Action=DescribeDbList
&RegionId=cn-hangzhou
&DBInstanceName=pxc-********
&DBName=db_name
&公共請求參數
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDbListResponse>
<Message>Success</Message>
<RequestId>C458B1E8-1683-3645-B154-6BA32080EEA</RequestId>
<Success>true</Success>
<Data>
<DBName>test</DBName>
<DBDescription>test</DBDescription>
<DBInstanceName>pxc-********</DBInstanceName>
<CharacterSetName>utf8mb4</CharacterSetName>
<Accounts>
<AccountPrivilege>ReadWrite</AccountPrivilege>
<AccountName>root4test</AccountName>
</Accounts>
</Data>
</DescribeDbListResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"Message" : "Success",
"RequestId" : "C458B1E8-1683-3645-B154-6BA32080EEA",
"Success" : true,
"Data" : [ {
"DBName" : "test",
"DBDescription" : "test",
"DBInstanceName" : "pxc-********",
"CharacterSetName" : "utf8mb4",
"Accounts" : [ {
"AccountPrivilege" : "ReadWrite",
"AccountName" : "root4test"
} ]
} ]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。