GetHotfixTask - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Queries the status of an asynchronous CVE hotfix task.

Operation description

The hotfix task process is asynchronous. When you call this operation, the task may still be running. You can check the data.status field in the response to determine the task status. If data.status is Success, the task succeeded, and you can obtain the task result from the data.result field.

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:GetHotfixTask

get

*All Resource

*

None

Request syntax

GET /api/v1/hotfix_manager/task/get HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
taskId	string	Yes	The ID of the asynchronous task.	hotfix-da3dcc0b-5019-4b59-b12f-2e500da9083c

Response elements

Element	Type	Description	Example
	object	Schema of Response
code	string	The status code. If `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 information.	Success
data	object	The returned data.
createdAt	string	The time when the task was created.	2026-10-13T08:14:40
cveId	string	CVE ID	CVE-2026-31431
finishedAt	string	The time when the task was completed.	2026-10-13T08:14:40
jobs	array<object>	The list of instance tasks.
	object	The details of the subtask.
errorCode	string	The unified error code.	INSTANCE_NOT_EXISTS
errorMessage	string	The error message.	The specified instance does not exist
hotfixStatus	string	The hotfix status.	CONFLICT
instance	string	The ID of the instance.	i-2zehme0rs1tc090fdl3n
region	string	The region ID.	cn-hangzhou
status	string	The status of the instance task.	Running
operation	string	The operation type of the task.	Install
status	string	The status of the task.	Running
taskId	string	The ID of the asynchronous task.	hotfix-da3dcc0b-5019-4b59-b12f-2e500da9083c
message	string	The error message. If `code` is `Success`, this field is empty. Otherwise, this field contains the request error message.	success
requestId	string	The request ID.	2D693121-C925-5154-8DF6-C09A8B369822

Examples

Success response

JSON format

{
  "code": "Success",
  "data": {
    "createdAt": "2026-10-13T08:14:40",
    "cveId": "CVE-2026-31431",
    "finishedAt": "2026-10-13T08:14:40",
    "jobs": [
      {
        "errorCode": "INSTANCE_NOT_EXISTS",
        "errorMessage": "The specified instance does not exist",
        "hotfixStatus": "CONFLICT",
        "instance": "i-2zehme0rs1tc090fdl3n",
        "region": "cn-hangzhou",
        "status": "Running"
      }
    ],
    "operation": "Install",
    "status": "Running",
    "taskId": "hotfix-da3dcc0b-5019-4b59-b12f-2e500da9083c"
  },
  "message": "success",
  "requestId": "2D693121-C925-5154-8DF6-C09A8B369822\n"
}

Error codes

HTTP status code	Error code	Error message	Description
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.HotfixTaskNotFound	The specified hotfix task was not found.
400	SysomOpenAPI.NotOwnHotfixTask	The hotfix task does not belong to the current account.
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.