首页 数据管理(兼容数据库备份) 开发参考 API参考-DG API目录 GetUserGatewayInstances - 获取网关节点详细信息

GetUserGatewayInstances - 获取网关节点详细信息

更新时间: 2024-07-12 15:30:50

调用此API可以获取网关节点的详细信息。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
GatewayIdstring

网关 ID。

dg-nmz841r7b681****

返回参数

名称类型描述示例值
object
Codestring

响应码。

200
ErrorMsgstring

报错信息。

Gateway exception, please launch local dg first
RequestIdstring

请求 ID,用于定位日志,排查问题。

514F794F-7E30-5DAA-97C0-0B0D75DA0259
Successboolean

请求是否成功,返回值如下:

  • true:请求成功。
  • false:请求失败。
true
GatewayInstanceListarray<object>

网关节点实例列表。

object

网关节点实例。

GatewayInstanceIdstring

网关节点 ID。

dg-node-wJOb0tO-gaaWFCug****
GatewayIdstring

网关 ID。

dg-159t17m19ps0****
LastUpdateTimelong

上次更新网关节点的时间戳。

1699330233000
LocalIPstring

本地 IP 地址。

127.0.XX.XX
OutputIPstring

主机。

127.0.0.1
Messagestring

提示信息。

SUCCESS
EndPointstring

端点地址。

127.0.XX.XX
CurrentDaemonVersionstring

进程的版本号。

3.0
CurrentVersionstring

版本号。

3.0
RegionIdstring

网关节点所在地域。

cn-hangzhou
ConnectEndpointTypestring

连接类型。

internet
GatewayInstanceStatusstring

网关节点状态。

STOPPED

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "ErrorMsg": "Gateway exception, please launch local dg first",
  "RequestId": "514F794F-7E30-5DAA-97C0-0B0D75DA0259",
  "Success": true,
  "GatewayInstanceList": [
    {
      "GatewayInstanceId": "dg-node-wJOb0tO-gaaWFCug****",
      "GatewayId": "dg-159t17m19ps0****",
      "LastUpdateTime": 1699330233000,
      "LocalIP": "127.0.XX.XX",
      "OutputIP": "  127.0.0.1",
      "Message": "SUCCESS",
      "EndPoint": "127.0.XX.XX",
      "CurrentDaemonVersion": "3.0",
      "CurrentVersion": "3.0",
      "RegionId": "cn-hangzhou",
      "ConnectEndpointType": "internet",
      "GatewayInstanceStatus": "STOPPED"
    }
  ]
}

错误码

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

上一篇: GetUserDatabases - 获取网关中的数据库列表 下一篇: GetUserGateways - 获取网关列表
阿里云首页 数据管理 相关技术圈