Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Cloud Backup
  • Getting started
    • All guides
    • Activating the service
    • Viewing service resource operations
    • Limiting RAM usage by the Cloud Backup agent
    • Viewing backup statistics
  • Access management
  • Pricing policy
  • Terraform reference
    • API authentication
      • Overview
        • Overview
        • List
        • Get
        • Delete
        • ListTasks
        • ListDirectory
        • CreateDirectory
        • ListOperations
  • Monitoring metrics
  • Audit Trails events
  • Release notes
  • Troubleshooting

In this article:

  • gRPC request
  • ListTasksRequest
  • ListTasksResponse
  • Task
  • Progress
  1. API reference
  2. gRPC
  3. Resource
  4. ListTasks

Cloud Backup API, gRPC: ResourceService.ListTasks

Written by
Yandex Cloud
Updated at November 26, 2024
  • gRPC request
  • ListTasksRequest
  • ListTasksResponse
  • Task
  • Progress

List tasks of resources.

gRPC requestgRPC request

rpc ListTasks (ListTasksRequest) returns (ListTasksResponse)

ListTasksRequestListTasksRequest

{
  "compute_instance_id": "string",
  "page_size": "int64",
  "page_token": "string"
}

Field

Description

compute_instance_id

string

Required field. Compute Cloud instance ID.

page_size

int64

Number of results per page.

page_token

string

Token for the results page.

ListTasksResponseListTasksResponse

{
  "tasks": [
    {
      "id": "int64",
      "cancellable": "bool",
      "policy_id": "string",
      "type": "Type",
      "progress": {
        "current": "int64",
        "total": "int64"
      },
      "status": "Status",
      "enqueued_at": "google.protobuf.Timestamp",
      "started_at": "google.protobuf.Timestamp",
      "updated_at": "google.protobuf.Timestamp",
      "completed_at": "google.protobuf.Timestamp",
      "compute_instance_id": "string",
      "result_code": "Code",
      "error": "string"
    }
  ],
  "next_page_token": "string"
}

Field

Description

tasks[]

Task

Set of tasks parameters.

next_page_token

string

Token for the next results page.

TaskTask

Field

Description

id

int64

Task ID.

cancellable

bool

Shows whether the task is cancellable.
Note: task cancellation is not supported yet.

policy_id

string

Policy ID.

type

enum Type

Type of the task.

  • TYPE_UNSPECIFIED
  • BACKUP
  • RETENTION
  • RECOVERY
  • APPLY_POLICY
  • REVOKE_POLICY

progress

Progress

Task progress.

status

enum Status

Task status.

  • STATUS_UNSPECIFIED
  • ENQUEUED
  • ASSIGNED
  • STARTED
  • PAUSED
  • COMPLETED

enqueued_at

google.protobuf.Timestamp

started_at

google.protobuf.Timestamp

updated_at

google.protobuf.Timestamp

completed_at

google.protobuf.Timestamp

compute_instance_id

string

Compute Cloud instance ID.

result_code

enum Code

Task result code.

  • CODE_UNSPECIFIED
  • OK
  • ERROR
  • WARNING
  • CANCELLED
  • ABANDONED
  • TIMEDOUT

error

string

Task error message if task finished with not OK code

ProgressProgress

Field

Description

current

int64

total

int64

Was the article helpful?

Previous
Delete
Next
ListDirectory
© 2025 Direct Cursus Technology L.L.C.