bytepluscc.storageebs.getSnapshot

bytepluscc v0.0.16, Mar 9 26

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus

Schema (JSON)

byteplus-sdk/pulumi-bytepluscc

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: bytepluscc: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: 快照创建时间。
Description string: 快照描述信息，默认为空，长度限制为0~255个字符。
Id string: Uniquely identifies the resource.
ImageId string: 镜像ID
InstantAccess bool: 快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
Progress int: 快照转储进度。
ProjectName string: 快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
RetentionDays int: 快照保留时间，单位为天，取值说明如下：空：永久保留快照。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
Shared bool: 快照是否共享。
SnapshotGroupId string: 快照一致性组ID。
SnapshotId string: 快照ID。
SnapshotName string: 创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
SnapshotType string: 快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
Status string: 快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
Tags List<Byteplus.GetSnapshotTag>: 快照的标签信息。
VolumeId string: 快照相关的云盘ID。
VolumeKind string: 云盘种类，取值说明如下：system：系统盘。data：数据盘。
VolumeName string: 云盘名称。
VolumeSize int: 云盘大小，单位为GiB。
VolumeStatus string: 云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
VolumeType string: 云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
ZoneId string: 快照所在的可用区ID。

CreationTime string: 快照创建时间。
Description string: 快照描述信息，默认为空，长度限制为0~255个字符。
Id string: Uniquely identifies the resource.
ImageId string: 镜像ID
InstantAccess bool: 快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
Progress int: 快照转储进度。
ProjectName string: 快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
RetentionDays int: 快照保留时间，单位为天，取值说明如下：空：永久保留快照。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
Shared bool: 快照是否共享。
SnapshotGroupId string: 快照一致性组ID。
SnapshotId string: 快照ID。
SnapshotName string: 创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
SnapshotType string: 快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
Status string: 快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
Tags []GetSnapshotTag: 快照的标签信息。
VolumeId string: 快照相关的云盘ID。
VolumeKind string: 云盘种类，取值说明如下：system：系统盘。data：数据盘。
VolumeName string: 云盘名称。
VolumeSize int: 云盘大小，单位为GiB。
VolumeStatus string: 云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
VolumeType string: 云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
ZoneId string: 快照所在的可用区ID。

creationTime String: 快照创建时间。
description String: 快照描述信息，默认为空，长度限制为0~255个字符。
id String: Uniquely identifies the resource.
imageId String: 镜像ID
instantAccess Boolean: 快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
progress Integer: 快照转储进度。
projectName String: 快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
retentionDays Integer: 快照保留时间，单位为天，取值说明如下：空：永久保留快照。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
shared Boolean: 快照是否共享。
snapshotGroupId String: 快照一致性组ID。
snapshotId String: 快照ID。
snapshotName String: 创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
snapshotType String: 快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
status String: 快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
tags List<GetSnapshotTag>: 快照的标签信息。
volumeId String: 快照相关的云盘ID。
volumeKind String: 云盘种类，取值说明如下：system：系统盘。data：数据盘。
volumeName String: 云盘名称。
volumeSize Integer: 云盘大小，单位为GiB。
volumeStatus String: 云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
volumeType String: 云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
zoneId String: 快照所在的可用区ID。

creationTime string: 快照创建时间。
description string: 快照描述信息，默认为空，长度限制为0~255个字符。
id string: Uniquely identifies the resource.
imageId string: 镜像ID
instantAccess boolean: 快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
progress number: 快照转储进度。
projectName string: 快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
retentionDays number: 快照保留时间，单位为天，取值说明如下：空：永久保留快照。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
shared boolean: 快照是否共享。
snapshotGroupId string: 快照一致性组ID。
snapshotId string: 快照ID。
snapshotName string: 创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
snapshotType string: 快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
status string: 快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
tags GetSnapshotTag[]: 快照的标签信息。
volumeId string: 快照相关的云盘ID。
volumeKind string: 云盘种类，取值说明如下：system：系统盘。data：数据盘。
volumeName string: 云盘名称。
volumeSize number: 云盘大小，单位为GiB。
volumeStatus string: 云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
volumeType string: 云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
zoneId string: 快照所在的可用区ID。

