全部产品
Search

搜索本产品

    Alibaba Cloud Linux：InstallAgentWithType - 安装组件

    文档中心

    Alibaba Cloud Linux：InstallAgentWithType - 安装组件

    更新时间：Sep 11, 2026

    在指定的实例上安装 Agent

    接口说明

    调用本接口安装 Agent 是异步的，调用接口后会返回一个 task_id，可以凭借该 ID 调用 GetAgentTask 接口获取任务的执行情况。

    调试

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

    调试

    授权信息

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

    • 操作：是指具体的权限点。

    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

      • 对于必选的资源类型，用前面加 * 表示。

      • 对于不支持资源级授权的操作，用全部资源表示。

    • 条件关键字：是指云产品自身定义的条件关键字。

    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

    操作

    访问级别

    资源类型

    条件关键字

    关联操作

    sysom:InstallAgentWithType

    create

    *全部资源

    *

    		 无 无

    请求语法

    POST /api/v1/am/agent/installAgent HTTP/1.1

    请求参数

    名称

    类型

    必填

    描述

    示例值
    body

    object

    否

    请求 Body

    Tag

    array<object>

    否

    object

    否

    Key

    string

    否

    Value

    string

    否

    agentId

    string

    是

    要安装的组件 ID

    74a86327-3170-412c-8e67-da3389ec56a9
    agentVersion

    string

    是

    要安装的组件版本

    3.4.0-1
    configId

    string

    否

    要安装的组件配置 ID

    f0078fbb-4213-11f0-a19b-00163e4ae208
    instanceType

    string

    是

    实例类型

    ecs
    instances

    array<object>

    是

    需要安装组件的实例列表

    object

    是

    实例信息

    instance

    string

    是

    实例 ID

    i-wz9b9vucz1iubsz8sjqo
    region

    string

    是

    地域 ID

    cn-hangzhou

    返回参数

    名称

    类型

    描述

    示例值

    object

    Schema of Response

    code

    string

    状态码

    • code == Success 则代表授权成功；

    • 其它状态码代表授权失败，授权失败时查看 message 字段获取详细的错误信息；

    Success
    data

    object

    返回数据

    taskId

    string

    任务 ID。

    可以凭借本任务 ID 调用 GetAgentTask 接口查看任务的执行情况

    26b3cd97389c43dcad6bc4901c36fcec
    message

    string

    Id of the request

    ""
    requestId

    string

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

    1D8887FC-4BDB-5A1C-AB19-135C29A9E481

    示例

    正常返回示例

    JSON格式

    {
  "code": "Success",
  "data": {
    "taskId": "26b3cd97389c43dcad6bc4901c36fcec"
  },
  "message": "\"\"",
  "requestId": "1D8887FC-4BDB-5A1C-AB19-135C29A9E481\n"
}

    错误码

    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. 服务端错误，请根据错误提示信息修正代码

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

    变更历史

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