1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. storageebs
  6. getSnapshotGroup
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

    Data Source schema for Volcengine::StorageEBS::SnapshotGroup

    Using getSnapshotGroup

    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 getSnapshotGroup(args: GetSnapshotGroupArgs, opts?: InvokeOptions): Promise<GetSnapshotGroupResult>
    function getSnapshotGroupOutput(args: GetSnapshotGroupOutputArgs, opts?: InvokeOptions): Output<GetSnapshotGroupResult>
    def get_snapshot_group(id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSnapshotGroupResult
    def get_snapshot_group_output(id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSnapshotGroupResult]
    func LookupSnapshotGroup(ctx *Context, args *LookupSnapshotGroupArgs, opts ...InvokeOption) (*LookupSnapshotGroupResult, error)
    func LookupSnapshotGroupOutput(ctx *Context, args *LookupSnapshotGroupOutputArgs, opts ...InvokeOption) LookupSnapshotGroupResultOutput

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

    public static class GetSnapshotGroup 
    {
        public static Task<GetSnapshotGroupResult> InvokeAsync(GetSnapshotGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetSnapshotGroupResult> Invoke(GetSnapshotGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSnapshotGroupResult> getSnapshotGroup(GetSnapshotGroupArgs args, InvokeOptions options)
    public static Output<GetSnapshotGroupResult> getSnapshotGroup(GetSnapshotGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcenginecc:storageebs/getSnapshotGroup:getSnapshotGroup
      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.

    getSnapshotGroup Result

    The following output properties are available:

    CreationTime string
    Snapshot consistency group creation time
    Description string
    Snapshot consistency group description
    Id string
    Uniquely identifies the resource.
    ImageId string
    Image ID of the snapshot consistency group
    InstanceId string
    ECS instance ID of the snapshot consistency group
    Name string
    Snapshot consistency group name
    ProjectName string
    Project name
    SnapshotGroupId string
    Snapshot consistency group ID
    Snapshots List<Volcengine.GetSnapshotGroupSnapshot>
    Snapshot details
    Status string
    Snapshot consistency group status
    Tags List<Volcengine.GetSnapshotGroupTag>
    Tags of the snapshot consistency group
    VolumeIds List<string>
    Cloud disk ID. Note: The cloud disk must be in 'attached' status. If multiple cloud disks are set, they must be attached to the same ECS instance
    CreationTime string
    Snapshot consistency group creation time
    Description string
    Snapshot consistency group description
    Id string
    Uniquely identifies the resource.
    ImageId string
    Image ID of the snapshot consistency group
    InstanceId string
    ECS instance ID of the snapshot consistency group
    Name string
    Snapshot consistency group name
    ProjectName string
    Project name
    SnapshotGroupId string
    Snapshot consistency group ID
    Snapshots []GetSnapshotGroupSnapshot
    Snapshot details
    Status string
    Snapshot consistency group status
    Tags []GetSnapshotGroupTag
    Tags of the snapshot consistency group
    VolumeIds []string
    Cloud disk ID. Note: The cloud disk must be in 'attached' status. If multiple cloud disks are set, they must be attached to the same ECS instance
    creationTime String
    Snapshot consistency group creation time
    description String
    Snapshot consistency group description
    id String
    Uniquely identifies the resource.
    imageId String
    Image ID of the snapshot consistency group
    instanceId String
    ECS instance ID of the snapshot consistency group
    name String
    Snapshot consistency group name
    projectName String
    Project name
    snapshotGroupId String
    Snapshot consistency group ID
    snapshots List<GetSnapshotGroupSnapshot>
    Snapshot details
    status String
    Snapshot consistency group status
    tags List<GetSnapshotGroupTag>
    Tags of the snapshot consistency group
    volumeIds List<String>
    Cloud disk ID. Note: The cloud disk must be in 'attached' status. If multiple cloud disks are set, they must be attached to the same ECS instance
    creationTime string
    Snapshot consistency group creation time
    description string
    Snapshot consistency group description
    id string
    Uniquely identifies the resource.
    imageId string
    Image ID of the snapshot consistency group
    instanceId string
    ECS instance ID of the snapshot consistency group
    name string
    Snapshot consistency group name
    projectName string
    Project name
    snapshotGroupId string
    Snapshot consistency group ID
    snapshots GetSnapshotGroupSnapshot[]
    Snapshot details
    status string
    Snapshot consistency group status
    tags GetSnapshotGroupTag[]
    Tags of the snapshot consistency group
    volumeIds string[]
    Cloud disk ID. Note: The cloud disk must be in 'attached' status. If multiple cloud disks are set, they must be attached to the same ECS instance
    creation_time str
    Snapshot consistency group creation time
    description str
    Snapshot consistency group description
    id str
    Uniquely identifies the resource.
    image_id str
    Image ID of the snapshot consistency group
    instance_id str
    ECS instance ID of the snapshot consistency group
    name str
    Snapshot consistency group name
    project_name str
    Project name
    snapshot_group_id str
    Snapshot consistency group ID
    snapshots Sequence[GetSnapshotGroupSnapshot]
    Snapshot details
    status str
    Snapshot consistency group status
    tags Sequence[GetSnapshotGroupTag]
    Tags of the snapshot consistency group
    volume_ids Sequence[str]
    Cloud disk ID. Note: The cloud disk must be in 'attached' status. If multiple cloud disks are set, they must be attached to the same ECS instance
    creationTime String
    Snapshot consistency group creation time
    description String
    Snapshot consistency group description
    id String
    Uniquely identifies the resource.
    imageId String
    Image ID of the snapshot consistency group
    instanceId String
    ECS instance ID of the snapshot consistency group
    name String
    Snapshot consistency group name
    projectName String
    Project name
    snapshotGroupId String
    Snapshot consistency group ID
    snapshots List<Property Map>
    Snapshot details
    status String
    Snapshot consistency group status
    tags List<Property Map>
    Tags of the snapshot consistency group
    volumeIds List<String>
    Cloud disk ID. Note: The cloud disk must be in 'attached' status. If multiple cloud disks are set, they must be attached to the same ECS instance

    Supporting Types

    GetSnapshotGroupSnapshot

    CreationTime string
    Snapshot creation time
    Description string
    Snapshot description
    ImageId string
    Image ID
    InstantAccess bool
    Whether the snapshot has enabled ultra-fast availability. Values are as follows: - true: Ultra-fast availability enabled - false: Ultra-fast availability not enabled
    Progress int
    Dump progress
    ProjectName string
    Project of the snapshot
    RetentionDays int
    Retention days for automatic snapshots
    Shared bool
    Whether the snapshot is shared with others. Values are as follows: - true: Snapshot is shared with others - false: Snapshot is not shared with others
    SnapshotGroupId string
    Snapshot consistency group ID
    SnapshotId string
    Snapshot ID
    SnapshotName string
    Snapshot name
    SnapshotType string
    Snapshot type. Values are as follows: - user: Manual snapshot - auto: Automatic snapshot
    Status string
    Snapshot status. Values are as follows: - available: Available - creating: Creating - rollbacking: Rolling back - deleted: Deleted - failed: Error
    Tags List<Volcengine.GetSnapshotGroupSnapshotTag>
    Tag information
    VolumeId string
    Cloud disk ID
    VolumeKind string
    Cloud disk category. Values are as follows: - system: System disk - data: Data disk
    VolumeName string
    Cloud disk name
    VolumeSize int
    Cloud disk size (GiB)
    VolumeStatus string
    Cloud disk status. Values are as follows: - available: Available - attaching: Attaching - attached: Attached - detaching: Detaching - creating: Creating - deleting: Deleting - error: Error - extending: Expanding
    VolumeType string
    Cloud disk type. Values are as follows: - ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification - ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification - TSSD_TL0: Throughput SSD cloud disk
    ZoneId string
    Zone ID. If ultra-fast availability is enabled for the snapshot, you can create a cloud disk in this zone using the ultra-fast available snapshot
    CreationTime string
    Snapshot creation time
    Description string
    Snapshot description
    ImageId string
    Image ID
    InstantAccess bool
    Whether the snapshot has enabled ultra-fast availability. Values are as follows: - true: Ultra-fast availability enabled - false: Ultra-fast availability not enabled
    Progress int
    Dump progress
    ProjectName string
    Project of the snapshot
    RetentionDays int
    Retention days for automatic snapshots
    Shared bool
    Whether the snapshot is shared with others. Values are as follows: - true: Snapshot is shared with others - false: Snapshot is not shared with others
    SnapshotGroupId string
    Snapshot consistency group ID
    SnapshotId string
    Snapshot ID
    SnapshotName string
    Snapshot name
    SnapshotType string
    Snapshot type. Values are as follows: - user: Manual snapshot - auto: Automatic snapshot
    Status string
    Snapshot status. Values are as follows: - available: Available - creating: Creating - rollbacking: Rolling back - deleted: Deleted - failed: Error
    Tags []GetSnapshotGroupSnapshotTag
    Tag information
    VolumeId string
    Cloud disk ID
    VolumeKind string
    Cloud disk category. Values are as follows: - system: System disk - data: Data disk
    VolumeName string
    Cloud disk name
    VolumeSize int
    Cloud disk size (GiB)
    VolumeStatus string
    Cloud disk status. Values are as follows: - available: Available - attaching: Attaching - attached: Attached - detaching: Detaching - creating: Creating - deleting: Deleting - error: Error - extending: Expanding
    VolumeType string
    Cloud disk type. Values are as follows: - ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification - ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification - TSSD_TL0: Throughput SSD cloud disk
    ZoneId string
    Zone ID. If ultra-fast availability is enabled for the snapshot, you can create a cloud disk in this zone using the ultra-fast available snapshot
    creationTime String
    Snapshot creation time
    description String
    Snapshot description
    imageId String
    Image ID
    instantAccess Boolean
    Whether the snapshot has enabled ultra-fast availability. Values are as follows: - true: Ultra-fast availability enabled - false: Ultra-fast availability not enabled
    progress Integer
    Dump progress
    projectName String
    Project of the snapshot
    retentionDays Integer
    Retention days for automatic snapshots
    shared Boolean
    Whether the snapshot is shared with others. Values are as follows: - true: Snapshot is shared with others - false: Snapshot is not shared with others
    snapshotGroupId String
    Snapshot consistency group ID
    snapshotId String
    Snapshot ID
    snapshotName String
    Snapshot name
    snapshotType String
    Snapshot type. Values are as follows: - user: Manual snapshot - auto: Automatic snapshot
    status String
    Snapshot status. Values are as follows: - available: Available - creating: Creating - rollbacking: Rolling back - deleted: Deleted - failed: Error
    tags List<GetSnapshotGroupSnapshotTag>
    Tag information
    volumeId String
    Cloud disk ID
    volumeKind String
    Cloud disk category. Values are as follows: - system: System disk - data: Data disk
    volumeName String
    Cloud disk name
    volumeSize Integer
    Cloud disk size (GiB)
    volumeStatus String
    Cloud disk status. Values are as follows: - available: Available - attaching: Attaching - attached: Attached - detaching: Detaching - creating: Creating - deleting: Deleting - error: Error - extending: Expanding
    volumeType String
    Cloud disk type. Values are as follows: - ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification - ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification - TSSD_TL0: Throughput SSD cloud disk
    zoneId String
    Zone ID. If ultra-fast availability is enabled for the snapshot, you can create a cloud disk in this zone using the ultra-fast available snapshot
    creationTime string
    Snapshot creation time
    description string
    Snapshot description
    imageId string
    Image ID
    instantAccess boolean
    Whether the snapshot has enabled ultra-fast availability. Values are as follows: - true: Ultra-fast availability enabled - false: Ultra-fast availability not enabled
    progress number
    Dump progress
    projectName string
    Project of the snapshot
    retentionDays number
    Retention days for automatic snapshots
    shared boolean
    Whether the snapshot is shared with others. Values are as follows: - true: Snapshot is shared with others - false: Snapshot is not shared with others
    snapshotGroupId string
    Snapshot consistency group ID
    snapshotId string
    Snapshot ID
    snapshotName string
    Snapshot name
    snapshotType string
    Snapshot type. Values are as follows: - user: Manual snapshot - auto: Automatic snapshot
    status string
    Snapshot status. Values are as follows: - available: Available - creating: Creating - rollbacking: Rolling back - deleted: Deleted - failed: Error
    tags GetSnapshotGroupSnapshotTag[]
    Tag information
    volumeId string
    Cloud disk ID
    volumeKind string
    Cloud disk category. Values are as follows: - system: System disk - data: Data disk
    volumeName string
    Cloud disk name
    volumeSize number
    Cloud disk size (GiB)
    volumeStatus string
    Cloud disk status. Values are as follows: - available: Available - attaching: Attaching - attached: Attached - detaching: Detaching - creating: Creating - deleting: Deleting - error: Error - extending: Expanding
    volumeType string
    Cloud disk type. Values are as follows: - ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification - ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification - TSSD_TL0: Throughput SSD cloud disk
    zoneId string
    Zone ID. If ultra-fast availability is enabled for the snapshot, you can create a cloud disk in this zone using the ultra-fast available snapshot
    creation_time str
    Snapshot creation time
    description str
    Snapshot description
    image_id str
    Image ID
    instant_access bool
    Whether the snapshot has enabled ultra-fast availability. Values are as follows: - true: Ultra-fast availability enabled - false: Ultra-fast availability not enabled
    progress int
    Dump progress
    project_name str
    Project of the snapshot
    retention_days int
    Retention days for automatic snapshots
    shared bool
    Whether the snapshot is shared with others. Values are as follows: - true: Snapshot is shared with others - false: Snapshot is not shared with others
    snapshot_group_id str
    Snapshot consistency group ID
    snapshot_id str
    Snapshot ID
    snapshot_name str
    Snapshot name
    snapshot_type str
    Snapshot type. Values are as follows: - user: Manual snapshot - auto: Automatic snapshot
    status str
    Snapshot status. Values are as follows: - available: Available - creating: Creating - rollbacking: Rolling back - deleted: Deleted - failed: Error
    tags Sequence[GetSnapshotGroupSnapshotTag]
    Tag information
    volume_id str
    Cloud disk ID
    volume_kind str
    Cloud disk category. Values are as follows: - system: System disk - data: Data disk
    volume_name str
    Cloud disk name
    volume_size int
    Cloud disk size (GiB)
    volume_status str
    Cloud disk status. Values are as follows: - available: Available - attaching: Attaching - attached: Attached - detaching: Detaching - creating: Creating - deleting: Deleting - error: Error - extending: Expanding
    volume_type str
    Cloud disk type. Values are as follows: - 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
    Zone ID. If ultra-fast availability is enabled for the snapshot, you can create a cloud disk in this zone using the ultra-fast available snapshot
    creationTime String
    Snapshot creation time
    description String
    Snapshot description
    imageId String
    Image ID
    instantAccess Boolean
    Whether the snapshot has enabled ultra-fast availability. Values are as follows: - true: Ultra-fast availability enabled - false: Ultra-fast availability not enabled
    progress Number
    Dump progress
    projectName String
    Project of the snapshot
    retentionDays Number
    Retention days for automatic snapshots
    shared Boolean
    Whether the snapshot is shared with others. Values are as follows: - true: Snapshot is shared with others - false: Snapshot is not shared with others
    snapshotGroupId String
    Snapshot consistency group ID
    snapshotId String
    Snapshot ID
    snapshotName String
    Snapshot name
    snapshotType String
    Snapshot type. Values are as follows: - user: Manual snapshot - auto: Automatic snapshot
    status String
    Snapshot status. Values are as follows: - available: Available - creating: Creating - rollbacking: Rolling back - deleted: Deleted - failed: Error
    tags List<Property Map>
    Tag information
    volumeId String
    Cloud disk ID
    volumeKind String
    Cloud disk category. Values are as follows: - system: System disk - data: Data disk
    volumeName String
    Cloud disk name
    volumeSize Number
    Cloud disk size (GiB)
    volumeStatus String
    Cloud disk status. Values are as follows: - available: Available - attaching: Attaching - attached: Attached - detaching: Detaching - creating: Creating - deleting: Deleting - error: Error - extending: Expanding
    volumeType String
    Cloud disk type. Values are as follows: - ESSDPL0: Ultra-fast SSD cloud disk, PL0 specification - ESSDFlexPL: Ultra-fast SSD cloud disk, FlexPL specification - TSSD_TL0: Throughput SSD cloud disk
    zoneId String
    Zone ID. If ultra-fast availability is enabled for the snapshot, you can create a cloud disk in this zone using the ultra-fast available snapshot

    GetSnapshotGroupSnapshotTag

    Key string
    Tag key
    Value string
    Tag value
    Key string
    Tag key
    Value string
    Tag value
    key String
    Tag key
    value String
    Tag value
    key string
    Tag key
    value string
    Tag value
    key str
    Tag key
    value str
    Tag value
    key String
    Tag key
    value String
    Tag value

    GetSnapshotGroupTag

    Key string
    Tag key
    Value string
    Tag value
    Key string
    Tag key
    Value string
    Tag value
    key String
    Tag key
    value String
    Tag value
    key string
    Tag key
    value string
    Tag value
    key str
    Tag key
    value str
    Tag value
    key String
    Tag key
    value String
    Tag value

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.