使用list-agent命令分页列举代理-在线迁移服务-阿里云

mgwutil list-agent命令用于列举已创建的代理信息。默认情况下，该命令按创建时间倒序返回所有代理，支持通过 --marker 和 --count 参数实现分页查询。

命令格式

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

参数说明

参数	必填 \| 可选	说明
--marker	可选	分页查询的起始标记，用于获取下一页数据。首次查询时，无需提供此参数。后续查询时，应传入上一次查询返回结果中 `NextMarker` 字段的值。
--count	可选	指定单页返回的代理数量。
--text	否	响应内容将以纯文本（Text）格式返回。不填结果默认采用纯文本格式返回。
--json	否	响应内容将以JSON格式返回。

使用示例

列举所有代理

执行命令时，默认使用 --text 文本格式按创建时间倒序（从最新到最早）列出所有代理。
- 加入 --text 参数。
```
mgwutil list-agent --text
```
- 不加参数。
```
mgwutil list-agent
```

成功返回

    CreateTime              Name                            Version                                 TunnelId                            
2025-12-22 17:59:15     http-****-for-stability       fcf52b3b-****-4e72-97bc-ca2fe89e4751    15bec4d2-****-4c1a-****-7e9118511f67
2025-12-16 17:35:46     perf-local-****--dest       8e2e2b7f-6724-449d-****-f968bfa87928    6fb****9-9a10-4029-****-7a0e7bd33325
2025-12-16 17:35:22     perf-local-****--src        eade068e-****-494e-a856-f50bd28ca2e2    6fb3c409-****-4029-9c69-7a0****33325
2025-12-03 13:54:15     ****--agent-test-qos           76afdbcb-5331-43c0-****-9245e81ae50a    e954****-6b04-4a09-****-b12a3dbf36e0

执行命令时，使用 --json JSON格式按创建时间倒序（从最新到最早）列出所有代理。

mgwutil list-agent --json

成功返回

{
  "Code": "success",
  "StatusCode": 200,
  "Data": [
    {
      "CreateTime": "2026-01-20 19:52:29",
      "Name": "osshdfs-test-agent2",
      "Version": "3beec9c6-9735-421c-8869-d225d15fc560",
      "TunnelId": "08f725ff-451b-4586-b6c4-aaa719b3bf64"
    },
    {
      "CreateTime": "2025-12-22 17:59:15",
      "Name": "http-server-for-stability",
      "Version": "fcf52b3b-5c61-4e72-97bc-ca2fe89e4751",
      "TunnelId": "15bec4d2-8f4f-4c1a-ba2c-7e9118511f67"
    },
    {
      "CreateTime": "2025-12-16 17:35:46",
      "Name": "perf-local-stability-dest",
      "Version": "8e2e2b7f-6724-449d-aa4b-f968bfa87928",
      "TunnelId": "6fb3c409-9a10-4029-9c69-7a0e7bd33325"
    }
  ],
  "LogTime": "2026-01-21 18:13:05"
}

分页查询代理

当代理总数超过单页数量时，可通过 --marker 和 --count 参数进行分页查询。

加入 --text 参数。

mgwutil list-agent --marker "" --count 2 --text

默认不加参数。

mgwutil list-agent --marker "" --count 2

成功返回

CreateTime              Name                    Version                                 TunnelId                            
2025-08-04 18:14:18     deploy-agent-1          ed10a05e-****-4b52--****--6e73792808b6    f50eb65f-****-45af-****-3df3857eec64
2025-07-04 13:58:10     cube2-local-test        bf3d100d--****--4f44--****--8cf88061bbae    3ea72094-****-4f2e-****-d027785dc6f8

加入 --json 参数。

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

成功返回

{
  "Code": "success",
  "StatusCode": 200,
  "LogTime": "2025-12-25 17:51:37",
  "Data": {
    "ImportAgent": [
      {
        "ActivationKey": "***-ee2d-442d-a0d9-***",
        "AgentEndpoint": "vpc",
        "CreateTime": "2024-09-25T02:02:52.000Z",
        "DeployMethod": "default",
        "ModifyTime": "2024-09-25T02:02:52.000Z",
        "Name": "**-proxy1",
        "Owner": "1445**********34322",
        "Tags": "",
        "TunnelId": "**-4e3f-4c19-afe9-***",
        "Version": "**-db6c-4551-90e3-***"
      },
      {
        "ActivationKey": "*****-4019-49d4-9c97-****",
        "AgentEndpoint": "vpc",
        "CreateTime": "2023-09-22T07:00:51.000Z",
        "DeployMethod": "default",
        "ModifyTime": "2023-09-22T07:00:51.000Z",
        "Name": "***-test-agent-1",
        "Owner": "1445**********34322",
        "Tags": "",
        "TunnelId": "**-618f-46ed-8a13-**",
        "Version": "**-d16c-4217-8d30-***"
      }
    ],
    "NextMarker": "***-test-agent-1",
    "Truncated": true
  }
}

失败返回

{
  "Code": "fail",
  "StatusCode": 400,
  "LogTime": "2026-01-18 22:54:13",
  "ErrorMsg": "SDKError:    StatusCode: 400    Code: InvalidArgument    Message: count is less than 0 or exceed maximum    Data: {'AccessDeniedDetail':null,'Recommend':null,'ecCode':null,'hostId':'1147096387694355.cn-hangzhou.mgw.aliyuncs.com','requestId':'696CF4154A69593830D420B7','statusCode':400} ",
  "ErrorCode": "InvalidArgument",
  "RequestId": "696CF4154A69593830D420B7"
}

错误码

说明

错误码表示错误类别，详情请参考错误信息（ErrorMsg）。
此错误码包含通用错误码。

ErrorCode	说明
InvalidArgument	参数无效或参数值不合法。