QueryHotfixStatus

Updated at:

Asynchronously queries the CVE hotfix status on the specified instances.

Operation description

Calling this API operation to install the agent is asynchronous. After the call, a task_id is returned. You can use this ID to call the GetHotfixTask operation to query 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:QueryHotfixStatus

get

*All Resource

*

None None

Request syntax

POST /api/v1/hotfix_manager/hotfix/query_status HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

body

object

No

The request body.

cveId

string

Yes

CVE ID

CVE-2026-12345

instances

array<object>

Yes

The target instances.

object

No

The instance information.

instanceId

string

Yes

The instance ID.

i-bp1example

regionId

string

Yes

The region ID.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

Schema of Response

code

string

The status code.

  • If code == Success, the authorization is successful.

  • Other status codes indicate that the authorization failed. If the authorization failed, check the message field for the detailed fault message.

Success

data

object

The returned data.

taskId

string

The asynchronous task ID.

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.

""

requestId

string

The request ID.

2D693121-C925-5154-8DF6-C09A8B369822

Examples

Success response

JSON format

{
  "code": "Success",
  "data": {
    "taskId": "hotfix-da3dcc0b-5019-4b59-b12f-2e500da9083c"
  },
  "message": "\"\"",
  "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.HotfixTooManyInstances The number of instances exceeds the limit of 500.
400 SysomOpenAPI.HotfixCveNotFound The specified CVE hotfix was not found.
400 SysomOpenAPI.NotAuthorizedInstance The instance was not found or is not authorized.
500 SysomOpenAPI.ServerError An internal server error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.