Queries vulnerabilities by type.
Debugging
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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
yundun-sas:DescribeVulList | get |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
Lang | string | No | The language of the content within the request and response. Default value: zh. Valid values:
| zh |
Ids | string | No | The IDs of vulnerabilities. You can specify up to 50 IDs. Separate multiple IDs with commas (,). | 282,281,283 |
Remark | string | No | 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. | 1.2.XX.XX |
GroupId | string | No | The ID of the asset group. Note
You can call the DescribeAllGroups operation to query the IDs of asset groups.
| 9207613 |
Type | string | Yes | The type of the vulnerability. Valid values:
| cve |
Uuids | string | No | The UUIDs of the servers on which you want to query the vulnerabilities. Separate multiple UUIDs with commas (,). Note
You can call the DescribeCloudCenterInstances operation to obtain the UUIDs.
| 1587bedb-fdb4-48c4-9330-**** |
Name | string | No | The alias of the vulnerability. | oval:com.redhat.rhsa:def:20172836 |
AliasName | string | No | The name of the vulnerability. | RHSA-2019:0230-Important: polkit security update |
StatusList | string | No | The status of the vulnerability. Separate multiple statuses with commas (,). Valid values:
| 1,2,3 |
Necessity | string | No | The priority to fix the vulnerability. Separate multiple priorities with commas (,). Valid values:
| asap,later,nntf |
Dealed | string | No | Specifies whether the vulnerabilities are fixed. Valid values:
| n |
CurrentPage | integer | No | The number of the page to return. Default value: 1. | 1 |
PageSize | integer | No | The number of entries per page. Default value: 10. | 20 |
AttachTypes | string | No | The additional type of the vulnerabilities. You need to specify this parameter when you query application vulnerabilities. Set the value to sca. If you set Type to app, you must specify this parameter. Note
If you set this parameter to sca, application vulnerabilities and the vulnerabilities that are detected based on software component analysis are queried. If you do not specify this parameter, only application vulnerabilities are queried.
| sca |
VpcInstanceIds | string | No | The ID of the virtual private cloud (VPC) in which the vulnerabilities are detected. Separate multiple IDs with commas (,). | ins-133****,ins-5414**** |
ResourceDirectoryAccountId | long | No | The Alibaba Cloud account ID of the member in the resource directory. Note
You can call the DescribeMonitorAccounts operation to obtain the IDs.
| 1232428423234**** |
UseNextToken | boolean | No | Specifies whether to use NextToken to query the data of vulnerabilities. If you set UseNextToken to true, the value of TotalCount is not returned. Valid values:
| false |
NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. You must specify the token that is obtained from the previous query as the value of NextToken. You do not need to specify this parameter for the first request. | E17B501887A2D3AA5E8360A6EFA3B*** |
Response parameters
Examples
Sample success responses
JSON
format
{
"CurrentPage": 1,
"RequestId": "2F26AB2A-1075-488F-8472-40E5DB486ACC",
"PageSize": 20,
"TotalCount": 2,
"VulRecords": [
{
"Status": 1,
"RaspDefend": 1,
"RaspStatus": 1,
"Type": "cve",
"ModifyTs": 1620404763000,
"InternetIp": "1.2.XX.XX",
"PrimaryId": 101162078,
"Tag": "oval",
"K8sClusterId": "c863dc93bed3843de9934d4346dc4****",
"K8sNodeId": "i-bp1ifm6suw9mnbsr****",
"InstanceName": "testInstance",
"Online": true,
"OsVersion": "linux",
"Name": "oval:com.redhat.rhsa:def:20170574",
"ResultCode": "0",
"InstanceId": "i-bp18t***",
"Related": "CVE-2017-7518,CVE-2017-12188",
"IntranetIp": "1.2.XX.XX",
"LastTs": 1620404763000,
"FirstTs": 1554189334000,
"RegionId": "cn-hangzhou",
"Necessity": "asap",
"RepairTs": 1541207563000,
"Uuid": "04c56617-23fc-43a5-ab9b-****",
"K8sPodName": "deployment-riskai-7b67d68975-m****",
"GroupId": 281801,
"ResultMessage": "timeout",
"K8sNamespace": "default",
"AliasName": "RHSA-2019:0230-Important: polkit security update",
"K8sNodeName": "deployment-riskai-7b67d68975-m****",
"ExtendContentJson": {
"Status": "1",
"EmgProof": "com.xxl.rpc.util.XxlRpcException: xxl-rpc request data is empty.\\n\\tat com.xxl.rpc.remoting.net.impl.servlet.serve\"",
"Ip": "1.2.XX.XX",
"PrimaryId": 111,
"Os": "centos",
"Tag": "oval",
"LastTs": 1620404763000,
"Description": "kernel version:5.10.84-10.2.al8.x86_64",
"OsRelease": "7",
"AliasName": "RHSA-2019:0230-Important: polkit security update",
"Target": "http://39.99.XX.XX:30005/toLogin",
"AbsolutePath": "/roo/www/web",
"RpmEntityList": [
{
"FullVersion": "3.10.0-693.2.2.el7",
"Version": "3.10.0",
"MatchDetail": "python-perf version less than 0:3.10.0-693.21.1.el7",
"ImageName": "registry_387ytb_xxx",
"Path": "/usr/lib64/python2.7/site-packages",
"ContainerName": "k8s_67895c4_xxx",
"Name": "python-perf",
"UpdateCmd": "*** update python-perf",
"MatchList": [
"fastjson(jar) extendField.safemode equals false"
],
"Pid": "8664",
"ExtendField": "{\"msg_no_lookups_configured_CVE_2021_44228\": \"false\", \"jndi_class_not_exist\": \"false\"}"
}
],
"cveList": [
"CVE-2016-8610"
],
"Necessity": {
"Status": "normal",
"Time_factor": "1.0",
"Enviroment_factor": "1.0",
"Is_calc": "1",
"Total_score": "7.8",
"Cvss_factor": "7.8",
"Assets_factor": "1"
}
},
"Bind": true,
"OsName": "CentOS 7.2 64-bit\n",
"AuthVersion": "3",
"RealRisk": true
}
],
"NextToken": "E17B501887A2D3AA5E8360A6EFA3B***"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | NoPermission | no permission | - |
400 | InnerError | InnerError | - |
400 | IllegalParam | Illegal param | - |
400 | DataNotExists | %s data not exist | - |
400 | RdCheckNoPermission | Resource directory account verification has no permission. | - |
403 | NoPermission | caller has no permission | You are not authorized to do this operation. |
500 | RdCheckInnerError | Resource directory account service internal error. | - |
500 | ServerError | ServerError | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-09-25 | The Error code has changed | View Change Details |
2024-08-05 | The Error code has changed. The response structure of the API has changed | View Change Details |
2024-04-12 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2024-03-27 | The Error code has changed. The response structure of the API has changed | View Change Details |
2023-11-22 | The Error code has changed. The response structure of the API has changed | View Change Details |
2023-09-26 | The Error code has changed. The response structure of the API has changed | View Change Details |
2023-09-08 | The Error code has changed. The response structure of the API has changed | View Change Details |
2023-09-07 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2023-08-23 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2023-07-20 | The Error code has changed. The request parameters of the API has changed | View Change Details |
2023-03-21 | The Error code has changed. The response structure of the API has changed | View Change Details |
2022-06-20 | The Error code has changed. The request parameters of the API has changed | View Change Details |