GetAgentTask_操作系统智能运维平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
sysom:GetAgentTask
Get
全部资源
*

请求语法

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

请求参数

字段名称字段详情
task_idstring

任务 ID。

示例值:42172120177e4b3abd6fabb3a6b5e2dd

返回参数

字段名称字段详情
codestring

状态码展开详情

示例值:Success
messagestring

错误信息展开详情

示例值:SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict
dataobject

返回数据。

RequestIdstring

请求 ID,可用于全链路诊断

示例值:2E75336A-0DB2-5263-B201-A6488EC97B50

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
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.诊断
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.诊断
400
SysomOpenAPI.ServerError
Server error, please correct the code according to the error message.诊断

变更历史

变更时间变更内容概要操作
2024-12-26
新增OpenAPI,获取组件任务的执行状态

相关示例

2024年08月20日