Upgrading the Agent

Function

This API is used to upgrade the agent.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
operate_all	Yes	Boolean	Definition Whether to perform a full upgrade. Constraints N/A Range true: Perform a full upgrade. You do not need to specify host_id_list. The servers that meet the upgrade requirements will be filtered based on other filter criteria. false: Upgrade specified servers. You need to specify host_id_list. Only the specified servers will be upgraded. Default Value false
host_name	No	String	Definition Server name. Range The value can contain 1 to 256 characters.
host_id	No	String	Definition Unique ID of a server (host). Range The value can contain 1 to 64 characters.
private_ip	No	String	Definition Server private IP address. Range The value can contain 1 to 128 characters.
public_ip	No	String	Definition Elastic IP Address (EIP) Range The value is a string of 1 to 256 characters and can be an IPv4 or IPv6 address. (An IPv4 address can contain 7 to 15 characters. An IPv6 address can contain 15 to 39 characters.)
version	No	String	Definition Edition Constraints N/A Range hss.version.basic: basic edition hss.version.advanced: professional edition hss.version.enterprise: enterprise edition hss.version.premium: premium edition hss.version.wtp: WTP edition hss.version.container.enterprise: container edition Default Value N/A
protect_status	No	String	Definition Protection status. Constraints N/A Range closed: not protected opened: protected Default Value N/A
os_type	No	String	Definition OS type. Constraints N/A Range Linux Windows Default Value N/A
policy_group_id	No	String	Definition Policy group ID. Range Length: 36 to 64 characters
group_id	No	String	Definition Unique ID of the server group that the server belongs to. Range The value can contain 0 to 64 characters.
asset_value	No	String	Asset importance. Definition Asset importance. Constraints N/A Range important common test Default Value N/A
host_id_list	No	Array of strings	Definition Server ID list. Range N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Upgrade the agent. The target server ID is 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
}