GetAgentTask - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Retrieves the execution status of an agent installation 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:GetAgentTask

get

*All Resource

*

None

Request syntax

GET /api/v1/am/agent/get_agent_task HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
task_id	string	No	The task ID.	42172120177e4b3abd6fabb3a6b5e2dd

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID, which can be used for end-to-end diagnostics.	2E75336A-0DB2-5263-B201-A6488EC97B50
code	string	The status code. If the value of code is Success, the authorization is successful. Other status codes indicate that the authorization failed. If the authorization fails, check the message field for the detailed fault message.	Success
data	object	The returned data.
jobs	array<object>	The list of subtasks.
	object	The subtask details.
error	string	The cause of the task failure. This field returns an error when the task execution fails.	Deprecated (misused)
errorCode	string	The error code for the subtask execution failure. Valid values: Empty: The task is executed normally. INSTANCE_NOT_SUPPORTED: The instance type is not supported. INSTANCE_NOT_EXISTS: The instance does not exist. INSTANCE_RELEASED: The instance is released. INSTANCE_NOT_RUNNING: The instance is not running. INSTANCE_NOT_OWNED: The instance does not belong to the current account. AGENT_ALREADY_INSTALLED: The agent is already installed. AGENT_NOT_INSTALLED: The agent is not installed. AGENT_SAME_VERSION: The version is the same. HAS_RUNNING_JOB: A task is running. RPM_LOCK_HELD: The RPM lock is occupied. DISK_SPACE_INSUFFICIENT: Insufficient disk space. NODE_LOAD_HIGH: The node load is high. COMMAND_FAILED: The command execution failed. CLIENT_NOT_RUNNING: The Cloud Assistant agent is not running. CLIENT_NOT_RESPONSE: The Cloud Assistant agent is not responding. DELIVERY_TIMEOUT: The command delivery timed out. EXECUTION_TIMEOUT: The command execution timed out. TASK_CONCURRENCY_LIMIT: The task concurrency limit is reached.	DISK_SPACE_INSUFFICIENT
errorMessage	string	The detailed error message for the subtask execution failure. Valid values: The instance type is not supported. The instance does not exist. The instance is released. The instance is not running. The instance does not belong to the current account. The agent is already installed. The agent is not installed. The agent version is the same. No upgrade is required. A task is running. Please try again later. The RPM lock is occupied. Please try again later. Insufficient disk space. The node load is too high. Please try again later. The command execution failed. Please try again later. The Cloud Assistant agent is not running. The Cloud Assistant agent is not responding. The command delivery timed out. The command execution timed out. The task concurrency limit is reached.	Insufficient disk space
instance	string	The instance ID.	i-2zehme0rs1tc090fdl3n
params	any	The subtask parameters.	{ "agent_version": "3.5.0-beta", "opt": "install", "agent_id": "74a86327-3170-412c-8fd67-da3389ec56a9", "install_type": "InstallAndUpgrade" }
region	string	The region ID.	cn-hangzhou
result	string	The subtask execution result.	Deprecated (misused)
status	string	The subtask status. Valid values: Created: The task is created. Running: The task is running. Success: The task is successful. Fail: The task failed.	Running
status	string	The running status of the agent task.	Running
task_id	string	The task ID.	c41d8e3506224184a714682fea86d22d
message	string	The error message. If the value of code is Success, this field is empty. Otherwise, this field contains the request error message.	SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict

Examples

Success response

JSON format

{
  "RequestId": "2E75336A-0DB2-5263-B201-A6488EC97B50",
  "code": "Success",
  "data": {
    "jobs": [
      {
        "error": "Deprecated (misused)",
        "errorCode": "DISK_SPACE_INSUFFICIENT",
        "errorMessage": "Insufficient disk space",
        "instance": "i-2zehme0rs1tc090fdl3n",
        "params": "{\n    \"agent_version\": \"3.5.0-beta\",\n    \"opt\": \"install\",\n    \"agent_id\": \"74a86327-3170-412c-8fd67-da3389ec56a9\",\n    \"install_type\": \"InstallAndUpgrade\"\n}",
        "region": "cn-hangzhou",
        "result": "Deprecated (misused)",
        "status": "Running"
      }
    ],
    "status": "Running",
    "task_id": "c41d8e3506224184a714682fea86d22d"
  },
  "message": "SysomOpenAPIException: SysomOpenAPI.InvalidParameter Invalid params, should be json string or dict"
}

Error codes

HTTP status code	Error code	Error message	Description
400	SysomOpenAPI.AgentNotExists	Agent not exists.	Agent does not exist.
400	SysomOpenAPI.AgentTaskNotFound	Agent task not found.	Component task does not exist.
400	SysomOpenAPI.AgentVersionNotExists	Agent version not exists.	Agent version does not exist.
400	SysomOpenAPI.InstanceNotExists	Instance not exists.	Instance does not exist
400	SysomOpenAPI.InvalidParameter	Invalid parameters passed when calling the interface.	Invalid parameter passed when calling interface
400	SysomOpenAPI.MissingParameter	Missing parameters.	Missing parameter
400	SysomOpenAPI.NoAgentInstalled	No SysOM Agent version available.	No SysOM Agent is available.
400	SysomOpenAPI.NotAuthorizedInstance	Instance not authorized.	The instance is not authorized.
400	SysomOpenAPI.NotOwnInstance	Not own current instance.	The specified instance does not belong to the current user.
400	SysomOpenAPI.NotOwnTask	Diagnosis result does not belong to the current account.	Diagnosis result does not belong to the current account
400	SysomOpenAPI.NotSupportedAgentVersion	Unsupported sysom agent version.	Unsupported SysOM client version.
400	SysomOpenAPI.ServerError	Server error, please correct the code according to the error message.	Server error, please correct the code according to the error message

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.