create-agent (创建代理)

更新时间:
复制为 MD 格式

使用 mgwutil create-agent 命令通过指定代理名称、部署方式、网络类型和通道ID来创建代理,并返回成功或失败的详细结果。

命令格式

mgwutil create-agent <agent-name> --deploy-method <value> --agent-endpoint <value> --tunnel-id <value>

参数说明

参数

必填

说明

agent-name

待创建的代理名称。

--deploy-method

部署方式,可选值 default。

--agent-endpoint

网络类型,可选值 vpc、public。

--tunnel-id

待关联的通道ID。

使用示例

以下示例展示如何创建代理。

mgwutil create-agent mgwutil_agent-12 --deploy-method default --agent-endpoint vpc --tunnel-id **-a591-4f26-9ac2-***

返回结果

成功返回

{
  "Code": "success",
  "StatusCode": 200,
  "LogTime": "2025-12-25 17:51:37",
  "Data": {
    "AgentName": "mgwutil_agent-12",
    "Version": "***-b334-48de-b7a3-***",
    "CreateTime": "2025-07-15T15:05:45.000Z",
    "TunnelId": "*****-168e-42a3-a156-*****"
  }
}

失败返回

{
  "Code": "fail",
  "StatusCode": 404,
  "LogTime": "2026-01-16 10:41:23",
  "ErrorMsg": "SDKError:    StatusCode: 404    Code: NoSuchImportTunnel    Message: The specified import tunnel does not exist    Data: {'AccessDeniedDetail':null,'Recommend':null,'ecCode':null,'hostId':'1***0963****4**5.cn-hangzhou.mgw.aliyuncs.com','requestId':'6969A553FBF8043831989B65','statusCode':404} ",
  "ErrorCode": "NoSuchImportTunnel",
  "RequestId": "6969A553FBF8043831989B65"
}

错误码

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

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

ErrorCode

说明

ImportAgentNumExceed

代理数量超过限制,默认100。

ImportAgentAlreadyExist

同名代理已存在。

NoSuchImportTunnel

关联通道不存在。