GetUserGateways - 获取网关列表

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

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

调试

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

授权信息

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

请求参数

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

分页大小。

100
PageNumberinteger

当前页码。

1
SearchKeystring

搜索关键字。

网关。
RegionIdstring

网关所在地域。

cn-hangzhou

返回参数

名称类型描述示例值
object
RequestIdstring

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

41FC4DFE-EA8A-5A56-A16C-F607C3409C79
Successboolean

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

  • true:请求成功。
  • false:请求失败。
true
Codestring

响应码。

200
ErrorMsgstring

报错信息。

Gateway exception, please launch local dg first
Countinteger

已创建的网关数量。

20
GatewayListarray<object>

网关列表信息。

object

网关信息。

GatewayDescstring

网关描述。

本地测试
GatewayNamestring

网关名称。

本地测试。
RegionIdstring

地域 ID。

cn-hangzhou
GatewayIdstring

网关 ID。

dg-lch384wg5701****
Statusstring

状态。

RUNNING
UserIdstring

用户 ID。

100****
CreatorIdstring

网关创建者 ID。

100****
DgVersionstring

网关版本。

3.0
ExceptionMsgstring

网关异常信息。

exception
NumOfExceptionInstanceinteger

异常实例数量。

3
NumOfRunningInstanceinteger

运行中实例数量。

3

示例

正常返回示例

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
      }
    ]
  }
}

错误码

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

上一篇: GetUserGatewayInstances - 获取网关节点详细信息 下一篇: ListDatabaseAccessPoint - 获取数据库访问点列表
阿里云首页 数据管理 相关技术圈