Query Backup Status and Details via GetBackup API - Compute Nest

Operation description

Prerequisites

Ensure that the service provider enabled the upgrade and downgrade feature and configured its 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:GetBackup

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BackupId	string	Yes	The backup ID.	backup-cad4a85ff5e340388b93

Response elements

Element	Type	Description	Example
	object	The response schema.
BackupId	string	The backup ID.	backup-cad4a85ff5e340388b93
ServiceInstanceId	string	The service instance ID.	si-b58c874912fc4294****
StartTime	string	The time when the backup started.	2022-01-01T11:00:00
EndTime	string	The time when the backup ended.	2022-01-01T12:00:00
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 backup description.	No description
CreateTime	string	The time when the backup was created.	2021-05-20T00:00:00Z
ModifiedTime	string	The time when the backup was last modified.	2025-03-10T19:26:20Z
RequestId	string	The request ID.	13FE89A5-C036-56BF-A0FF-A31C59819FD7
StatusDetail	string	The detailed status of the deployment instance.	Disk i-xxxx backup failed, error message: error

Examples

Success response

JSON format

{
  "BackupId": "backup-cad4a85ff5e340388b93",
  "ServiceInstanceId": "si-b58c874912fc4294****",
  "StartTime": "2022-01-01T11:00:00",
  "EndTime": "2022-01-01T12:00:00",
  "Status": "Creating",
  "Description": "No description",
  "CreateTime": "2021-05-20T00:00:00Z",
  "ModifiedTime": "2025-03-10T19:26:20Z",
  "RequestId": "13FE89A5-C036-56BF-A0FF-A31C59819FD7",
  "StatusDetail": "Disk i-xxxx backup failed, error message: error"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.