FindUserGatewayById - 获取网关的详细信息_数据管理（兼容数据库备份）(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，用于定位日志，排查问题。	41FC4DFE-EA8A-5A56-A16C-F607C3409C79
Success	boolean	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true
Gateway	object	网关详情。
GatewayDesc	string	网关描述。	本地测试
GatewayName	string	网关名称。	本地测试
RegionId	string	地域 ID。	cn-hangzhou
GatewayId	string	网关 ID	dg-pv33g51gw69h****
Status	string	状态。	RUNNING
UserId	string	用户 ID。	100****
CreatorId	string	网关创建人。	test_user
DgVersion	string	DG 版本。	3.0
ExceptionMsg	string	错误信息。	Gateway exception, please launch local dg first
NumOfExceptionInstance	integer	异常网关节点数量。	3
NumOfRunningInstance	integer	运行中网关节点数量。	3

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "ErrorMsg": "Gateway exception, please launch local dg first",
  "RequestId": "41FC4DFE-EA8A-5A56-A16C-F607C3409C79",
  "Success": true,
  "Gateway": {
    "GatewayDesc": "本地测试",
    "GatewayName": "本地测试",
    "RegionId": "cn-hangzhou",
    "GatewayId": "dg-pv33g51gw69h****",
    "Status": "RUNNING",
    "UserId": "100****",
    "CreatorId": "test_user",
    "DgVersion": "3.0",
    "ExceptionMsg": "Gateway exception, please launch local dg first",
    "NumOfExceptionInstance": 3,
    "NumOfRunningInstance": 3
  }
}

错误码

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