ListBackups - Compute Nest - Alibaba Cloud Documentation Center

Queries a list of backups for Compute Nest service instances.

Operation description

Prerequisites

Ensure that the service provider enabled the upgrade and downgrade feature and configured the related parameters when the service was created.

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

computenest:ListBackups

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MaxResults	integer	No	The number of entries per page.	20
NextToken	string	No	The token that is used to start the next query.	AAAAAc3HCuYhJi/wvpk4xOr0VLYoaeZA6xVdkCrmG9EmGshtmECUGpq9Qm7x5vQkpz9NXH0XzUc9t4Kxaf3UtuPY4a0=
Filter	array<object>	No	The filter.
	object	No	The filter.
Value	array	No	The filter values.
	string	No	A filter value.	si-xxx
Name	string	No	The name of the filter. You can query by one or more filter names. Valid values: BackupId: The backup ID. ServiceInstanceId: The service instance ID. Status: The status. StartTime: The start time. EndTime: The end time.	ServiceInstanceId

Response elements

Element	Type	Description	Example
	object	Schema of Response
TotalCount	integer	The total number of entries that meet the query conditions.	1
RequestId	string	The request ID.	BB58FE53-ED8F-5D12-9746-CD3A5F463D95
NextToken	string	The token that is used to retrieve the next page of results. If this parameter is empty, all results have been returned.	AAAAAc3HCuYhJi/wvpk4xOr0VLYoaeZA6xVdkCrmG9EmGshtmECUGpq9Qm7x5vQkpz9NXH0XzUc9t4Kxaf3UtuPY4a0=
MaxResults	integer	The maximum number of entries returned on the current page.	100
Backups	array<object>	The backups.
	object	The details of a backup.
BackupId	string	The backup ID.	backup-4e13aa8ca6a34150addd
ServiceInstanceId	string	The service instance ID.	si-7b6138dfce1e4c41ab71
StartTime	string	The time when the backup started.	2025-06-30T16:00:00Z
EndTime	string	The time when the backup ended.	2024-08-15T02:24:00Z
Status	string	The status. Creating: The backup is being created. Created: The backup is created. CreateFailed: The backup failed to be created. Deleting: The backup is being deleted. Deleted: The backup is deleted. DeleteFailed: The backup failed to be deleted.	Creating
Description	string	The description of the backup.	No description
BackupMode	string	The backup mode. The return value is: Manual: The backup is created manually.	Manual
RetentionDays	integer	The retention period in days. Backups are deleted after the retention period expires. By default, this parameter is empty, which means that the backups do not expire.	1
StatusDetail	string	The details of the status.	Disk i-xxxx backup failed, error message: error
ModifiedTime	string	The time when the backup was last updated.	2024-09-03T19:54:38+08:00
CreateTime	string	The time when the backup was created.	2024-09-03T19:54:38+08:00

Examples

Success response

JSON format

{
  "TotalCount": 1,
  "RequestId": "BB58FE53-ED8F-5D12-9746-CD3A5F463D95",
  "NextToken": "AAAAAc3HCuYhJi/wvpk4xOr0VLYoaeZA6xVdkCrmG9EmGshtmECUGpq9Qm7x5vQkpz9NXH0XzUc9t4Kxaf3UtuPY4a0=",
  "MaxResults": 100,
  "Backups": [
    {
      "BackupId": "backup-4e13aa8ca6a34150addd",
      "ServiceInstanceId": "si-7b6138dfce1e4c41ab71",
      "StartTime": "2025-06-30T16:00:00Z",
      "EndTime": "2024-08-15T02:24:00Z",
      "Status": "Creating",
      "Description": "No description",
      "BackupMode": "Manual",
      "RetentionDays": 1,
      "StatusDetail": "Disk i-xxxx backup failed, error message: error\t",
      "ModifiedTime": "2024-09-03T19:54:38+08:00",
      "CreateTime": "2024-09-03T19:54:38+08:00"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.