Getting Information About Worker Nodes Snapshots

You can get information about the snapshots of your worker nodes at project level using OKS CLI.

Getting Information About Worker Nodes Snapshots Using OKS CLI

Before you begin: Install and configure OKS CLI. For more information, see Installing and Configuring OKS CLI.

The project snapshots command allows you to retrieve the list of snapshots of your worker nodes at project level:

Request sample

$ oks-cli project snapshots \
    --project-name NAME_OF_PROJECT

This command contains the following option that you need to specify:

project-name: The name of the project you want to retrieve snapshot information from.
(optional) output: The output format for the response (json| yaml). By default, the response format is JSON.

The project snapshots command returns the following elements:

VolumeSize: The size of the volume, in gibibytes (GiB).
AccountId: The unique identifier of the Cloud account where the project’s infrastructure (such as the VPC and node pools) is deployed.
VolumeId: The ID of the volume.
CreationDate: The date and time of the snapshot creation, in ISO 8601 format.
Progress: The progress of the snapshot (a percentage).
SnapshotId: The ID of the snapshot.
State: The state of the snapshot (in-queue | pending | completed).
Description: The description of the snapshot.
Tags: One or more tags associated with the volume. This element contains the following information:
- Key: The key of the tag.
- Value: The value of the tag.
PermissionsToCreateVolume: Permissions for the resource. This element contains the following information:
- GlobalPermission: The number of global permissions for all accounts.
- AccountIds: One or more account IDs that are associated with the permission.

Result sample

[
    {
        "VolumeSize": 4,
        "AccountId": "123456789012",
        "VolumeId": "vol-12345678",
        "CreationDate": "2025-07-08T11:38:03.131Z",
        "Progress": 100,
        "SnapshotId": "snap-87654321",
        "State": "completed",
        "Description": "Created by Outscale BSU CSI driver for volume vol-12345678",
        "Tags": [
            {
                "Key": "CSIVolumeSnapshotName",
                "Value": "snapshot-12345678-1234-4321-1234-123456789123"
            }
        ],
        "PermissionsToCreateVolume": {
            "GlobalPermission": 0,
            "AccountIds": []
        }
    }
]

Related Pages