文档

GetAgentStatus - 获取代理状态

更新时间:
一键部署

获取代理运行状态。

接口说明

  • 获取代理状态,您必须有 mgw:GetImportAgent 权限。

调试

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

授权信息

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

请求语法

GET /agent/{agentName}?status HTTP/1.1 Host: userid.cn-hangzhou.mgw.aliyuncs.com

请求参数

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

代理名称。

test_agent_name

返回参数

名称类型描述示例值
object

获取代理状态的响应体。

ImportAgentStatusGetAgentStatusResp

获取代理状态详情。

示例

正常返回示例

JSON格式

{
  "ImportAgentStatus": {
    "Status": "OK"
  }
}

XML格式

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ImportAgentStatus>
  <Status>OK</Status>
</ImportAgentStatus>

错误码

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