All Products
Search
Document Center

Security Center:ExportCustomizeReport

Last Updated:Nov 25, 2024

Exports a security report.

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:ExportCustomizeReportget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ReportIdlongYes

The ID of the security report.

Note You can call the DescribeCustomizeReportList operation to query the ID.
1
ExportTypestringNo

The type of the security report that you want to export. Valid values:

  • HTML
  • PDF
Note The default value is HTML. PDF is supported only for security reports in version 2.0.0.
HTML

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

ExportIdlong

The ID of the export task.

22
RequestIdstring

The request ID.

FFDFCEB3-A5EE-590A-8E70-283EBC5D****
DownloadUrlstring

The download URL of the security report.

https://xxxxxxxx.oss-cn-hangzhou-1.aliyuncs.com/xxxxx/xxxxxxxxxxxxxx?Expires=1671448125&OSSAccessKeyId=xxx
UrlExpiredTimelong

The timestamp when the download URL expires. Unit: seconds.

1673335497000
ExportDatestring

The time when the security report was exported.

2023-01-10
ReportIdlong

The ID of the security report.

123
FileNamestring

The name of the report file that is exported.

test_xxxx.html
ExportStatusstring

The status of the export task. Valid values:

  • fail: The export task fails.
  • exporting: The export task is being executed.
  • success: The export task is successful.
exporting

Examples

Sample success responses

JSONformat

{
  "ExportId": 22,
  "RequestId": "FFDFCEB3-A5EE-590A-8E70-283EBC5D****",
  "DownloadUrl": "https://xxxxxxxx.oss-cn-hangzhou-1.aliyuncs.com/xxxxx/xxxxxxxxxxxxxx?Expires=1671448125&OSSAccessKeyId=xxx",
  "UrlExpiredTime": 1673335497000,
  "ExportDate": "2023-01-10",
  "ReportId": 123,
  "FileName": "test_xxxx.html",
  "ExportStatus": "exporting"
}

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.