Compute Cloud API, gRPC: SnapshotScheduleService.Update

Статья создана

Yandex Cloud

Обновлена 17 декабря 2024 г.

gRPC request
UpdateSnapshotScheduleRequest
SchedulePolicy
SnapshotSpec
operation.Operation
UpdateSnapshotScheduleMetadata
SnapshotSchedule
SchedulePolicy
SnapshotSpec

Updates the specified snapshot schedule.

The schedule is updated only after all snapshot creations and deletions triggered by the schedule are completed.

gRPC request

rpc Update (UpdateSnapshotScheduleRequest) returns (operation.Operation)

UpdateSnapshotScheduleRequest

{
  "snapshot_schedule_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "schedule_policy": {
    "start_at": "google.protobuf.Timestamp",
    "expression": "string"
  },
  // Includes only one of the fields `retention_period`, `snapshot_count`
  "retention_period": "google.protobuf.Duration",
  "snapshot_count": "int64",
  // end of the list of possible fields
  "snapshot_spec": {
    "description": "string",
    "labels": "map<string, string>"
  }
}

Field	Description
snapshot_schedule_id	string ID of the snapshot schedule to update. To get the snapshot schedule ID, make a SnapshotScheduleService.List request.
update_mask	google.protobuf.FieldMask Field mask that specifies which attributes of the snapshot schedule should be updated.
name	string New name for the snapshot schedule. The name must be unique within the folder.
description	string New description of the snapshot schedule.
labels	object (map<string, string>) Snapshot schedule labels as `key:value` pairs. Existing set of labels is completely replaced by the provided set, so if you just want to add or remove a label: Get the current set of labels with a SnapshotScheduleService.Get request. Add or remove a label in this set. Send the new set in this field.
schedule_policy	SchedulePolicy New frequency settings of the snapshot schedule.
retention_period	google.protobuf.Duration Retention period of the snapshot schedule. Once a snapshot created by the schedule reaches this age, it is automatically deleted. Includes only one of the fields `retention_period`, `snapshot_count`. New retention policy of the snapshot schedule.
snapshot_count	int64 Retention count of the snapshot schedule. Once the number of snapshots created by the schedule exceeds this number, the oldest ones are automatically deleted. E.g. if the number is 5, the first snapshot is deleted after the sixth one is created, the second is deleted after the seventh one is created, and so on. Includes only one of the fields `retention_period`, `snapshot_count`. New retention policy of the snapshot schedule.
snapshot_spec	SnapshotSpec New attributes of snapshots created by the snapshot schedule.

SchedulePolicy

A resource for frequency settings of a snapshot schedule.

Field

Description

start_at

google.protobuf.Timestamp

Timestamp for creating the first snapshot.

expression

string

Cron expression for the snapshot schedule (UTC+0).

The expression must consist of five fields (Minutes Hours Day-of-month Month Day-of-week) or be one of
nonstandard predefined expressions (e.g. @hourly). For details about the format,
see documentation

SnapshotSpec

A resource for attributes of snapshots created by the snapshot schedule.

Field

Description

description

string

Description of the created snapshot.

labels

object (map<string, string>)

Snapshot labels as key:value pairs.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "snapshot_schedule_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "status": "Status",
    "schedule_policy": {
      "start_at": "google.protobuf.Timestamp",
      "expression": "string"
    },
    // Includes only one of the fields `retention_period`, `snapshot_count`
    "retention_period": "google.protobuf.Duration",
    "snapshot_count": "int64",
    // end of the list of possible fields
    "snapshot_spec": {
      "description": "string",
      "labels": "map<string, string>"
    }
  }
  // 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	UpdateSnapshotScheduleMetadata 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	SnapshotSchedule 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.

UpdateSnapshotScheduleMetadata

Field

Description

snapshot_schedule_id

string

ID of the snapshot schedule that is being updated.

SnapshotSchedule

A snapshot schedule. For details about the concept, see documentation.

Field	Description
id	string ID of the snapshot schedule.
folder_id	string ID of the folder that the snapshot schedule belongs to.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the snapshot schedule. The name is unique within the folder.
description	string Description of the snapshot schedule.
labels	object (map<string, string>) Snapshot schedule labels as `key:value` pairs.
status	enum Status Status of the snapshot schedule. `STATUS_UNSPECIFIED` `CREATING`: The snapshot schedule is being created. `ACTIVE`: The snapshot schedule is on: new disk snapshots will be created, old ones deleted (if SnapshotSchedule.retention_policy is specified). `INACTIVE`: The schedule is interrupted, snapshots won't be created or deleted. `DELETING`: The schedule is being deleted. `UPDATING`: Changes are being made to snapshot schedule settings or a list of attached disks.
schedule_policy	SchedulePolicy Frequency settings of the snapshot schedule.
retention_period	google.protobuf.Duration Retention period of the snapshot schedule. Once a snapshot created by the schedule reaches this age, it is automatically deleted. Includes only one of the fields `retention_period`, `snapshot_count`. Retention policy of the snapshot schedule.
snapshot_count	int64 Retention count of the snapshot schedule. Once the number of snapshots created by the schedule exceeds this number, the oldest ones are automatically deleted. E.g. if the number is 5, the first snapshot is deleted after the sixth one is created, the second is deleted after the seventh one is created, and so on. Includes only one of the fields `retention_period`, `snapshot_count`. Retention policy of the snapshot schedule.
snapshot_spec	SnapshotSpec Attributes of snapshots created by the snapshot schedule.

SchedulePolicy

A resource for frequency settings of a snapshot schedule.

Field

Description

start_at

google.protobuf.Timestamp

Timestamp for creating the first snapshot.

expression

string

Cron expression for the snapshot schedule (UTC+0).

SnapshotSpec

A resource for attributes of snapshots created by the snapshot schedule.

Field

Description

description

string

Description of the created snapshot.

labels

object (map<string, string>)

Snapshot labels as key:value pairs.

Compute Cloud API, gRPC: SnapshotScheduleService.Update

gRPC requestgRPC request

UpdateSnapshotScheduleRequestUpdateSnapshotScheduleRequest

SchedulePolicySchedulePolicy

SnapshotSpecSnapshotSpec

operation.Operationoperation.Operation

UpdateSnapshotScheduleMetadataUpdateSnapshotScheduleMetadata

SnapshotScheduleSnapshotSchedule

SchedulePolicySchedulePolicy

SnapshotSpecSnapshotSpec

Была ли статья полезна?

gRPC request

UpdateSnapshotScheduleRequest

SchedulePolicy

SnapshotSpec

operation.Operation

UpdateSnapshotScheduleMetadata

SnapshotSchedule

SchedulePolicy

SnapshotSpec