使用mgwutil deploy-agent生成代理部署命令-在线迁移服务-阿里云

mgwutil deploy-agent命令用于生成代理部署指令，支持多种参数配置，包括网络方式、部署方法和通道限制，具备校验逻辑和错误处理机制。

命令格式

说明

当代理已存在时：

若指定了 --tunnel-id，工具将校验该 ID 是否与当前代理关联的通道 ID 一致：
- 若不一致，报错；
- 若一致，则进一步校验 --agent-endpoint 和 --deploy-method 是否与现有代理的配置相同，若不同则报错。
若未指定 --tunnel-id，则直接校验 --agent-endpoint 和 --deploy-method 是否与现有代理的配置一致，若不同则报错。

当代理不存在时：

若指定了 --tunnel-id，则创建新代理并将其关联至该通道 ID；
若未指定 --tunnel-id，则自动生成一个新的通道 ID，并创建代理与其关联。

mgwutil deploy-agent <agent-name> 
[--tunnel-id <value>] \
--agent-endpoint <value> \
--deploy-method <value> \ 
[-tags <value>] \
[--max-qps <value>] [--max-bandwidth <value>]

参数说明

参数	必填	说明
agent-name	是	需要创建的代理或者已经创建尚未部署的代理名称。
--tunnel-id	否	指定代理关联的通道 ID，不指定该项默认会询问是否创建新的通道。
--agent-endpoint	是	代理的网络模式。取值：public、vpc。
--deploy-method	是	代理部署方式。取值：default。
--tags	否	为通道设置的标签（仅当需要创建新通道时使用）。
--max-qps	否	通道的 QPS（每秒请求数）上限。
--max-bandwidth	否	通道的带宽上限，单位 Byte/s。

使用示例

以下示例展示了如何生成代理的部署命令。

mgwutil deploy-agent mgwagent-1 --tunnel-id *****-883e-4ee0-95b8-****  --max-qps 1000 --max-bandwidth 12345677 --agent-endpoint public --deploy-method default

返回结果

成功返回

{
  "Code": "success",
  "StatusCode": 200,
  "LogTime": "2025-12-25 17:51:37",
  "Data": {
    "DeployCmd": "wget https://gosspublic.alicdn.com/data_online_migration/agent/aliyun_import_agent_deploy.sh -O aliyun_import_agent_deploy.sh && chmod 755 aliyun_import_agent_deploy.sh && ./aliyun_import_agent_deploy.sh -r cn-hangzhou -t ***-4fa9-4aad-a95e-*** -u *** -i **** -k **** -n mgwutil-agent13456789 -v ***-c42e-4e0d-809a-*** -e public -f default"
  }
}

失败返回

{
  "Code": "fail",
  "StatusCode": 404,
  "LogTime": "2026-01-16 11:06:19",
  "ErrorMsg": "SDKError:    StatusCode: 404    Code: NoSuchImportTunnel    Message: The specified import tunnel does not exist    Data: {'AccessDeniedDetail':null,'Recommend':null,'ecCode':null,'hostId':'1****96****94**5.cn-hangzhou.mgw.aliyuncs.com','requestId':'6969AB2CF8BE3639369A214C','statusCode':404} ",
  "ErrorCode": "NoSuchImportTunnel",
  "RequestId": "6969AB2CF8BE3639369A214C"
}

错误码

说明

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

ErrorCode	说明
ImportAgentNumExceed	代理数量超过限制，默认100。
ImportAgentAlreadyExist	同名代理已存在。
NoSuchImportTunnel	关联通道不存在。
ImportTunnelNumExceed	通道总数超过限制，默认限制50。