更新时间:2025-10-31 GMT+08:00
分享

升级Agent - UpgradeAgents

功能介绍

升级Agent

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v5/{project_id}/host-management/upgrade

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

operate_all

Boolean

参数解释:

是否全量升级

约束限制:

不涉及

取值范围:

  • true: 全量升级,不需要填写host_id_list,按照其余筛选条件筛选符合升级的服务器。

  • false: 非全量升级,需要填写host_id_list,只升级host_id_list中包含的服务器。

默认取值:

false

host_name

String

参数解释:

服务器名称

取值范围:

字符长度1-256位

host_id

String

参数解释

主机ID

取值范围

字符长度1-64位

private_ip

String

参数解释

服务器私有IP

取值范围

字符长度1-128位

public_ip

String

参数解释

弹性公网IP地址

取值范围

字符长度1-256位

version

String

参数解释

防护版本

约束限制:

不涉及

取值范围

  • hss.version.basic :基础版。

  • hss.version.advanced :专业版。

  • hss.version.enterprise :企业版。

  • hss.version.premium :旗舰版。

  • hss.version.wtp :网页防篡改版。

  • hss.version.container.enterprise:容器版。

默认取值:

不涉及

protect_status

String

参数解释

防护状态

约束限制:

不涉及

取值范围

  • closed :未防护。

  • opened :防护中。

默认取值:

不涉及

os_type

String

参数解释

操作系统类型

取值范围

  • Linux:Linux。

  • Windows:Windows。

policy_group_id

String

参数解释

策略组ID

取值范围

字符长度36-64位

group_id

String

参数解释:

服务器组ID

取值范围:

字符长度0-64位

asset_value

String

资产重要性,包含如下3种

  • important :重要资产

  • common :一般资产

  • test :测试资产

host_id_list

Array of strings

参数解释:

服务器ID列表

取值范围:

不涉及

响应参数

状态码:200

请求已成功

请求示例

升级Agent,目标服务器ID为15462c0e-32c6-4217-a869-bbd131a00ecf。

POST https://{endpoint}/v5/{project_id}/host-management/upgrade

{
  "host_id_list" : [ "15462c0e-32c6-4217-a869-bbd131a00ecf" ],
  "operate_all" : false
}

响应示例

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档