GetUserGatewayInstances - 获取网关节点详细信息_数据管理 DMS-阿里云帮助中心

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

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
GatewayId	string	是	网关 ID。	dg-nmz841r7b681****

返回参数

名称	类型	描述	示例值
	object
Code	string	响应码。	200
ErrorMsg	string	报错信息。	Gateway exception, please launch local dg first
RequestId	string	请求 ID，用于定位日志，排查问题。	514F794F-7E30-5DAA-97C0-0B0D75DA0259
Success	boolean	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true
GatewayInstanceList	array<object>	网关节点实例列表。
	object	网关节点实例。
GatewayInstanceId	string	网关节点 ID。	dg-node-wJOb0tO-gaaWFCug****
GatewayId	string	网关 ID。	dg-159t17m19ps0****
LastUpdateTime	integer	上次更新网关节点的时间戳。	1699330233000
LocalIP	string	本地 IP 地址。	127.0.XX.XX
OutputIP	string	主机。	127.0.0.1
Message	string	提示信息。	SUCCESS
EndPoint	string	端点地址。	127.0.XX.XX
CurrentDaemonVersion	string	进程的版本号。	3.0
CurrentVersion	string	版本号。	3.0
RegionId	string	网关节点所在地域。	cn-hangzhou
ConnectEndpointType	string	连接类型。	internet
GatewayInstanceStatus	string	网关节点状态。	STOPPED
AccessDeniedDetail	object
AuthAction	string
AuthPrincipalDisplayName	string
AuthPrincipalOwnerId	string
AuthPrincipalType	string
EncodedDiagnosticMessage	string
NoPermissionType	string
PolicyType	string

示例

正常返回示例

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"
    }
  ],
  "AccessDeniedDetail": {
    "AuthAction": "",
    "AuthPrincipalDisplayName": "",
    "AuthPrincipalOwnerId": "",
    "AuthPrincipalType": "",
    "EncodedDiagnosticMessage": "",
    "NoPermissionType": "",
    "PolicyType": ""
  }
}

错误码

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

变更历史

更多信息，参考变更详情。