1. Packages
  2. Volcengine
  3. API Docs
  4. nas
  5. getSnapshots
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.nas.getSnapshots

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of nas snapshots

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";

const default = volcengine.nas.getSnapshots({
    fileSystemId: "enas-cnbj5c18f02afe0e",
    ids: [
        "snap-022c648fed8b",
        "snap-e53591b05fbd",
    ],
});

    import pulumi
import pulumi_volcengine as volcengine

default = volcengine.nas.get_snapshots(file_system_id="enas-cnbj5c18f02afe0e",
    ids=[
        "snap-022c648fed8b",
        "snap-e53591b05fbd",
    ])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/nas"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nas.GetSnapshots(ctx, &nas.GetSnapshotsArgs{
			FileSystemId: pulumi.StringRef("enas-cnbj5c18f02afe0e"),
			Ids: []string{
				"snap-022c648fed8b",
				"snap-e53591b05fbd",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Nas.GetSnapshots.Invoke(new()
    {
        FileSystemId = "enas-cnbj5c18f02afe0e",
        Ids = new[]
        {
            "snap-022c648fed8b",
            "snap-e53591b05fbd",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.nas.NasFunctions;
import com.pulumi.volcengine.nas.inputs.GetSnapshotsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var default = NasFunctions.getSnapshots(GetSnapshotsArgs.builder()
            .fileSystemId("enas-cnbj5c18f02afe0e")
            .ids(            
                "snap-022c648fed8b",
                "snap-e53591b05fbd")
            .build());

    }
}

    variables:
  default:
    fn::invoke:
      Function: volcengine:nas:getSnapshots
      Arguments:
        fileSystemId: enas-cnbj5c18f02afe0e
        ids:
          - snap-022c648fed8b
          - snap-e53591b05fbd

    Using getSnapshots

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSnapshots(args: GetSnapshotsArgs, opts?: InvokeOptions): Promise<GetSnapshotsResult>
function getSnapshotsOutput(args: GetSnapshotsOutputArgs, opts?: InvokeOptions): Output<GetSnapshotsResult>
    def get_snapshots(file_system_id: Optional[str] = None,
                  ids: Optional[Sequence[str]] = None,
                  output_file: Optional[str] = None,
                  snapshot_name: Optional[str] = None,
                  snapshot_type: Optional[str] = None,
                  status: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetSnapshotsResult
def get_snapshots_output(file_system_id: Optional[pulumi.Input[str]] = None,
                  ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                  output_file: Optional[pulumi.Input[str]] = None,
                  snapshot_name: Optional[pulumi.Input[str]] = None,
                  snapshot_type: Optional[pulumi.Input[str]] = None,
                  status: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetSnapshotsResult]
    func GetSnapshots(ctx *Context, args *GetSnapshotsArgs, opts ...InvokeOption) (*GetSnapshotsResult, error)
func GetSnapshotsOutput(ctx *Context, args *GetSnapshotsOutputArgs, opts ...InvokeOption) GetSnapshotsResultOutput

    > Note: This function is named GetSnapshots in the Go SDK.

    public static class GetSnapshots 
{
    public static Task<GetSnapshotsResult> InvokeAsync(GetSnapshotsArgs args, InvokeOptions? opts = null)
    public static Output<GetSnapshotsResult> Invoke(GetSnapshotsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSnapshotsResult> getSnapshots(GetSnapshotsArgs args, InvokeOptions options)
public static Output<GetSnapshotsResult> getSnapshots(GetSnapshotsArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:nas/getSnapshots:getSnapshots
  arguments:
    # arguments dictionary

    The following arguments are supported:

    FileSystemId string
    The ID of file system.
    Ids List<string>
    A list of Snapshot IDs.
    OutputFile string
    File name where to save data source results.
    SnapshotName string
    The name of snapshot.
    SnapshotType string
    The type of snapshot.
    Status string
    The status of snapshot.
    FileSystemId string
    The ID of file system.
    Ids []string
    A list of Snapshot IDs.
    OutputFile string
    File name where to save data source results.
    SnapshotName string
    The name of snapshot.
    SnapshotType string
    The type of snapshot.
    Status string
    The status of snapshot.
    fileSystemId String
    The ID of file system.
    ids List<String>
    A list of Snapshot IDs.
    outputFile String
    File name where to save data source results.
    snapshotName String
    The name of snapshot.
    snapshotType String
    The type of snapshot.
    status String
    The status of snapshot.
    fileSystemId string
    The ID of file system.
    ids string[]
    A list of Snapshot IDs.
    outputFile string
    File name where to save data source results.
    snapshotName string
    The name of snapshot.
    snapshotType string
    The type of snapshot.
    status string
    The status of snapshot.
    file_system_id str
    The ID of file system.
    ids Sequence[str]
    A list of Snapshot IDs.
    output_file str
    File name where to save data source results.
    snapshot_name str
    The name of snapshot.
    snapshot_type str
    The type of snapshot.
    status str
    The status of snapshot.
    fileSystemId String
    The ID of file system.
    ids List<String>
    A list of Snapshot IDs.
    outputFile String
    File name where to save data source results.
    snapshotName String
    The name of snapshot.
    snapshotType String
    The type of snapshot.
    status String
    The status of snapshot.

    getSnapshots Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Snapshots List<GetSnapshotsSnapshot>
    The collection of query.
    TotalCount int
    The total count of query.
    FileSystemId string
    The id of file system.
    Ids List<string>
    OutputFile string
    SnapshotName string
    The name of snapshot.
    SnapshotType string
    The type of snapshot.
    Status string
    The status of snapshot.
    Id string
    The provider-assigned unique ID for this managed resource.
    Snapshots []GetSnapshotsSnapshot
    The collection of query.
    TotalCount int
    The total count of query.
    FileSystemId string
    The id of file system.
    Ids []string
    OutputFile string
    SnapshotName string
    The name of snapshot.
    SnapshotType string
    The type of snapshot.
    Status string
    The status of snapshot.
    id String
    The provider-assigned unique ID for this managed resource.
    snapshots List<GetSnapshotsSnapshot>
    The collection of query.
    totalCount Integer
    The total count of query.
    fileSystemId String
    The id of file system.
    ids List<String>
    outputFile String
    snapshotName String
    The name of snapshot.
    snapshotType String
    The type of snapshot.
    status String
    The status of snapshot.
    id string
    The provider-assigned unique ID for this managed resource.
    snapshots GetSnapshotsSnapshot[]
    The collection of query.
    totalCount number
    The total count of query.
    fileSystemId string
    The id of file system.
    ids string[]
    outputFile string
    snapshotName string
    The name of snapshot.
    snapshotType string
    The type of snapshot.
    status string
    The status of snapshot.
    id str
    The provider-assigned unique ID for this managed resource.
    snapshots Sequence[GetSnapshotsSnapshot]
    The collection of query.
    total_count int
    The total count of query.
    file_system_id str
    The id of file system.
    ids Sequence[str]
    output_file str
    snapshot_name str
    The name of snapshot.
    snapshot_type str
    The type of snapshot.
    status str
    The status of snapshot.
    id String
    The provider-assigned unique ID for this managed resource.
    snapshots List<Property Map>
    The collection of query.
    totalCount Number
    The total count of query.
    fileSystemId String
    The id of file system.
    ids List<String>
    outputFile String
    snapshotName String
    The name of snapshot.
    snapshotType String
    The type of snapshot.
    status String
    The status of snapshot.

    Supporting Types

    GetSnapshotsSnapshot

    CreateTime string
    The create time of snapshot.
    Description string
    The description of snapshot.
    FileSystemId string
    The ID of file system.
    FileSystemName string
    The name of file system.
    Id string
    The ID of snapshot.
    IsEncrypt bool
    Whether is encrypt.
    Progress string
    The progress of snapshot.
    RetentionDays int
    The retention days of snapshot.
    SnapshotId string
    The ID of snapshot.
    SnapshotName string
    The name of snapshot.
    SnapshotType string
    The type of snapshot.
    SourceSize int
    The size of source.
    SourceVersion string
    The source version info.
    Status string
    The status of snapshot.
    ZoneId string
    The ID of zone.
    CreateTime string
    The create time of snapshot.
    Description string
    The description of snapshot.
    FileSystemId string
    The ID of file system.
    FileSystemName string
    The name of file system.
    Id string
    The ID of snapshot.
    IsEncrypt bool
    Whether is encrypt.
    Progress string
    The progress of snapshot.
    RetentionDays int
    The retention days of snapshot.
    SnapshotId string
    The ID of snapshot.
    SnapshotName string
    The name of snapshot.
    SnapshotType string
    The type of snapshot.
    SourceSize int
    The size of source.
    SourceVersion string
    The source version info.
    Status string
    The status of snapshot.
    ZoneId string
    The ID of zone.
    createTime String
    The create time of snapshot.
    description String
    The description of snapshot.
    fileSystemId String
    The ID of file system.
    fileSystemName String
    The name of file system.
    id String
    The ID of snapshot.
    isEncrypt Boolean
    Whether is encrypt.
    progress String
    The progress of snapshot.
    retentionDays Integer
    The retention days of snapshot.
    snapshotId String
    The ID of snapshot.
    snapshotName String
    The name of snapshot.
    snapshotType String
    The type of snapshot.
    sourceSize Integer
    The size of source.
    sourceVersion String
    The source version info.
    status String
    The status of snapshot.
    zoneId String
    The ID of zone.
    createTime string
    The create time of snapshot.
    description string
    The description of snapshot.
    fileSystemId string
    The ID of file system.
    fileSystemName string
    The name of file system.
    id string
    The ID of snapshot.
    isEncrypt boolean
    Whether is encrypt.
    progress string
    The progress of snapshot.
    retentionDays number
    The retention days of snapshot.
    snapshotId string
    The ID of snapshot.
    snapshotName string
    The name of snapshot.
    snapshotType string
    The type of snapshot.
    sourceSize number
    The size of source.
    sourceVersion string
    The source version info.
    status string
    The status of snapshot.
    zoneId string
    The ID of zone.
    create_time str
    The create time of snapshot.
    description str
    The description of snapshot.
    file_system_id str
    The ID of file system.
    file_system_name str
    The name of file system.
    id str
    The ID of snapshot.
    is_encrypt bool
    Whether is encrypt.
    progress str
    The progress of snapshot.
    retention_days int
    The retention days of snapshot.
    snapshot_id str
    The ID of snapshot.
    snapshot_name str
    The name of snapshot.
    snapshot_type str
    The type of snapshot.
    source_size int
    The size of source.
    source_version str
    The source version info.
    status str
    The status of snapshot.
    zone_id str
    The ID of zone.
    createTime String
    The create time of snapshot.
    description String
    The description of snapshot.
    fileSystemId String
    The ID of file system.
    fileSystemName String
    The name of file system.
    id String
    The ID of snapshot.
    isEncrypt Boolean
    Whether is encrypt.
    progress String
    The progress of snapshot.
    retentionDays Number
    The retention days of snapshot.
    snapshotId String
    The ID of snapshot.
    snapshotName String
    The name of snapshot.
    snapshotType String
    The type of snapshot.
    sourceSize Number
    The size of source.
    sourceVersion String
    The source version info.
    status String
    The status of snapshot.
    zoneId String
    The ID of zone.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate