调用此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 |
返回参数
示例
正常返回示例
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"
}
]
}
}错误码
访问错误中心查看更多错误码。