Snapshot#

Description of a snapshot.

Contents#

  • description — The description of the snapshot.

    • Type: String

    • Required: No

  • isPublic — Indicates whether the snapshot of the volume is public.

    • Type: Boolean

    • Required: No

  • isShared — Indicates whether the snapshot is accessible by some projects.

    • Type: Boolean

    • Required: No

  • ownerAlias — The alias of the snapshot owner.

    • Type: String

    • Required: No

  • ownerId — The ID of the project.

    • Type: String

    • Required: No

  • progress — The progress of the snapshot creation process (shown in percentage).

    • Type: String

    • Required: No

  • snapshotId — The ID of the snapshot.

    • Type: String

    • Required: No

  • startTime — The timestamp when the snapshot was initiated.

    • Type: String

    • Required: No

  • status — The state of the snapshot.

    • Type: String

    • Valid values: pending | completed | error

    • Required: No

  • tagSet — Any tags assigned to the snapshot.

    • Type: List of Tag objects

    • Required: No

  • volumeId — The ID of the volume.

    • Type: String

    • Required: No

  • volumeSize — The size of the volume.

    • Type: Integer

    • Required: No

  • volumeSizeInBytes — The size of the volume in bytes.

    • Type: Integer

    • Required: No