creation_time str: 快照创建时间。
description str: 快照描述信息，默认为空，长度限制为0~255个字符。
id str: Uniquely identifies the resource.
image_id str: 镜像ID
instant_access bool: 快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
progress int: 快照转储进度。
project_name str: 快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
retention_days int: 快照保留时间，单位为天，取值说明如下：空：永久保留快照。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
shared bool: 快照是否共享。
snapshot_group_id str: 快照一致性组ID。
snapshot_id str: 快照ID。
snapshot_name str: 创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
snapshot_type str: 快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
status str: 快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
tags Sequence[GetSnapshotTag]: 快照的标签信息。
volume_id str: 快照相关的云盘ID。
volume_kind str: 云盘种类，取值说明如下：system：系统盘。data：数据盘。
volume_name str: 云盘名称。
volume_size int: 云盘大小，单位为GiB。
volume_status str: 云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
volume_type str: 云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
zone_id str: 快照所在的可用区ID。

creationTime String: 快照创建时间。
description String: 快照描述信息，默认为空，长度限制为0~255个字符。
id String: Uniquely identifies the resource.
imageId String: 镜像ID
instantAccess Boolean: 快照是否开启极速可用能力，取值说明如下：true：已开启极速可用能力。false：未开启极速可用能力。
progress Number: 快照转储进度。
projectName String: 快照所要加入的Project（项目）名称。注意快照不会继承云盘的项目，即快照与云盘可以所属不同的项目。如果您在创建快照时未设置ProjectName，快照会默认加入default项目。
retentionDays Number: 快照保留时间，单位为天，取值说明如下：空：永久保留快照。1~65536：指定保存天数。默认为空，即默认永久保留快照。说明快照保留时间从快照创建时刻开始计算。
shared Boolean: 快照是否共享。
snapshotGroupId String: 快照一致性组ID。
snapshotId String: 快照ID。
snapshotName String: 创建的快照名称。命名规范如下：长度限制为1~128个字符。只能包含中文、字母、数字、下划线（_）、中划线（-）和英文句号（.）。为防止和自动快照的名称冲突，不能以“auto”开头。
snapshotType String: 快照类型，取值说明如下：user：查询手动快照。auto：查询自动快照。share：查询共享快照。默认查询所有快照。
status String: 快照状态，取值说明如下：available：可用。creating：创建中。rollbacking：回滚中。deleted：已删除。failed：错误。
tags List<Property Map>: 快照的标签信息。
volumeId String: 快照相关的云盘ID。
volumeKind String: 云盘种类，取值说明如下：system：系统盘。data：数据盘。
volumeName String: 云盘名称。
volumeSize Number: 云盘大小，单位为GiB。
volumeStatus String: 云盘状态，取值说明如下：available：可用, attaching：挂载中, attached：已挂载, detaching：卸载中, creating：创建中, deleting：删除中, error：错误, extending：扩容中, ""：云盘被删除。
volumeType String: 云盘类型，取值说明如下：ESSDPL0：极速型SSD云盘，PL0规格。ESSDFlexPL：极速型SSD云盘，FlexPL规格。TSSD_TL0：吞吐型SSD云盘
zoneId String: 快照所在的可用区ID。

Supporting Types

GetSnapshotTag

Key string: 为资源添加的用户标签的标签键。命名规则如下：不能以任何大小写形式的volc:或sys:开头。volc:或sys:开头为系统预留标签键禁止创建。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
Value string: 为资源添加的用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。

Key string: 为资源添加的用户标签的标签键。命名规则如下：不能以任何大小写形式的volc:或sys:开头。volc:或sys:开头为系统预留标签键禁止创建。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
Value string: 为资源添加的用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。

key String: 为资源添加的用户标签的标签键。命名规则如下：不能以任何大小写形式的volc:或sys:开头。volc:或sys:开头为系统预留标签键禁止创建。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
value String: 为资源添加的用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。

key string: 为资源添加的用户标签的标签键。命名规则如下：不能以任何大小写形式的volc:或sys:开头。volc:或sys:开头为系统预留标签键禁止创建。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
value string: 为资源添加的用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。

key str: 为资源添加的用户标签的标签键。命名规则如下：不能以任何大小写形式的volc:或sys:开头。volc:或sys:开头为系统预留标签键禁止创建。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
value str: 为资源添加的用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。

key String: 为资源添加的用户标签的标签键。命名规则如下：不能以任何大小写形式的volc:或sys:开头。volc:或sys:开头为系统预留标签键禁止创建。只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。长度限制在1～128个字符之间。
value String: 为资源添加的用户标签的标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号“_”、“.”、“:”、“/”、“=”、“+”、“-”、“@”。允许为空，长度限制在0～256个字符之间。