GetUserGateways - 获取网关列表_数据管理 DMS-阿里云帮助中心

调用此API可以获取用户创建的DG网关列表。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
PageSize	integer	否	分页大小。	100
PageNumber	integer	否	当前页码。	1
SearchKey	string	否	搜索关键字。	网关。
RegionId	string	否	网关所在地域。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID，用于定位日志，排查问题。	41FC4DFE-EA8A-5A56-A16C-F607C3409C79
Success	boolean	请求是否成功，返回值如下： true：请求成功。 false：请求失败。	true
Code	string	响应码。	200
ErrorMsg	string	报错信息。	Gateway exception, please launch local dg first
Count	integer	已创建的网关数量。	20
GatewayList	object
Gateway	array<object>	网关列表信息。
	object	网关信息。
GatewayDesc	string	网关描述。	本地测试
GatewayName	string	网关名称。	本地测试。
RegionId	string	地域 ID。	cn-hangzhou
GatewayId	string	网关 ID。	dg-lch384wg5701****
Status	string	状态。	RUNNING
UserId	string	用户 ID。	100****
CreatorId	string	网关创建者 ID。	100****
DgVersion	string	网关版本。	3.0
ExceptionMsg	string	网关异常信息。	exception
NumOfExceptionInstance	integer	异常实例数量。	3
NumOfRunningInstance	integer	运行中实例数量。	3
AccessDeniedDetail	object
AuthAction	string
AuthPrincipalDisplayName	string
AuthPrincipalOwnerId	string
AuthPrincipalType	string
EncodedDiagnosticMessage	string
NoPermissionType	string
PolicyType	string

示例

正常返回示例

JSON格式

{
  "RequestId": "41FC4DFE-EA8A-5A56-A16C-F607C3409C79",
  "Success": true,
  "Code": "200",
  "ErrorMsg": "Gateway exception, please launch local dg first",
  "Count": 20,
  "GatewayList": {
    "Gateway": [
      {
        "GatewayDesc": "本地测试",
        "GatewayName": "本地测试。",
        "RegionId": "cn-hangzhou",
        "GatewayId": "dg-lch384wg5701****",
        "Status": "RUNNING",
        "UserId": "100****",
        "CreatorId": "100****",
        "DgVersion": "3.0",
        "ExceptionMsg": "exception",
        "NumOfExceptionInstance": 3,
        "NumOfRunningInstance": 3
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "",
    "AuthPrincipalDisplayName": "",
    "AuthPrincipalOwnerId": "",
    "AuthPrincipalType": "",
    "EncodedDiagnosticMessage": "",
    "NoPermissionType": "",
    "PolicyType": ""
  }
}

错误码

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

变更历史

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