文档

OperateAgentClientInstall - 安装Agent

更新时间:
一键部署

为服务器安装云安全中心Agent插件。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sas:OperateAgentClientInstallWrite
  • 全部资源
    acs:yundun-sas:*:{#accountId}:*

请求参数

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

要安装云安全中心 Agent 的服务器实例的 ID 列表,多个实例 ID 之间使用半角逗号(,)分隔。

说明 InstanceIdsUuids 这两个参数二选一,必须设置一个,才可以成功调用本接口,如果选择 InstanceIds,则 RegionOs 必填。
i-uf6j8vq9l4r5ntht****
Uuidsstring

要安装的服务器的 UUID 列表,多个 UUID 之间使用半角逗号(,)分隔。

说明 InstanceIdsUuids 这两个参数二选一,必须设置一个,才可以成功调用本接口。
1587bedb-fdb4-48c4-9330-************
Langstring

设置请求和接收消息的语言类型,默认为 zh。取值:

  • zh:中文
  • en:英文
en
Regionstring

机器所在地域,包括但不限于如下地域:

  • cn-hangzhou:杭州

  • cn-beijing:北京

  • cn-shanghai:上海

  • cn-zhangjiakou:张家口

  • cn-shenzhen:深圳

cn-hangzhou
Osstring

实例的操作系统。取值:

  • linux:linux

  • windows:windows

linux

返回参数

名称类型描述示例值
object
RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

AE79B457-877C-51C6-AD72-0D34A025D***
AegisCelintInstallResposeListobject []

安装 Agent 客户端调用请求的返回结果。

Uuidstring

服务器 UUID。

1587bedb-fdb4-48c4-9330-****
InstanceIdstring

服务器的实例 ID。

i-uf6j8vq9l4r5ntht****
RecordIdlong

客户端安装任务 ID。

2856

示例

正常返回示例

JSON格式

{
  "RequestId": "AE79B457-877C-51C6-AD72-0D34A025D***",
  "AegisCelintInstallResposeList": [
    {
      "Uuid": "1587bedb-fdb4-48c4-9330-****",
      "InstanceId": "i-uf6j8vq9l4r5ntht****",
      "RecordId": 2856
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InstallNotGrantedThe installation permission is not granted.权限不足,请先登录RAM控制台授予AliyunServiceRoleForSas权限
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500InternalErrorThe request processing has failed due to some unknown error.服务发生某些未知错误,请稍后再试。
500ServerErrorServerError服务故障,请稍后重试!

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

变更历史

变更时间变更内容概要操作
2023-08-29OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
    新增错误码:400
2023-06-05OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:500
入参OpenAPI 入参发生变更
    新增入参:Region
    新增入参:Os
2022-12-19OpenAPI 描述信息更新、OpenAPI 错误码发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:500
2022-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2022-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)
文档反馈