list-tunnel (列举通道)

更新时间:
复制为 MD 格式

mgwutil list-tunnel命令用于列举已创建的通道,并支持通过 --marker 和 --count 参数控制查询结果。

命令格式

mgwutil list-tunnel [--marker <value>] [--count <value>] [--text] [--json]

参数说明

参数

必填

说明

--marker

分页查询的起始标记。其值来源于上一次查询返回结果中的 NextMarker 字段。首次查询时,可省略该参数。

--count

单次请求返回的最大记录数。

--text

响应内容将以纯文本(Text)格式返回。不填结果默认采用纯文本格式返回。

--json

响应内容将以JSON格式返回。

使用示例

列举所有通道

  • 执行命令时,默认使用 --text 文本格式 按创建时间倒序(从最新到最早)列出所有通道。

    • 加入 --text 参数。

      mgwutil list-tunnel --text
    • 不加参数。

      mgwutil list-tunnel

成功返回

CreateTime              TunnelId                                MaxQps  MaxBandwidth
2025-12-22 17:59:15     15bec4d2-****-4c1a-ba2c-7e****511f67    15000   1073741824  
2025-12-16 17:35:06     6fb3c409-****-4029-****-7a0e7bd33325    0       0           
2025-12-05 15:03:59     654cbc7b-4d9a-****-a2fb-****5fdd763a    0       0           
2025-12-03 13:54:03     e95449af-6b04-****-8db3-b12a****36e0    150     0           
2025-10-20 11:01:42     262****3-7a85-****-9453-bd390b4c4562    0       0
  • 执行命令时,使用 --json JSON格式 按创建时间倒序(从最新到最早)列出所有通道。

mgwutil list-tunnel --json

成功返回

{
  "Code": "success",
  "StatusCode": 200,
  "Data": [
    {
      "CreateTime": "2026-01-20 19:44:33",
      "TunnelId": "08f725ff-****-4586-****-aaa719b3bf64",
      "MaxQps": 0,
      "MaxBandwidth": 0
    },
    {
      "CreateTime": "2025-12-22 17:59:15",
      "TunnelId": "15bec4d2-****-****-ba2c-7e9118511f67",
      "MaxQps": 15000,
      "MaxBandwidth": 1073741824
    },
    {
      "CreateTime": "2025-12-16 17:35:06",
      "TunnelId": "6fb3c409-9a10-****-****-7a0e7bd33325",
      "MaxQps": 0,
      "MaxBandwidth": 0
    },
    {
      "CreateTime": "2025-12-05 15:03:59",
      "TunnelId": "654cbc7b-****-****-a2fb-54565fdd763a",
      "MaxQps": 0,
      "MaxBandwidth": 0
    },
    {
      "CreateTime": "2025-12-03 13:54:03",
      "TunnelId": "e95449af-****-4a09-****-b12a3dbf36e0",
      "MaxQps": 150,
      "MaxBandwidth": 0
    }
  ],
  "LogTime": "2026-01-21 16:04:00"
}

分页查询代理

当数据地址总数超过单页数量时,可通过 --marker--count 参数进行分页查询。

  • 加入 --text 参数。

    mgwutil list-tunnel --marker "" --count 2 --text
  • 默认不加参数。

mgwutil list-tunnel --marker "" --count 2

成功返回

CreateTime              TunnelId                                MaxQps  MaxBandwidth
2026-01-20 19:44:33     08f725ff-451b-4586-b6c4-aaa719b3bf64    0       0           
2025-08-03 15:09:25     0f7aa33f-883f-4740-8f23-bc4f849332b3    0       0   
  • 加入 --json 参数。

mgwutil list-tunnel --marker "" --count 2 --json

成功返回

{
  "Code": "success",
  "StatusCode": 200,
  "Data": {
    "ImportTunnel": [
      {
        "CreateTime": "2026-01-20 19:44:33",
        "TunnelId": "08f725ff-****-4586-****-aaa719b3bf64",
        "MaxQps": 0,
        "MaxBandwidth": 0
      },
      {
        "CreateTime": "2025-08-03 15:09:25",
        "TunnelId": "0f7aa33f-****-4740-****-bc4f849332b3",
        "MaxQps": 0,
        "MaxBandwidth": 0
      }
    ],
    "NextMarker": "0f7aa33f-****-4740-****-bc4f849332b3",
    "Truncated": true
  },
  "LogTime": "2026-01-21 16:41:01"
}

失败返回

{
  "Code": "fail",
  "StatusCode": 400,
  "LogTime": "2026-01-18 23:05:43",
  "ErrorMsg": "SDKError:    StatusCode: 400    Code: InvalidArgument    Message: count is less than 0 or exceed maximum    Data: {'AccessDeniedDetail':null,'Recommend':null,'ecCode':null,'hostId':'1****96****9***5.cn-hangzhou.mgw.aliyuncs.com','requestId':'696CF6C75B0A753138764370','statusCode':400} ",
  "ErrorCode": "InvalidArgument",
  "RequestId": "696CF6C75B0A753138764370"
}

错误码

说明
  • 错误码表示错误类别,详情请参考错误信息(ErrorMsg)。

  • 此错误码包含 通用错误码

ErrorCode

说明

InvalidArgument

参数名无效或参数值不合法。