All Products
Search

This Product

    Compute Nest:ListRestoreTasks

    Document Center

    Compute Nest:ListRestoreTasks

    Last Updated:Oct 22, 2025

    Queries a list of restore jobs.

    Operation description

    Prerequisites

    Ensure that the service provider enabled the upgrade and downgrade feature and configured its parameters when creating the service.

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

    none

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    MaxResults

    integer

    Yes

    The number of entries to return on each page. Maximum value: 100. Default value: 20.

    20
    NextToken

    string

    Yes

    The token that is used to retrieve the next page of results.

    AAAAAWns8w4MmhzeptXVRG0PUEU=
    Filter

    array<object>

    Yes

    The filter.

    object

    No

    The filter.

    Value

    array

    No

    A list of filter values.

    string

    No

    A list of filter values.

    si-xxxx
    Name

    string

    No

    The name of the filter. You can query by one or more filter names. Valid values:

    • RestoreTaskId: The restore job 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

    The response schema.

    TotalCount

    integer

    The total number of entries that meet the filter criteria.

    1
    RequestId

    string

    The request ID.

    464C8CB6-A548-5206-B83C-D32A8E43EC21
    NextToken

    string

    The token that is used to retrieve the next page of results. If this parameter is empty, all results have been returned.

    BBBAAfu+XtuBE55iRLHEYYuojI4=
    MaxResults

    integer

    The maximum number of entries returned for the request.

    20
    RestoreTasks

    array<object>

    The list of restore jobs.

    object

    RestoreTaskId

    string

    The ID of the restore job.

    restore-xxxxxx
    ServiceInstanceId

    string

    The ID of the service instance.

    si-8c367c27c84e44a79d36
    BackupId

    string

    The backup ID.

    backup-728f128bf92c4e3da970
    EndTime

    string

    The time when the restore job ended.

    2025-01-27T18:00:00Z
    Status

    string

    The status of the service instance. Valid values:

    • Restoring: The service instance is being restored.

    • Restored: The service instance was restored.

    • RestoreFailed: The service instance failed to be restored.

    Restoring
    StartTime

    string

    The time when the restore job started.

    2025-01-27T16:00:00Z
    StatusDetail

    string

    The details of the instance status.

    i-xxxx failed, error message: error
    CreateTime

    string

    The time when the job was created.

    2023-09-07T11:37:37Z
    ModifiedTime

    string

    The time when the job was last updated.

    2025-05-07T12:16:16Z

    Examples

    Success response

    JSON format

    {
  "TotalCount": 1,
  "RequestId": "464C8CB6-A548-5206-B83C-D32A8E43EC21",
  "NextToken": "BBBAAfu+XtuBE55iRLHEYYuojI4=",
  "MaxResults": 20,
  "RestoreTasks": [
    {
      "RestoreTaskId": "restore-xxxxxx",
      "ServiceInstanceId": "si-8c367c27c84e44a79d36",
      "BackupId": "backup-728f128bf92c4e3da970",
      "EndTime": "2025-01-27T18:00:00Z",
      "Status": "Restoring",
      "StartTime": "2025-01-27T16:00:00Z",
      "StatusDetail": "i-xxxx  failed, error message: error",
      "CreateTime": "2023-09-07T11:37:37Z",
      "ModifiedTime": "2025-05-07T12:16:16Z"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.