升级Agent - UpgradeAgents
功能介绍
升级Agent
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/host-management/upgrade
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
operate_all |
是 |
Boolean |
参数解释: 是否全量升级 约束限制: 不涉及 取值范围:
默认取值: 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 |
参数解释: 防护版本 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
protect_status |
否 |
String |
参数解释: 防护状态 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
os_type |
否 |
String |
参数解释: 操作系统类型 取值范围:
|
|
policy_group_id |
否 |
String |
参数解释: 策略组ID 取值范围: 字符长度36-64位 |
|
group_id |
否 |
String |
参数解释: 服务器组ID 取值范围: 字符长度0-64位 |
|
asset_value |
否 |
String |
资产重要性,包含如下3种
|
|
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 |
请求已成功 |
错误码
请参见错误码。