DescribeUuidsByVulNames API Reference - Security Center - Alibaba Cloud - Security Center

Retrieves the list of servers that support vulnerability fixing based on vulnerability names.

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

yundun-sas:DescribeUuidsByVulNames

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language type for the request and response messages. Default value: zh. Valid values: zh: Chinese en: English	zh
Type	string	Yes	The type of vulnerability to query. Valid values: cve: Linux software vulnerability sys: Windows system vulnerability	cve
StatusList	string	No	The fix status of the vulnerability. Separate multiple statuses with commas (,). Valid values: 1: Unfixed. 2: Fix failed.	1,2
Tag	string	No	The vulnerability tag.	oval
Level	string	No	The vulnerability severity level. Separate multiple levels with commas (,). Valid values: high: High. medium: Medium. low: Low.	high,low
Dealed	string	No	Specifies whether the vulnerability has been handled. Valid values: y: Handled. n: Not handled.	n
GroupId	integer	No	The ID of the asset group.	11286014
VpcInstanceIds	string	No	The instance IDs of VPC-connected instances to query for vulnerabilities. Separate multiple instance IDs with commas (,).	vpc-uf6ssrvbrwe37ekw**,vpc-bp1aevy8sofi8mh1q**
Remark	string	No	The asset information for the vulnerability query. You can set this parameter to the asset name, public IP address, or private IP address. Fuzzy match is supported.	10.7.
SearchTags	string	No	The tag for querying vulnerabilities.	oval
FieldName	string	No	The name of the container search field.	namespace
FieldValue	string	No	The value of the container search field.	cas-adad-qeqwe
TargetType	string	No	The query type. Valid values: containerId: container ID uuid: asset ID	uuid
Necessity	string	No	The priority level of vulnerability fixing to query. Separate multiple levels with commas (,). Valid values: asap: High. later: Medium. nntf: Low.	asap,later,nntf
VulNames	array	Yes	The collection of vulnerability names. Note You can call the DescribeGroupedVul operation to obtain this parameter.
	string	No	The vulnerability name.	centos:8:rhsa-2020:1665
ResourceDirectoryAccountId	integer	No	The Alibaba Cloud account ID of the member accounts in the resource directory. Note You can call the DescribeMonitorAccounts operation to obtain this parameter.	127608589417****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use it to troubleshoot issues.	97286A-4A6B-4A4-95FA-EC7E3E2451
MachineInfoStatistics	array<object>	The list of asset statistics information.
	object	The asset statistics information.
Uuid	string	The UUID of the server.	18375c64-eaa2-4702-92b0-4ee7******
MachineIp	string	The IP address of the server.	192.168.XX.XX
Os	string	The operating system name of the server.	windows
MachineName	string	The name of the server.	TestMachine
MachineInstanceId	string	The instance ID of the server.	i-wz9gd1os5talju****
RegionId	string	The region ID of the instance.	cn-hangzhou
InternetIp	string	The public IP address of the associated instance.	47.98.XX.XX
IntranetIp	string	The private IP address of the associated instance.	172.18.XX.XX
VulCount	integer	The total number of vulnerabilities on the server.	2

Examples

Success response

JSON format

{
  "RequestId": "97286A-4A6B-4A4-95FA-EC7E3E2451",
  "MachineInfoStatistics": [
    {
      "Uuid": "18375c64-eaa2-4702-92b0-4ee7******",
      "MachineIp": "192.168.XX.XX",
      "Os": "windows",
      "MachineName": "TestMachine",
      "MachineInstanceId": "i-wz9gd1os5talju****",
      "RegionId": "cn-hangzhou",
      "InternetIp": "47.98.XX.XX",
      "IntranetIp": "172.18.XX.XX"
    }
  ],
  "VulCount": 2
}

Error codes

HTTP status code	Error code	Error message	Description
400	RdCheckNoPermission	Resource directory account verification has no permission.
500	ServerError	ServerError
500	RdCheckInnerError	Resource directory account service internal error.
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.