GetUserDatabases - 获取网关中的数据库列表_数据管理（兼容数据库备份）(DMS)-阿里云帮助中心

调用此API可以查看指定网关中已添加的数据库列表信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
GatewayId	string	否	网关 ID。	dg-nmz841r7b681****
PageSize	string	是	分页大小。	10
PageNumber	string	是	当前页码。	1
SearchKey	string	否	搜索关键字。	网关。
DbType	string	否	数据库类型。	MYSQL
InstanceId	string	否	数据库实例 ID。	db-22h1qa9d452f****
RegionId	string	否	网关所在地域。	cn-hangzhou
Host	string	否	通过网关所在宿主机去访问数据库的地址。	127.0.XX.XX
Port	integer	否	通过网关所在宿主机去访问数据库的端口。	3306

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID，用于定位日志，排查问题。	514F794F-7E30-5DAA-97C0-0B0D75DA0259
Success	string	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true
Code	string	响应码。	200
ErrorMsg	string	报错信息。	Gateway exception, please launch local dg first
Count	integer	添加的数据库个数。	100
DbInstanceList	array<object>	数据库实例列表。
	object	数据库实例。
Port	integer	通过网关所在宿主机去访问数据库的端口。	3306
Host	string	通过网关所在宿主机去访问数据库的地址。	127.0.XX.XX
GatewayId	string	网关 ID。	dg-pil582nbfe6p****
DbType	string	数据库类型。	MYSQL
RegionId	string	数据库所在地域。	cn-hangzhou
ConnectHost	string	云上 DG 服务代理 IP。	10.0.0.0
ConnectPort	integer	云上 DG 服务代理端口。	10001
ServiceType	string	云上 DG 服务机器类型。	ECS
NetworkType	string	云上 DG 服务代理节点网络类型。	VPC
NodeId	string	云上 DG 服务代理节点 ID。	dg-node-xxxxx
InstanceStatus	string	当前实例的状态。	SUCCESS
DbDescription	string	备注信息。	测试库
InstanceId	string	数据库实例 ID。	db-22h1qa9d452f****
GatewayName	string	网关名称。	测试库
GmtCreate	long	创建时间。	2023-05-03 00:00:00
UserId	string	用户 ID。	100XXXXX
ParentId	string	归属主账号 ID。	100XXXXX
VpcId	string	云上 DG 服务 VPC ID。	vpc-bp1alpkpdb8fh3avx****
VpcInstanceId	string	云上 DG 服务实例 ID。	i-xxxxxxxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "514F794F-7E30-5DAA-97C0-0B0D75DA0259",
  "Success": "true",
  "Code": "200",
  "ErrorMsg": "Gateway exception, please launch local dg first",
  "Count": 100,
  "DbInstanceList": {
    "DbInstance": [
      {
        "Port": 3306,
        "Host": "127.0.XX.XX",
        "GatewayId": "dg-pil582nbfe6p****",
        "DbType": "MYSQL",
        "RegionId": "cn-hangzhou",
        "ConnectHost": "10.0.0.0",
        "ConnectPort": 10001,
        "ServiceType": "ECS",
        "NetworkType": "VPC",
        "NodeId": "dg-node-xxxxx",
        "InstanceStatus": "SUCCESS",
        "DbDescription": "测试库",
        "InstanceId": "db-22h1qa9d452f****\n",
        "GatewayName": "测试库",
        "GmtCreate": 0,
        "UserId": "100XXXXX",
        "ParentId": "100XXXXX",
        "VpcId": "vpc-bp1alpkpdb8fh3avx****",
        "VpcInstanceId": "i-xxxxxxxxxx"
      }
    ]
  }
}

错误码

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