All Products
Search
Document Center

Security Center:DescribeUuidsByVulNames

Last Updated:Nov 13, 2024

Queries a list of assets that support fixing based on vulnerability names.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeUuidsByVulNamesget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh
TypestringYes

The type of the vulnerability. Valid values:

  • cve: Linux software vulnerability
  • sys: Windows system vulnerability
cve
StatusListstringNo

The status of the vulnerability. Separate multiple states with commas (,). Valid values:

  • 1: unfixed
  • 2: fix failed
1,4
TagstringNo

The tag of the vulnerability.

oval
LevelstringNo

The severity of the vulnerability. Separate multiple severities with commas (,). Valid values:

  • high
  • medium
  • low
high,low
DealedstringNo

Specifies whether the vulnerability is fixed. Valid values:

  • y: the vulnerability is fixed.
  • n: the vulnerability is not fixed.
n
GroupIdlongNo

The ID of the asset group.

11286014
VpcInstanceIdsstringNo

The ID of the virtual private cloud (VPC) in which the vulnerability is detected. Separate multiple IDs with commas (,).

vpc-uf6ssrvbrwe37ekw****,vpc-bp1aevy8sofi8mh1q****
RemarkstringNo

The remarks for the asset affected by the vulnerability. The value can be the private IP address, public IP address, or name of the asset. Fuzzy match is supported.

10.7.
SearchTagsstringNo

The tags that are used to search for the vulnerability.

oval
FieldNamestringNo

The name of the search field that is used to query containers.

namespace
FieldValuestringNo

The value of the search field that is used to query containers.

cas-adad-qeqwe
TargetTypestringNo

The type of the query condition. Valid values:

  • containerId: the ID of the container
  • uuid: the ID of the asset
uuid
NecessitystringNo

The priority based on which the vulnerability is fixed. Separate multiple priorities with commas (,). Valid values:

  • asap: high
  • later: medium
  • nntf: low
asap,later,nntf
VulNamesarrayYes

An array that consists of the names of vulnerabilities.

Note You can call the DescribeGroupedVul operation to obtain the names of vulnerabilities.
stringYes

The name of the vulnerability.

centos:8:rhsa-2020:1665

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

97286A-4A6B-4A4-95FA-EC7E3E2451
MachineInfoStatisticsarray<object>

The statistics about the servers.

MachineInfoStatisticobject

The statistical information about the assets.

Uuidstring

The UUID of the server.

18375c64-eaa2-4702-92b0-4ee7******
MachineIpstring

The IP address of the server.

192.168.XX.XX
Osstring

The operating system that the server runs.

windows
MachineNamestring

The name of the server.

TestMachine
MachineInstanceIdstring

The instance ID of the server.

i-wz9gd1os5talju****
RegionIdstring

The region ID of the server.

cn-hangzhou
InternetIpstring

The public IP address of the server on which the exception was detected.

47.98.XX.XX
IntranetIpstring

The private IP address of the server on which the exception was detected.

172.18.XX.XX
VulCountinteger

The total number of vulnerabilities on the server.

2

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-06-11The response structure of the API has changedView Change Details
2023-07-06The response structure of the API has changedView Change Details