volcenginecc.storageebs.getSnapshot

volcenginecc v0.0.32, Apr 23 26

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcenginecc

Using getSnapshot

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 getSnapshot(args: GetSnapshotArgs, opts?: InvokeOptions): Promise<GetSnapshotResult>
function getSnapshotOutput(args: GetSnapshotOutputArgs, opts?: InvokeOptions): Output<GetSnapshotResult>

def get_snapshot(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
def get_snapshot_output(id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetSnapshotResult]

func LookupSnapshot(ctx *Context, args *LookupSnapshotArgs, opts ...InvokeOption) (*LookupSnapshotResult, error)
func LookupSnapshotOutput(ctx *Context, args *LookupSnapshotOutputArgs, opts ...InvokeOption) LookupSnapshotResultOutput

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

public static class GetSnapshot 
{
    public static Task<GetSnapshotResult> InvokeAsync(GetSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
public static Output<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:storageebs/getSnapshot:getSnapshot
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Uniquely identifies the resource.

Id string: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

id string: Uniquely identifies the resource.

id str: Uniquely identifies the resource.

id String: Uniquely identifies the resource.

getSnapshot Result

The following output properties are available:

CreationTime string: Snapshot creation time.
Description string: Snapshot description. Default is empty. Length must be between 0 and 255 characters.
Id string: Uniquely identifies the resource.
ImageId string: Image ID
InstantAccess bool: Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
Progress int: Snapshot dump progress.
ProjectName string: Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
RetentionDays int: Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
Shared bool: Whether the snapshot is shared.
SnapshotGroupId string: Snapshot consistency group ID.
SnapshotId string: Snapshot ID.
SnapshotName string: Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
SnapshotType string: Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
Status string: Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
Tags List<Volcengine.GetSnapshotTag>: Snapshot tag information.
VolumeId string: Cloud disk ID associated with the snapshot.
VolumeKind string: Cloud disk category. Value options: system: system disk. data: data disk.
VolumeName string: Cloud disk name.
VolumeSize int: Cloud disk size, in GiB.
VolumeStatus string: Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
VolumeType string: Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
ZoneId string: Availability zone ID where the snapshot is located.

CreationTime string: Snapshot creation time.
Description string: Snapshot description. Default is empty. Length must be between 0 and 255 characters.
Id string: Uniquely identifies the resource.
ImageId string: Image ID
InstantAccess bool: Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
Progress int: Snapshot dump progress.
ProjectName string: Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
RetentionDays int: Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
Shared bool: Whether the snapshot is shared.
SnapshotGroupId string: Snapshot consistency group ID.
SnapshotId string: Snapshot ID.
SnapshotName string: Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
SnapshotType string: Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
Status string: Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
Tags []GetSnapshotTag: Snapshot tag information.
VolumeId string: Cloud disk ID associated with the snapshot.
VolumeKind string: Cloud disk category. Value options: system: system disk. data: data disk.
VolumeName string: Cloud disk name.
VolumeSize int: Cloud disk size, in GiB.
VolumeStatus string: Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
VolumeType string: Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
ZoneId string: Availability zone ID where the snapshot is located.

creationTime String: Snapshot creation time.
description String: Snapshot description. Default is empty. Length must be between 0 and 255 characters.
id String: Uniquely identifies the resource.
imageId String: Image ID
instantAccess Boolean: Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
progress Integer: Snapshot dump progress.
projectName String: Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
retentionDays Integer: Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
shared Boolean: Whether the snapshot is shared.
snapshotGroupId String: Snapshot consistency group ID.
snapshotId String: Snapshot ID.
snapshotName String: Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
snapshotType String: Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
status String: Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
tags List<GetSnapshotTag>: Snapshot tag information.
volumeId String: Cloud disk ID associated with the snapshot.
volumeKind String: Cloud disk category. Value options: system: system disk. data: data disk.
volumeName String: Cloud disk name.
volumeSize Integer: Cloud disk size, in GiB.
volumeStatus String: Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
volumeType String: Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
zoneId String: Availability zone ID where the snapshot is located.

creationTime string: Snapshot creation time.
description string: Snapshot description. Default is empty. Length must be between 0 and 255 characters.
id string: Uniquely identifies the resource.
imageId string: Image ID
instantAccess boolean: Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
progress number: Snapshot dump progress.
projectName string: Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
retentionDays number: Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
shared boolean: Whether the snapshot is shared.
snapshotGroupId string: Snapshot consistency group ID.
snapshotId string: Snapshot ID.
snapshotName string: Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
snapshotType string: Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
status string: Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
tags GetSnapshotTag[]: Snapshot tag information.
volumeId string: Cloud disk ID associated with the snapshot.
volumeKind string: Cloud disk category. Value options: system: system disk. data: data disk.
volumeName string: Cloud disk name.
volumeSize number: Cloud disk size, in GiB.
volumeStatus string: Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
volumeType string: Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
zoneId string: Availability zone ID where the snapshot is located.

creation_time str: Snapshot creation time.
description str: Snapshot description. Default is empty. Length must be between 0 and 255 characters.
id str: Uniquely identifies the resource.
image_id str: Image ID
instant_access bool: Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
progress int: Snapshot dump progress.
project_name str: Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
retention_days int: Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
shared bool: Whether the snapshot is shared.
snapshot_group_id str: Snapshot consistency group ID.
snapshot_id str: Snapshot ID.
snapshot_name str: Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
snapshot_type str: Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
status str: Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
tags Sequence[GetSnapshotTag]: Snapshot tag information.
volume_id str: Cloud disk ID associated with the snapshot.
volume_kind str: Cloud disk category. Value options: system: system disk. data: data disk.
volume_name str: Cloud disk name.
volume_size int: Cloud disk size, in GiB.
volume_status str: Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
volume_type str: Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
zone_id str: Availability zone ID where the snapshot is located.

creationTime String: Snapshot creation time.
description String: Snapshot description. Default is empty. Length must be between 0 and 255 characters.
id String: Uniquely identifies the resource.
imageId String: Image ID
instantAccess Boolean: Whether the snapshot has enabled ultra-fast availability. Value options: true: ultra-fast availability enabled. false: ultra-fast availability not enabled.
progress Number: Snapshot dump progress.
projectName String: Name of the Project to which the snapshot will be added. Note: snapshots do not inherit the project of the cloud disk, so snapshots and cloud disks can belong to different projects. If you do not set ProjectName when creating the snapshot, it will be added to the default project.
retentionDays Number: Snapshot retention period, in days. Value options: empty: retain snapshot permanently. 1~65536: specify retention days. Default is empty, which means retain snapshot permanently. Snapshot retention period is calculated from the snapshot creation time.
shared Boolean: Whether the snapshot is shared.
snapshotGroupId String: Snapshot consistency group ID.
snapshotId String: Snapshot ID.
snapshotName String: Name of the created snapshot. Naming rules: length must be between 1 and 128 characters. Only Chinese characters, letters, numbers, underscores (_), hyphens (-), and periods (.) are allowed. To avoid conflicts with automatic snapshot names, the name cannot start with 'auto'.
snapshotType String: Snapshot type. The available values are: user: query manual snapshots. auto: query automatic snapshots. share: query shared snapshots. By default, all snapshots are queried.
status String: Snapshot status. Value options: available: available. creating: creating. rollbacking: rolling back. deleted: deleted. failed: error.
tags List<Property Map>: Snapshot tag information.
volumeId String: Cloud disk ID associated with the snapshot.
volumeKind String: Cloud disk category. Value options: system: system disk. data: data disk.
volumeName String: Cloud disk name.
volumeSize Number: Cloud disk size, in GiB.
volumeStatus String: Cloud disk status. Value options: available: available, attaching: attaching, attached: attached, detaching: detaching, creating: creating, deleting: deleting, error: error, extending: expanding, "": cloud disk deleted.
volumeType String: Cloud disk type. Value options: ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification. ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification. TSSD_TL0: Throughput SSD cloud disk
zoneId String: Availability zone ID where the snapshot is located.

Supporting Types

GetSnapshotTag

Key string: User tag key added to the resource. Naming rules: Cannot start with volc: or sys: in any case. Keys starting with volc: or sys: are reserved system tag keys and cannot be created. Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
Value string: User tag value added to the resource. Naming rules: Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.

Key string: User tag key added to the resource. Naming rules: Cannot start with volc: or sys: in any case. Keys starting with volc: or sys: are reserved system tag keys and cannot be created. Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
Value string: User tag value added to the resource. Naming rules: Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.

key String: User tag key added to the resource. Naming rules: Cannot start with volc: or sys: in any case. Keys starting with volc: or sys: are reserved system tag keys and cannot be created. Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
value String: User tag value added to the resource. Naming rules: Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.

key string: User tag key added to the resource. Naming rules: Cannot start with volc: or sys: in any case. Keys starting with volc: or sys: are reserved system tag keys and cannot be created. Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
value string: User tag value added to the resource. Naming rules: Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.

key str: User tag key added to the resource. Naming rules: Cannot start with volc: or sys: in any case. Keys starting with volc: or sys: are reserved system tag keys and cannot be created. Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
value str: User tag value added to the resource. Naming rules: Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.

key String: User tag key added to the resource. Naming rules: Cannot start with volc: or sys: in any case. Keys starting with volc: or sys: are reserved system tag keys and cannot be created. Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Length must be between 1 and 128 characters.
value String: User tag value added to the resource. Naming rules: Only language characters, numbers, spaces, and the following English symbols are allowed: '_', '.', ':', '/', '=', '+', '-', '@'. Can be empty. Length must be between 0 and 256 characters.