Extracting Vulnerability Fix Commands

Function

This API is used to query the vulnerability fixing command list.

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}/vulnerability/repair-cmds

**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.
limit	No	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10-200 Default Value 10
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
host_name	No	String	Definition Server name. Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
vul_name	No	String	Definition Vulnerability name. Constraints N/A Range The value can contain 0 to 256 characters. Default Value N/A
category	No	String	Definition Type Constraints N/A Range host container serverless Default Value host

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
select_type	No	String	Definition All vulnerabilities are selected. The priority of this parameter is higher than that of data_list and host_data_list. Constraints N/A Range all_vul: Select all vulnerabilities. all_host: Select all server vulnerabilities. all_vul_container_host: Select all container nodes. all_vul_container: Select all containers. Default Value N/A
data_list	No	Array of VulOperateInfo objects	Definition Vulnerability list. Constraints N/A Range 1 to 500 items Default Value N/A
host_data_list	No	Array of HostVulOperateInfo objects	Definition Vulnerability list in the server dimension. Constraints N/A Range 1 to 500 items Default Value N/A
is_container	No	Boolean	Definition Whether it is the container scenario. Constraints N/A Range true: container scenario false: non-container scenario Default Value false
cluster_id	No	String	Definition Cluster ID. Constraints N/A Range The value contains 0 to 256 characters. Default Value N/A

**Table 5** VulOperateInfo
Parameter	Mandatory	Type	Description
vul_id	Yes	String	Definition Vulnerability ID. Constraints N/A Range Length: 1 to 64 characters Default Value N/A
host_id_list	Yes	Array of strings	Definition Hosts Constraints N/A Range The value ranges from 1 to 500. Default Value N/A

**Table 6** HostVulOperateInfo
Parameter	Mandatory	Type	Description
host_id	Yes	String	Definition Server ID. Constraints N/A Range Length: 1 to 64 characters Default Value N/A
vul_id_list	Yes	Array of strings	Definition Vulnerability list Constraints N/A Range The value ranges from 1 to 500. Default Value N/A

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number. Range Minimum value: 0; maximum value: 10000
data_list	Array of VulRepairCmdInfo objects	Definition Vulnerability fixing command list Range 0 to 2,147,483,647 items

**Table 8** VulRepairCmdInfo
Parameter	Type	Description
host_id	String	Definition Server ID. Range The value can contain 1 to 128 characters.
host_name	String	Definition Server name Range Length: 1 to 256 characters
public_ip	String	Definition Server EIP. Range Length: 0 to 128 characters
private_ip	String	Definition Server private IP address. Range Length: 0 to 128 characters
asset_value	String	Definition Server asset importance. Range important: important asset common: common asset test: test asset
vul_name	String	Definition Vulnerability name. Range Length: 0 to 256 characters
vul_id	String	Definition Vulnerability ID. Range The value can contain 0 to 64 characters.
repair_cmd	String	Definition Fix command. Range The value can contain 1 to 256 characters.
image_name	String	Definition Associated image name. Range The value can contain 1 to 256 characters.
image_id	String	Definition Associated image ID. Range The value can contain 1 to 256 characters.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 1,
  "data_list" : [ {
    "host_id" : "bcxxxxad-6xxb-4xx4-8xxc-9127xxxxxxd7",
    "host_name" : "ecs-test-01",
    "private_ip" : "192.168.0.1",
    "asset_value" : "common",
    "vul_id" : "UTSA-2023-001306",
    "vul_name" : "[Security notice: UTSA-2023-001306] - [CVE-2023-2004]",
    "repair_cmd" : "yum update freetype"
  } ]
}