All Products
Search
Document Center

Security Center:DescribeBackUpExportInfo

Last Updated:Nov 25, 2024

Queries the information about a file to which archived alert events are exported.

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

Request parameters

ParameterTypeRequiredDescriptionExample
CurrentPageintegerNo

The page number.

1
PageSizeintegerNo

The number of entries per page. Default value: 20.

20
ExportTypestringYes

The type of archived information. Valid values:

  • suspiciousExport: alert event
suspiciousExport
LangstringNo

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

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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

BE120DAB-F4E7-4C53-ADC3-A97578ABF384
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

20
TotalCountinteger

The total number of entries returned.

29
Countinteger

The number of entries returned on the current page.

9
Dataarray<object>

The data returned.

Dataobject

The information about the file.

Statusstring

The status of the export task. Valid values:

  • init: The task is being initialized.
  • exporting: The task is in progress.
  • success: The task is complete.
success
Progressinteger

The progress percentage of the export task.

100
CurrentCountinteger

The number of exported entries.

29
GmtCreatelong

The time when the export task was created.

1671607025000
Messagestring

The error message that is returned when the export task fails.

success
FileNamestring

The name of the file.

suspicious_event_20221203
TotalCountinteger

The total number of entries in the file.

29
Idlong

The ID of the export task.

273698***

Examples

Sample success responses

JSONformat

{
  "RequestId": "BE120DAB-F4E7-4C53-ADC3-A97578ABF384",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 29,
    "Count": 9
  },
  "Data": [
    {
      "Link": "http://xxx.oss-cn-xxx.aliyuncs.com/export/assetInstance_20221221_1671606250570.zip",
      "Status": "success",
      "Progress": 100,
      "CurrentCount": 29,
      "GmtCreate": 1671607025000,
      "Message": "success",
      "FileName": "suspicious_event_20221203",
      "TotalCount": 29,
      "Id": 0
    }
  ]
}

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
2023-12-26The internal configuration of the API is changed, but the call is not affectedView Change Details