調用GetUserDatabases接口,返回用戶數據庫列表信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetUserDatabases |
系統規定參數。取值:GetUserDatabases。 |
GatewayId | String | 否 | dg-yhss6sdlaff**** |
網關ID。 |
PageSize | String | 是 | 10 |
分頁大小。 |
PageNumber | String | 是 | 1 |
當前頁碼。 |
SearchKey | String | 否 | 網關 |
搜索關鍵字。 |
DbType | String | 否 | MySQL |
數據庫類型。 說明 目前數據庫類型僅支持MySQL。
|
InstanceId | String | 否 | db |
實例ID。 |
RegionId | String | 否 | cn-hangzhou |
地域ID。 |
Host | String | 否 | 11.*.*.109 |
通過網關所在宿主機去訪問數據庫的地址。 |
Port | Integer | 否 | 3440 |
通過網關所在宿主機去訪問數據庫的端口。 |
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
Data | String | [{ “dbDescription” :“開發環境數據庫” ,“dbType” :“MySQL” ,“dbUserName” :“dbatool” ,“gatewayId” :“test_gateway” ,“gatewayName” :“Gateway—1” ,“gmtCreate” :1560736969000,“gmtCreateString” :“2019-06-17 10:02” ,“host” :“11.*.*.109” ,“instanceId” :“instance_1” ,“parentId” :“134****” ,“port” :3440,“userId” :“134****” }] |
數據庫列表信息。 |
RequestId | String | 951AE6AA-BFC5-4DD8-8CD6-DFD3D51E4170 |
請求ID。 |
Success | String | true |
請求是否成功,返回值如下:
|
Code | String | OK |
響應碼。 |
ErrorMsg | String | 無 |
異常信息。 |
Count | Integer | 1 |
個數。 |
示例
請求示例
http(s)://dg.cn-hangzhou.aliyuncs.com/?Action=GetUserDatabases
&GatewayId=dg-yhss6sdlaff****
&PageSize=10
&PageNumber=1
&SearchKey=網關
&DbType=MySQL
&InstanceId=db
&RegionId=cn-hangzhou
&Host=11.*.*.109
&Port=3440
&公共請求參數
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<GetUserDatabasesResponse>
<RequestId>951AE6AA-BFC5-4DD8-8CD6-DFD3D51E4170</RequestId>
<ErrorMsg>無</ErrorMsg>
<Data>[{ “dbDescription” :“開發環境數據庫” ,“dbType” :“MySQL” ,“dbUserName” :“dbatool” ,“gatewayId” :“test_gateway” ,“gatewayName” :“Gateway—1” ,“gmtCreate” :1560736969000,“gmtCreateString” :“2019-06-17 10:02” ,“host” :“11.*.*.109” ,“instanceId” :“instance_1” ,“parentId” :“134****” ,“port” :3440,“userId” :“134****” }]</Data>
<Count>1</Count>
<Code>OK</Code>
<Success>true</Success>
</GetUserDatabasesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "951AE6AA-BFC5-4DD8-8CD6-DFD3D51E4170",
"ErrorMsg" : "無",
"Data" : "[{ “dbDescription” :“開發環境數據庫” ,“dbType” :“MySQL” ,“dbUserName” :“dbatool” ,“gatewayId” :“test_gateway” ,“gatewayName” :“Gateway—1” ,“gmtCreate” :1560736969000,“gmtCreateString” :“2019-06-17 10:02” ,“host” :“11.*.*.109” ,“instanceId” :“instance_1” ,“parentId” :“134****” ,“port” :3440,“userId” :“134****” }]",
"Count" : "1",
"Code" : "OK",
"Success" : "true"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。