1. Packages
  2. Packages
  3. Gcore Provider
  4. API Docs
  5. getCloudVolumeSnapshot
Viewing docs for gcore 2.0.0-alpha.15
published on Thursday, Aug 6, 2026 by g-core
Viewing docs for gcore 2.0.0-alpha.15
published on Thursday, Aug 6, 2026 by g-core

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gcore from "@pulumi/gcore";
    
    const exampleCloudVolumeSnapshot = gcore.getCloudVolumeSnapshot({
        projectId: 1,
        regionId: 1,
        snapshotId: "726ecfcc-7fd0-4e30-a86e-7892524aa483",
    });
    
    import pulumi
    import pulumi_gcore as gcore
    
    example_cloud_volume_snapshot = gcore.get_cloud_volume_snapshot(project_id=1,
        region_id=1,
        snapshot_id="726ecfcc-7fd0-4e30-a86e-7892524aa483")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/v2/gcore"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := gcore.LookupCloudVolumeSnapshot(ctx, &gcore.LookupCloudVolumeSnapshotArgs{
    			ProjectId:  pulumi.Float64Ref(1),
    			RegionId:   pulumi.Float64Ref(1),
    			SnapshotId: pulumi.StringRef("726ecfcc-7fd0-4e30-a86e-7892524aa483"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcore = Pulumi.Gcore;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleCloudVolumeSnapshot = Gcore.GetCloudVolumeSnapshot.Invoke(new()
        {
            ProjectId = 1,
            RegionId = 1,
            SnapshotId = "726ecfcc-7fd0-4e30-a86e-7892524aa483",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcore.GcoreFunctions;
    import com.pulumi.gcore.inputs.GetCloudVolumeSnapshotArgs;
    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 exampleCloudVolumeSnapshot = GcoreFunctions.getCloudVolumeSnapshot(GetCloudVolumeSnapshotArgs.builder()
                .projectId(1)
                .regionId(1)
                .snapshotId("726ecfcc-7fd0-4e30-a86e-7892524aa483")
                .build());
    
        }
    }
    
    variables:
      exampleCloudVolumeSnapshot:
        fn::invoke:
          function: gcore:getCloudVolumeSnapshot
          arguments:
            projectId: 1
            regionId: 1
            snapshotId: 726ecfcc-7fd0-4e30-a86e-7892524aa483
    
    Example coming soon!
    

    Using getCloudVolumeSnapshot

    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 getCloudVolumeSnapshot(args: GetCloudVolumeSnapshotArgs, opts?: InvokeOptions): Promise<GetCloudVolumeSnapshotResult>
    function getCloudVolumeSnapshotOutput(args: GetCloudVolumeSnapshotOutputArgs, opts?: InvokeOptions): Output<GetCloudVolumeSnapshotResult>
    def get_cloud_volume_snapshot(find_one_by: Optional[GetCloudVolumeSnapshotFindOneBy] = None,
                                  project_id: Optional[float] = None,
                                  region_id: Optional[float] = None,
                                  snapshot_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetCloudVolumeSnapshotResult
    def get_cloud_volume_snapshot_output(find_one_by: pulumi.Input[Optional[GetCloudVolumeSnapshotFindOneByArgs]] = None,
                                  project_id: pulumi.Input[Optional[float]] = None,
                                  region_id: pulumi.Input[Optional[float]] = None,
                                  snapshot_id: pulumi.Input[Optional[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetCloudVolumeSnapshotResult]
    func LookupCloudVolumeSnapshot(ctx *Context, args *LookupCloudVolumeSnapshotArgs, opts ...InvokeOption) (*LookupCloudVolumeSnapshotResult, error)
    func LookupCloudVolumeSnapshotOutput(ctx *Context, args *LookupCloudVolumeSnapshotOutputArgs, opts ...InvokeOption) LookupCloudVolumeSnapshotResultOutput

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

    public static class GetCloudVolumeSnapshot 
    {
        public static Task<GetCloudVolumeSnapshotResult> InvokeAsync(GetCloudVolumeSnapshotArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudVolumeSnapshotResult> Invoke(GetCloudVolumeSnapshotInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCloudVolumeSnapshotResult> getCloudVolumeSnapshot(GetCloudVolumeSnapshotArgs args, InvokeOptions options)
    public static Output<GetCloudVolumeSnapshotResult> getCloudVolumeSnapshot(GetCloudVolumeSnapshotArgs args, InvokeOptions options)
    
    fn::invoke:
      function: gcore:index/getCloudVolumeSnapshot:getCloudVolumeSnapshot
      arguments:
        # arguments dictionary
    data "gcore_get_cloud_volume_snapshot" "name" {
        # arguments
    }

    The following arguments are supported:

    FindOneBy GetCloudVolumeSnapshotFindOneBy
    ProjectId double
    Project ID
    RegionId double
    Region ID
    SnapshotId string
    Unique identifier of the snapshot
    FindOneBy GetCloudVolumeSnapshotFindOneBy
    ProjectId float64
    Project ID
    RegionId float64
    Region ID
    SnapshotId string
    Unique identifier of the snapshot
    find_one_by object
    project_id number
    Project ID
    region_id number
    Region ID
    snapshot_id string
    Unique identifier of the snapshot
    findOneBy GetCloudVolumeSnapshotFindOneBy
    projectId Double
    Project ID
    regionId Double
    Region ID
    snapshotId String
    Unique identifier of the snapshot
    findOneBy GetCloudVolumeSnapshotFindOneBy
    projectId number
    Project ID
    regionId number
    Region ID
    snapshotId string
    Unique identifier of the snapshot
    find_one_by GetCloudVolumeSnapshotFindOneBy
    project_id float
    Project ID
    region_id float
    Region ID
    snapshot_id str
    Unique identifier of the snapshot
    findOneBy Property Map
    projectId Number
    Project ID
    regionId Number
    Region ID
    snapshotId String
    Unique identifier of the snapshot

    getCloudVolumeSnapshot Result

    The following output properties are available:

    CreatedAt string
    Datetime when the snapshot was created
    CreatorTaskId string
    Task that created this entity
    Description string
    Snapshot description
    Id string
    Unique identifier of the snapshot
    Name string
    Snapshot name
    Region string
    Region name
    Size double
    Snapshot size, GiB
    Status string
    Snapshot status Available values: "available", "backing-up", "creating", "deleted", "deleting", "error", "error_deleting", "restoring", "unmanaging".
    Tags List<GetCloudVolumeSnapshotTag>
    List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    TaskId string
    The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.
    UpdatedAt string
    Datetime when the snapshot was last updated
    VolumeId string
    ID of the volume this snapshot was made from
    FindOneBy GetCloudVolumeSnapshotFindOneBy
    ProjectId double
    Project ID
    RegionId double
    Region ID
    SnapshotId string
    Unique identifier of the snapshot
    CreatedAt string
    Datetime when the snapshot was created
    CreatorTaskId string
    Task that created this entity
    Description string
    Snapshot description
    Id string
    Unique identifier of the snapshot
    Name string
    Snapshot name
    Region string
    Region name
    Size float64
    Snapshot size, GiB
    Status string
    Snapshot status Available values: "available", "backing-up", "creating", "deleted", "deleting", "error", "error_deleting", "restoring", "unmanaging".
    Tags []GetCloudVolumeSnapshotTag
    List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    TaskId string
    The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.
    UpdatedAt string
    Datetime when the snapshot was last updated
    VolumeId string
    ID of the volume this snapshot was made from
    FindOneBy GetCloudVolumeSnapshotFindOneBy
    ProjectId float64
    Project ID
    RegionId float64
    Region ID
    SnapshotId string
    Unique identifier of the snapshot
    created_at string
    Datetime when the snapshot was created
    creator_task_id string
    Task that created this entity
    description string
    Snapshot description
    id string
    Unique identifier of the snapshot
    name string
    Snapshot name
    region string
    Region name
    size number
    Snapshot size, GiB
    status string
    Snapshot status Available values: "available", "backing-up", "creating", "deleted", "deleting", "error", "error_deleting", "restoring", "unmanaging".
    tags list(object)
    List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    task_id string
    The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.
    updated_at string
    Datetime when the snapshot was last updated
    volume_id string
    ID of the volume this snapshot was made from
    find_one_by object
    project_id number
    Project ID
    region_id number
    Region ID
    snapshot_id string
    Unique identifier of the snapshot
    createdAt String
    Datetime when the snapshot was created
    creatorTaskId String
    Task that created this entity
    description String
    Snapshot description
    id String
    Unique identifier of the snapshot
    name String
    Snapshot name
    region String
    Region name
    size Double
    Snapshot size, GiB
    status String
    Snapshot status Available values: "available", "backing-up", "creating", "deleted", "deleting", "error", "error_deleting", "restoring", "unmanaging".
    tags List<GetCloudVolumeSnapshotTag>
    List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    taskId String
    The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.
    updatedAt String
    Datetime when the snapshot was last updated
    volumeId String
    ID of the volume this snapshot was made from
    findOneBy GetCloudVolumeSnapshotFindOneBy
    projectId Double
    Project ID
    regionId Double
    Region ID
    snapshotId String
    Unique identifier of the snapshot
    createdAt string
    Datetime when the snapshot was created
    creatorTaskId string
    Task that created this entity
    description string
    Snapshot description
    id string
    Unique identifier of the snapshot
    name string
    Snapshot name
    region string
    Region name
    size number
    Snapshot size, GiB
    status string
    Snapshot status Available values: "available", "backing-up", "creating", "deleted", "deleting", "error", "error_deleting", "restoring", "unmanaging".
    tags GetCloudVolumeSnapshotTag[]
    List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    taskId string
    The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.
    updatedAt string
    Datetime when the snapshot was last updated
    volumeId string
    ID of the volume this snapshot was made from
    findOneBy GetCloudVolumeSnapshotFindOneBy
    projectId number
    Project ID
    regionId number
    Region ID
    snapshotId string
    Unique identifier of the snapshot
    created_at str
    Datetime when the snapshot was created
    creator_task_id str
    Task that created this entity
    description str
    Snapshot description
    id str
    Unique identifier of the snapshot
    name str
    Snapshot name
    region str
    Region name
    size float
    Snapshot size, GiB
    status str
    Snapshot status Available values: "available", "backing-up", "creating", "deleted", "deleting", "error", "error_deleting", "restoring", "unmanaging".
    tags Sequence[GetCloudVolumeSnapshotTag]
    List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    task_id str
    The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.
    updated_at str
    Datetime when the snapshot was last updated
    volume_id str
    ID of the volume this snapshot was made from
    find_one_by GetCloudVolumeSnapshotFindOneBy
    project_id float
    Project ID
    region_id float
    Region ID
    snapshot_id str
    Unique identifier of the snapshot
    createdAt String
    Datetime when the snapshot was created
    creatorTaskId String
    Task that created this entity
    description String
    Snapshot description
    id String
    Unique identifier of the snapshot
    name String
    Snapshot name
    region String
    Region name
    size Number
    Snapshot size, GiB
    status String
    Snapshot status Available values: "available", "backing-up", "creating", "deleted", "deleting", "error", "error_deleting", "restoring", "unmanaging".
    tags List<Property Map>
    List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    taskId String
    The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.
    updatedAt String
    Datetime when the snapshot was last updated
    volumeId String
    ID of the volume this snapshot was made from
    findOneBy Property Map
    projectId Number
    Project ID
    regionId Number
    Region ID
    snapshotId String
    Unique identifier of the snapshot

    Supporting Types

    GetCloudVolumeSnapshotFindOneBy

    InstanceId string
    Optional. Filter snapshots by the instance whose volumes were snapshotted
    LifecyclePolicyId double
    Optional. Filter by lifecycle policy ID
    ScheduleId string
    Optional. Filter by schedule ID
    VolumeId string
    Optional. Filter by volume ID
    InstanceId string
    Optional. Filter snapshots by the instance whose volumes were snapshotted
    LifecyclePolicyId float64
    Optional. Filter by lifecycle policy ID
    ScheduleId string
    Optional. Filter by schedule ID
    VolumeId string
    Optional. Filter by volume ID
    instance_id string
    Optional. Filter snapshots by the instance whose volumes were snapshotted
    lifecycle_policy_id number
    Optional. Filter by lifecycle policy ID
    schedule_id string
    Optional. Filter by schedule ID
    volume_id string
    Optional. Filter by volume ID
    instanceId String
    Optional. Filter snapshots by the instance whose volumes were snapshotted
    lifecyclePolicyId Double
    Optional. Filter by lifecycle policy ID
    scheduleId String
    Optional. Filter by schedule ID
    volumeId String
    Optional. Filter by volume ID
    instanceId string
    Optional. Filter snapshots by the instance whose volumes were snapshotted
    lifecyclePolicyId number
    Optional. Filter by lifecycle policy ID
    scheduleId string
    Optional. Filter by schedule ID
    volumeId string
    Optional. Filter by volume ID
    instance_id str
    Optional. Filter snapshots by the instance whose volumes were snapshotted
    lifecycle_policy_id float
    Optional. Filter by lifecycle policy ID
    schedule_id str
    Optional. Filter by schedule ID
    volume_id str
    Optional. Filter by volume ID
    instanceId String
    Optional. Filter snapshots by the instance whose volumes were snapshotted
    lifecyclePolicyId Number
    Optional. Filter by lifecycle policy ID
    scheduleId String
    Optional. Filter by schedule ID
    volumeId String
    Optional. Filter by volume ID

    GetCloudVolumeSnapshotTag

    Key string
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    ReadOnly bool
    If true, the tag is read-only and cannot be modified by the user
    Value string
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    Key string
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    ReadOnly bool
    If true, the tag is read-only and cannot be modified by the user
    Value string
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    key string
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    read_only bool
    If true, the tag is read-only and cannot be modified by the user
    value string
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    key String
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    readOnly Boolean
    If true, the tag is read-only and cannot be modified by the user
    value String
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    key string
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    readOnly boolean
    If true, the tag is read-only and cannot be modified by the user
    value string
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    key str
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    read_only bool
    If true, the tag is read-only and cannot be modified by the user
    value str
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    key String
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    readOnly Boolean
    If true, the tag is read-only and cannot be modified by the user
    value String
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    Viewing docs for gcore 2.0.0-alpha.15
    published on Thursday, Aug 6, 2026 by g-core

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial