UpgradeAgent - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Operation description

Calling this operation to update an Agent is asynchronous. After the call, a task_id is returned. Use this ID to call the GetAgentTask operation to retrieve the execution status of the task.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sysom:UpgradeAgent

update

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
agent_id	string	Yes	The ID of the component to update.	74a86327-3170-412c-8e67-da3389ec56a9
agent_version	string	Yes	The version to which the component is updated.	3.4.0-1
instances	array<object>	Yes	The list of instances on which to update the component.
	object	Yes	The instance information.
instance	string	Yes	The instance ID.	i-wz9b9vucz1iubsz8sjqo
region	string	Yes	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID, which can be used for end-to-end diagnostics.	B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7
code	string	The status code. Valid values: Success: The authorization is successful. Other values indicate that the authorization failed. Check the `message` field for the detailed fault information.	Success
data	object	The returned data.
task_id	string	The task ID.	391f5aeba2054f66b3aaef0136142fe2
message	string	The error message. If code is Success, this field is empty. Otherwise, this field contains the error information of the request.	SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict

Examples

Success response

JSON format

{
  "RequestId": "B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7",
  "code": "Success",
  "data": {
    "task_id": "391f5aeba2054f66b3aaef0136142fe2"
  },
  "message": "SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict"
}

Error codes

HTTP status code	Error code	Error message	Description
400	SysomOpenAPI.RegionNotSupport	Region not supported.	Region is not supported.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.