GetAgentTask - 获取组件任务的执行状态 - Alibaba Cloud Linux

获取Agent安装任务执行状态

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

sysom:GetAgentTask

get

*全部资源

*

无

请求语法

GET /api/v1/am/agent/get_agent_task HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
task_id	string	否	任务 ID。	42172120177e4b3abd6fabb3a6b5e2dd

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID，可用于全链路诊断	2E75336A-0DB2-5263-B201-A6488EC97B50
code	string	状态码 `code == Success` 则代表授权成功；其它状态码代表授权失败，授权失败时查看 `message` 字段获取详细的错误信息；	Success
data	object	返回数据。
jobs	array<object>	子任务列表
	object	子任务详情
error	string	当任务执行失败时，此字段会报错导致任务失败的原因	已废弃（误用）
errorCode	string	子任务执行失败原因的代码，可能值：空：任务执行正常。 INSTANCE_NOT_SUPPORTED：实例类型不支持 INSTANCE_NOT_EXISTS：实例不存在 INSTANCE_RELEASED：实例已释放 INSTANCE_NOT_RUNNING：实例不在运行中 INSTANCE_NOT_OWNED：实例不属于当前账号 AGENT_ALREADY_INSTALLED：Agent 已安装 AGENT_NOT_INSTALLED：Agent 未安装 AGENT_SAME_VERSION：版本相同 HAS_RUNNING_JOB：有运行中的任务 RPM_LOCK_HELD：RPM lock 被占用 DISK_SPACE_INSUFFICIENT：磁盘空间不足 NODE_LOAD_HIGH：节点负载高 COMMAND_FAILED：命令执行失败 CLIENT_NOT_RUNNING：云助手 Agent 未运行 CLIENT_NOT_RESPONSE：云助手 Agent 无响应 DELIVERY_TIMEOUT：命令发送超时 EXECUTION_TIMEOUT：命令执行超时 TASK_CONCURRENCY_LIMIT：任务并发达上限	DISK_SPACE_INSUFFICIENT
errorMessage	string	子任务执行失败原因的详情，可能值：实例类型不支持实例不存在实例已释放实例不在运行中实例不属于当前账号 Agent 已安装 Agent 未安装 Agent 版本相同，无需升级存在运行中的任务，请稍后重试 RPM lock 被占用，请稍后重试磁盘空间不足节点负载过高，请稍后重试命令执行失败，请稍后重试云助手 Agent 未运行云助手 Agent 无响应命令发送超时命令执行超时任务并发数达到上限	磁盘空间不足
instance	string	实例 ID。	i-2zehme0rs1tc090fdl3n
params	any	子任务参数	{ "agent_version": "3.5.0-beta", "opt": "install", "agent_id": "74a86327-3170-412c-8fd67-da3389ec56a9", "install_type": "InstallAndUpgrade" }
region	string	地域 ID。	cn-hangzhou
result	string	子任务执行结果	已废弃（误用）
status	string	子任务状态： Created：已创建 Running：正在运行 Success：任务运行成功 Fail：任务运行失败	Running
status	string
task_id	string	任务 ID。	c41d8e3506224184a714682fea86d22d
message	string	错误信息如果 `code == Success`，则本字段为空；否则本字段包含请求错误信息。	SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict

示例

正常返回示例

JSON格式

{
  "RequestId": "2E75336A-0DB2-5263-B201-A6488EC97B50",
  "code": "Success",
  "data": {
    "jobs": [
      {
        "error": "已废弃（误用）",
        "errorCode": "DISK_SPACE_INSUFFICIENT",
        "errorMessage": "磁盘空间不足",
        "instance": "i-2zehme0rs1tc090fdl3n",
        "params": "{\n    \"agent_version\": \"3.5.0-beta\",\n    \"opt\": \"install\",\n    \"agent_id\": \"74a86327-3170-412c-8fd67-da3389ec56a9\",\n    \"install_type\": \"InstallAndUpgrade\"\n}",
        "region": "cn-hangzhou",
        "result": "已废弃（误用）",
        "status": "Running"
      }
    ],
    "status": "",
    "task_id": "c41d8e3506224184a714682fea86d22d"
  },
  "message": "SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict"
}

错误码

HTTP status code	错误码	错误信息	描述
400	SysomOpenAPI.AgentNotExists	Agent not exists.	组件不存在。
400	SysomOpenAPI.AgentTaskNotFound	Agent task not found.	组件任务不存在。
400	SysomOpenAPI.AgentVersionNotExists	Agent version not exists.	组件版本不存在。
400	SysomOpenAPI.InstanceNotExists	Instance not exists.	实例不存在。
400	SysomOpenAPI.InvalidParameter	Invalid parameters passed when calling the interface.	调用接口时传递了无效参数
400	SysomOpenAPI.MissingParameter	Missing parameters.	参数缺失
400	SysomOpenAPI.NoAgentInstalled	No SysOM Agent version available.	没有可用的 SysOM Agent。
400	SysomOpenAPI.NotAuthorizedInstance	Instance not authorized.	实例未授权。
400	SysomOpenAPI.NotOwnInstance	Not own current instance.	指定的实例不属于当前用户。
400	SysomOpenAPI.NotOwnTask	Diagnosis result does not belong to the current account.	诊断结果不属于当前账户
400	SysomOpenAPI.NotSupportedAgentVersion	Unsupported sysom agent version.	不支持的 SysOM 客户端版本。
400	SysomOpenAPI.ServerError	Server error, please correct the code according to the error message.	服务端错误，请根据错误提示信息修正代码

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

变更历史

更多信息，参考变更详情。