Связаться с намиПодключиться

Compute Cloud API, gRPC: MaintenanceService.Reschedule

Статья создана
Обновлена 8 августа 2025 г.

Allows user to reschedule Maintenance to another date and time.

gRPC request

rpc Reschedule (yandex.cloud.maintenance.v2.RescheduleMaintenanceRequest) returns (operation.Operation)

yandex.cloud.maintenance.v2.RescheduleMaintenanceRequest

{
  "maintenance_id": "string",
  "reschedule_type": "Type",
  "scheduled_at": "google.protobuf.Timestamp"
}

RescheduleMaintenanceRequest allows to reschedule maintenance to another date and time.

Field

Description

maintenance_id

string

Required field. Required. ID of the maintenance.

reschedule_type

enum Type

Required. If reschedule_type is "SPECIFIC_TIME",
must set up schedule_time as well.

  • TYPE_UNSPECIFIED: Not set.
  • IMMEDIATE: If the user wants to reschedule the maintenance to happen now.
  • NEXT_AVAILABLE_WINDOW: If the user wants to reschedule the maintenance for the next maintenance window.
  • SPECIFIC_TIME: If the user wants to reschedule the maintenance to a specific time.

scheduled_at

google.protobuf.Timestamp

Optional. Timestamp the maintenance shall be rescheduled to,
if reschedule_type = "SPECIFIC_TIME".
Must be in RFC 3339 format (e.g. "2025-11-15T16:19:00.094Z").

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "resource_path": [
      {
        "id": "string",
        "type": "string"
      }
    ],
    "description": "string",
    "details": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "status": "Status",
    "created_at": "google.protobuf.Timestamp",
    "start_scheduled_at": "google.protobuf.Timestamp",
    "completion_scheduled_at": "google.protobuf.Timestamp",
    "max_start_scheduled_at": "google.protobuf.Timestamp",
    "started_at": "google.protobuf.Timestamp",
    "succeeded_at": "google.protobuf.Timestamp",
    "cancelled_at": "google.protobuf.Timestamp",
    "user_controllable": "bool"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

google.protobuf.Any

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Maintenance

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Maintenance

Field

Description

id

string

ID of the maintenance.

resource_path[]

Resource

Full path to the resource affected by maintenance,
represented as a hierarchy from specific resource to top-level container.
Example for a Compute instance with ID "I" in folder "F" and cloud "C":
resource_path = [
{ "compute.instance", "I" },
{ "resource-manager.folder", "F" },
{ "resource-manager.cloud", "C" }
]

description

string

Describes action to be performed.

details[]

Detail

Service-specific details.

status

enum Status

Status of the maintenance.

  • STATUS_UNSPECIFIED: Not set.
  • SCHEDULED: Maintenance is scheduled for a future time.
  • RUNNING: Maintenance is currently running.
  • SUCCEEDED: Maintenance completed successfully.
  • CANCELLED: Maintenance is cancelled and will not run.

created_at

google.protobuf.Timestamp

The creation time of the maintenance.

start_scheduled_at

google.protobuf.Timestamp

The time when the maintenance was scheduled to start.

completion_scheduled_at

google.protobuf.Timestamp

The time when the maintenance is estimated to complete. Optional.

max_start_scheduled_at

google.protobuf.Timestamp

Latest time the maintenance can be postponed to.

started_at

google.protobuf.Timestamp

The time time when the maintenance has actually started.

succeeded_at

google.protobuf.Timestamp

The time time when the maintenance has actually completed successfully.

cancelled_at

google.protobuf.Timestamp

The time time when the maintenance has actually been cancelled.

user_controllable

bool

Indicates whether the user can control (reschedule) the maintenance.

Resource

Field

Description

id

string

ID of the resource

type

string

The type of the resource, e.g. resource-manager.cloud, resource-manager.folder, compute.instance, etc.

Detail

Field

Description

key

string

Unique key (service-specific).

value

string

Description (service-specific).
Предыдущая
Get
Следующая
Overview