Security Center:ListBackupRecord - Security Center - Alibaba Cloud - Security Center

Queries a list of backup records.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MachineRemark	string	No	The identification information of the server protected by the anti-ransomware policy that you want to query. You can enter the IP address or instance ID of the server.	192.168.XX.XX
StatusList	array	No	The list of backup task statuses. Valid values: BACKUP_COMPLETE: backup succeeded BACKUP_FAILED: backup failed PARTIAL_COMPLETE: partial backup succeeded.
	string	No	The list of backup task statuses.	["BACKUP_COMPLETE"]
BackupStartTime	integer	No	The backup start time. The value is a timestamp in milliseconds.	1699514211000
BackupEndTime	integer	No	The backup end time. The value is a timestamp in milliseconds.	1699600611000
CurrentPage	integer	No	The page number of the page to return. Default value: 1, which indicates the first page.	1
PageSize	integer	No	The maximum number of entries per page in a paged query. Default value: 20. If you leave this parameter empty, 20 entries are returned. Note Do not leave PageSize empty.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request. Alibaba Cloud generates a unique identifier for each request. You can use the ID to troubleshoot issues.	3956048F-9D73-5EDB-834B-4827BB48****
BackupRecordList	array<object>	The list of backup records.
	object
Uuid	string	The UUID of the server backed up by database anti-ransomware.	b93cccb9-f19f-4886-97fe-47df26ba****
ClientId	string	The anti-ransomware client ID.	c-0002bgagelj3d2sc****
BackupPlanId	string	The backup plan ID.	plan-000c4tt43nolmx96****
BackupJobId	string	The backup task ID.	a006f24d069843c88688672d74ee****
BackupStartTime	integer	The backup start time. The value is a timestamp in milliseconds.	1699514211000
BackupEndTime	integer	The backup end time. The value is a timestamp in milliseconds.	1699600611000
BackupStatus	string	The backup task status. Valid values: BACKUP_COMPLETE: backup succeeded BACKUP_FAILED: backup failed PARTIAL_COMPLETE: partial backup succeeded.	BACKUP_COMPLETE
ErrorCode	string	The error code of the backup task.	FILE_CACHE_NO_SPACE
ErrorMessage	string	The error details of the backup task.	FILE_CACHE_NO_SPACE
InstanceName	string	The instance name of the asset.	openapi
Ip	string	The IP address of the server.	1.1.1.1
InstanceId	string	The ID of the server instance.	i-wz9ikn44p46krnic****
InternetIp	string	The public IP address of the server.	1.1.1.1
IntranetIp	string	The private IP address of the server.	192.168.1.1
RegionId	string	The region ID of the backup service.	cn-hangzhou
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the current page in a paged query.	2
PageSize	integer	The maximum number of entries per page in a paged query.	20
TotalCount	integer	The total number of entries returned.	100
Count	integer	The number of entries on the current page in a paged query.	20

Examples

Success response

JSON format

{
  "RequestId": "3956048F-9D73-5EDB-834B-4827BB48****",
  "BackupRecordList": [
    {
      "Uuid": "b93cccb9-f19f-4886-97fe-47df26ba****",
      "ClientId": "c-0002bgagelj3d2sc****",
      "BackupPlanId": "plan-000c4tt43nolmx96****",
      "BackupJobId": "a006f24d069843c88688672d74ee****",
      "BackupStartTime": 1699514211000,
      "BackupEndTime": 1699600611000,
      "BackupStatus": "BACKUP_COMPLETE",
      "ErrorCode": "FILE_CACHE_NO_SPACE",
      "ErrorMessage": "FILE_CACHE_NO_SPACE",
      "InstanceName": "openapi",
      "Ip": "1.1.1.1",
      "InstanceId": "i-wz9ikn44p46krnic****",
      "InternetIp": "1.1.1.1\n",
      "IntranetIp": "192.168.1.1",
      "RegionId": "cn-hangzhou"
    }
  ],
  "PageInfo": {
    "CurrentPage": 2,
    "PageSize": 20,
    "TotalCount": 100,
    "Count": 20
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.