DescribeVulExportInfo API Overview - Security Center - Alibaba Cloud - Security Center

Operation description

A download link is returned when the export task status is success.

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:DescribeVulExportInfo

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ExportId	integer	Yes	The ID of the vulnerability export task.	14356
ResourceDirectoryAccountId	integer	No		1

Response elements

Element	Type	Description	Example
	object	The response data of the export task.
Link	string	The download link of the exported Excel file.	http://www.aliyun.com
Progress	integer	The export progress percentage (%).	100
RequestId	string	The request ID. Alibaba Cloud generates a unique identifier for each API request. You can use this ID to troubleshoot issues.	4C1AE3F3-18FA-4108-BXXX-AFA1A032756C
CurrentCount	integer	The number of data entries that have been exported.	1
Message	string	The message about the export result. Fixed value: success. This value indicates that the export is successful.	success
FileName	string	The name of the exported Excel file.	app_20210917
TotalCount	integer	The total number of data entries in the exported Excel file.	10
ExportStatus	string	The status of the export task. Valid values: init: initializing exporting: exporting in progress success: export successful.	success
Id	integer	The ID of the vulnerability export task.	14356

Examples

Success response

JSON format

{
  "Link": "http://www.aliyun.com",
  "Progress": 100,
  "RequestId": "4C1AE3F3-18FA-4108-BXXX-AFA1A032756C",
  "CurrentCount": 1,
  "Message": "success",
  "FileName": "app_20210917",
  "TotalCount": 10,
  "ExportStatus": "success",
  "Id": 14356
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
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.