Exports vulnerabilities.
Operation description
You can call the ExportVul operation to export the following types of vulnerabilities: Linux software vulnerabilities, Windows system vulnerabilities, Web-CMS vulnerabilities, application vulnerabilities, and urgent vulnerabilities.
You can use this operation together with the DescribeVulExportInfo operation. After you call the ExportVul operation to create a vulnerability export task, you can call the DescribeVulExportInfo operation to query the progress of the task by specifying the ID of the task.
Limits
You can call this operation up to 10 times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
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 Resourcesis 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:ExportVul | none |
|
| 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 |
| Type | string | Yes | The type of the vulnerability that you want to export. Valid values:
| app |
| Uuids | string | No | The UUID of the server on which the vulnerabilities are detected. Separate multiple UUIDs with commas (,). | 1587bedb-fdb4-48c4-9330-**** |
| AliasName | string | No | The name of the vulnerability. | RHSA-2019:3197-Important: sudo security update |
| Necessity | string | No | The priority to fix the vulnerability. Separate multiple priorities with commas (,). Valid values:
| asap |
| Dealed | string | No | Specifies whether the vulnerability is fixed. Valid values:
| n |
| GroupId | string | No | The server group ID of the server on which the vulnerabilities are detected. Note
You can call the DescribeAllGroups operation to query the IDs of server groups.
| 8834224 |
| SearchTags | string | No | The tag that is used to search for the vulnerabilities. Valid values:
| Restart required |
| AttachTypes | string | No | The additional type of the vulnerabilities. You need to specify this parameter when you query application vulnerabilities. If you set the Type parameter to app, you must specify this parameter. Set the value to sca. Note
If this parameter is set 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 (,). Note
You can call the DescribeVpcList operation to query the IDs of VPCs.
| ins-133****,ins-5414**** |
| CveId | string | No | The Common Vulnerabilities and Exposures (CVE) ID of the vulnerability. | CVE-2022-44702 |
| Path | string | No | The path of the process that is affected by the vulnerability. | /etc/test |
| ContainerName | string | No | The name of the container that is affected by the vulnerability. | xxljob-7b87597b99-mcskr |
| ImageName | string | No | The name of the image that is affected by the vulnerability. | container-***:**** |
| CreateTsStart | long | No | The start time of the first scan. Note
This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.
| 1696128144000 |
| CreateTsEnd | long | No | The end time of the first scan. Note
This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.
| 1696186800000 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "E1FAB2B8-DF4D-55DF-BC3D-5C3CA6FD5B13",
"FileName": "app_20211101",
"Id": 81634
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | FreeVersionNotPermit | Free version is not permitted. | The free version cannot be used. |
| 403 | NoPermission | caller has no permission | You are not authorized to do this operation. |
| 500 | ServerError | ServerError | - |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-06-13 | The Error code has changed | View Change Details |
| 2023-10-16 | The request parameters of the API has changed | View Change Details |
| 2023-10-12 | The request parameters of the API has changed | View Change Details |
| 2023-09-21 | The request parameters of the API has changed | View Change Details |
| 2022-08-01 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2022-08-01 | The internal configuration of the API is changed, but the call is not affected | View Change Details |