調用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"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。