调用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

请求是否成功，返回值如下：

  • true：请求成功。
  • false：请求失败。
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"
}

错误码

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