volcenginecc v0.0.2, Oct 11 25

volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine

volcenginecc.ecs.getImage

volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine

Using getImage

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 getImage(args: GetImageArgs, opts?: InvokeOptions): Promise<GetImageResult>
function getImageOutput(args: GetImageOutputArgs, opts?: InvokeOptions): Output<GetImageResult>

def get_image(id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetImageResult
def get_image_output(id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetImageResult]

func LookupImage(ctx *Context, args *LookupImageArgs, opts ...InvokeOption) (*LookupImageResult, error)
func LookupImageOutput(ctx *Context, args *LookupImageOutputArgs, opts ...InvokeOption) LookupImageResultOutput

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

public static class GetImage 
{
    public static Task<GetImageResult> InvokeAsync(GetImageArgs args, InvokeOptions? opts = null)
    public static Output<GetImageResult> Invoke(GetImageInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)
public static Output<GetImageResult> getImage(GetImageArgs args, InvokeOptions options)

fn::invoke:
  function: volcenginecc:ecs/getImage:getImage
  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.

getImage Result

The following output properties are available:

Architecture string: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
BootMode string: 镜像的启动模式。可以选择BIOS、UEFI类型。
CreatedAt string: 镜像创建时间
Description string: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
DetectionResults Volcengine.GetImageDetectionResults: 镜像的检测结果。
Id string: Uniquely identifies the resource.
ImageId string: 镜像ID。
ImageName string: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
ImageOwnerId string: 镜像所属的账号ID。
InstanceId string: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
IsInstallRunCommandAgent bool: 镜像中是否安装了云助手Agent。
IsLts bool: 公共镜像是否长期维护。
IsSupportCloudInit bool: 镜像是否支持Cloud-init。
Kernel string: 镜像的内核版本。
LicenseType string: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
OsName string: 镜像操作系统的名称。
OsType string: 操作系统类型。
Platform string: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
PlatformVersion string: 镜像的发行版本。
ProjectName string: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
SharePermissions List<string>: 镜像共享的账户
ShareStatus string: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
Size int: 镜像大小，单位为GiB。
SnapshotGroupId string: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
SnapshotId string: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
Snapshots List<Volcengine.GetImageSnapshot>: 镜像关联快照的信息。
Status string: 镜像的状态。
Tags List<Volcengine.GetImageTag>: 镜像绑定的标签列表。
UpdatedAt string: 镜像更新时间
VirtualSize double: 镜像大小，单位为Byte。
Visibility string: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

Architecture string: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
BootMode string: 镜像的启动模式。可以选择BIOS、UEFI类型。
CreatedAt string: 镜像创建时间
Description string: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
DetectionResults GetImageDetectionResults: 镜像的检测结果。
Id string: Uniquely identifies the resource.
ImageId string: 镜像ID。
ImageName string: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
ImageOwnerId string: 镜像所属的账号ID。
InstanceId string: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
IsInstallRunCommandAgent bool: 镜像中是否安装了云助手Agent。
IsLts bool: 公共镜像是否长期维护。
IsSupportCloudInit bool: 镜像是否支持Cloud-init。
Kernel string: 镜像的内核版本。
LicenseType string: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
OsName string: 镜像操作系统的名称。
OsType string: 操作系统类型。
Platform string: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
PlatformVersion string: 镜像的发行版本。
ProjectName string: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
SharePermissions []string: 镜像共享的账户
ShareStatus string: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
Size int: 镜像大小，单位为GiB。
SnapshotGroupId string: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
SnapshotId string: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
Snapshots []GetImageSnapshot: 镜像关联快照的信息。
Status string: 镜像的状态。
Tags []GetImageTag: 镜像绑定的标签列表。
UpdatedAt string: 镜像更新时间
VirtualSize float64: 镜像大小，单位为Byte。
Visibility string: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

architecture String: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
bootMode String: 镜像的启动模式。可以选择BIOS、UEFI类型。
createdAt String: 镜像创建时间
description String: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
detectionResults GetImageDetectionResults: 镜像的检测结果。
id String: Uniquely identifies the resource.
imageId String: 镜像ID。
imageName String: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
imageOwnerId String: 镜像所属的账号ID。
instanceId String: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
isInstallRunCommandAgent Boolean: 镜像中是否安装了云助手Agent。
isLts Boolean: 公共镜像是否长期维护。
isSupportCloudInit Boolean: 镜像是否支持Cloud-init。
kernel String: 镜像的内核版本。
licenseType String: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
osName String: 镜像操作系统的名称。
osType String: 操作系统类型。
platform String: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
platformVersion String: 镜像的发行版本。
projectName String: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
sharePermissions List<String>: 镜像共享的账户
shareStatus String: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
size Integer: 镜像大小，单位为GiB。
snapshotGroupId String: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
snapshotId String: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
snapshots List<GetImageSnapshot>: 镜像关联快照的信息。
status String: 镜像的状态。
tags List<GetImageTag>: 镜像绑定的标签列表。
updatedAt String: 镜像更新时间
virtualSize Double: 镜像大小，单位为Byte。
visibility String: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

architecture string: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
bootMode string: 镜像的启动模式。可以选择BIOS、UEFI类型。
createdAt string: 镜像创建时间
description string: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
detectionResults GetImageDetectionResults: 镜像的检测结果。
id string: Uniquely identifies the resource.
imageId string: 镜像ID。
imageName string: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
imageOwnerId string: 镜像所属的账号ID。
instanceId string: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
isInstallRunCommandAgent boolean: 镜像中是否安装了云助手Agent。
isLts boolean: 公共镜像是否长期维护。
isSupportCloudInit boolean: 镜像是否支持Cloud-init。
kernel string: 镜像的内核版本。
licenseType string: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
osName string: 镜像操作系统的名称。
osType string: 操作系统类型。
platform string: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
platformVersion string: 镜像的发行版本。
projectName string: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
sharePermissions string[]: 镜像共享的账户
shareStatus string: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
size number: 镜像大小，单位为GiB。
snapshotGroupId string: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
snapshotId string: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
snapshots GetImageSnapshot[]: 镜像关联快照的信息。
status string: 镜像的状态。
tags GetImageTag[]: 镜像绑定的标签列表。
updatedAt string: 镜像更新时间
virtualSize number: 镜像大小，单位为Byte。
visibility string: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

architecture str: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
boot_mode str: 镜像的启动模式。可以选择BIOS、UEFI类型。
created_at str: 镜像创建时间
description str: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
detection_results GetImageDetectionResults: 镜像的检测结果。
id str: Uniquely identifies the resource.
image_id str: 镜像ID。
image_name str: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
image_owner_id str: 镜像所属的账号ID。
instance_id str: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
is_install_run_command_agent bool: 镜像中是否安装了云助手Agent。
is_lts bool: 公共镜像是否长期维护。
is_support_cloud_init bool: 镜像是否支持Cloud-init。
kernel str: 镜像的内核版本。
license_type str: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
os_name str: 镜像操作系统的名称。
os_type str: 操作系统类型。
platform str: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
platform_version str: 镜像的发行版本。
project_name str: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
share_permissions Sequence[str]: 镜像共享的账户
share_status str: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
size int: 镜像大小，单位为GiB。
snapshot_group_id str: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
snapshot_id str: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
snapshots Sequence[GetImageSnapshot]: 镜像关联快照的信息。
status str: 镜像的状态。
tags Sequence[GetImageTag]: 镜像绑定的标签列表。
updated_at str: 镜像更新时间
virtual_size float: 镜像大小，单位为Byte。
visibility str: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

architecture String: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
bootMode String: 镜像的启动模式。可以选择BIOS、UEFI类型。
createdAt String: 镜像创建时间
description String: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
detectionResults Property Map: 镜像的检测结果。
id String: Uniquely identifies the resource.
imageId String: 镜像ID。
imageName String: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
imageOwnerId String: 镜像所属的账号ID。
instanceId String: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
isInstallRunCommandAgent Boolean: 镜像中是否安装了云助手Agent。
isLts Boolean: 公共镜像是否长期维护。
isSupportCloudInit Boolean: 镜像是否支持Cloud-init。
kernel String: 镜像的内核版本。
licenseType String: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
osName String: 镜像操作系统的名称。
osType String: 操作系统类型。
platform String: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
platformVersion String: 镜像的发行版本。
projectName String: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
sharePermissions List<String>: 镜像共享的账户
shareStatus String: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
size Number: 镜像大小，单位为GiB。
snapshotGroupId String: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
snapshotId String: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
snapshots List<Property Map>: 镜像关联快照的信息。
status String: 镜像的状态。
tags List<Property Map>: 镜像绑定的标签列表。
updatedAt String: 镜像更新时间
virtualSize Number: 镜像大小，单位为Byte。
visibility String: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

Supporting Types

GetImageDetectionResults

DetectionStatus string: 检测状态。可以选择Finished（已完成）、Processing（处理中）类型。
Items List<Volcengine.GetImageDetectionResultsItem>: 镜像检测项详情。

DetectionStatus string: 检测状态。可以选择Finished（已完成）、Processing（处理中）类型。
Items []GetImageDetectionResultsItem: 镜像检测项详情。

detectionStatus String: 检测状态。可以选择Finished（已完成）、Processing（处理中）类型。
items List<GetImageDetectionResultsItem>: 镜像检测项详情。

detectionStatus string: 检测状态。可以选择Finished（已完成）、Processing（处理中）类型。
items GetImageDetectionResultsItem[]: 镜像检测项详情。

detection_status str: 检测状态。可以选择Finished（已完成）、Processing（处理中）类型。
items Sequence[GetImageDetectionResultsItem]: 镜像检测项详情。

detectionStatus String: 检测状态。可以选择Finished（已完成）、Processing（处理中）类型。
items List<Property Map>: 镜像检测项详情。

GetImageDetectionResultsItem

Name string: 检测项名称。
Result string: 该检测项对应结果。
RiskCode string: 风险描述码。
RiskLevel string: 风险等级。若该参数返回值为空，表示无风险。

Name string: 检测项名称。
Result string: 该检测项对应结果。
RiskCode string: 风险描述码。
RiskLevel string: 风险等级。若该参数返回值为空，表示无风险。

name String: 检测项名称。
result String: 该检测项对应结果。
riskCode String: 风险描述码。
riskLevel String: 风险等级。若该参数返回值为空，表示无风险。

name string: 检测项名称。
result string: 该检测项对应结果。
riskCode string: 风险描述码。
riskLevel string: 风险等级。若该参数返回值为空，表示无风险。

name str: 检测项名称。
result str: 该检测项对应结果。
risk_code str: 风险描述码。
risk_level str: 风险等级。若该参数返回值为空，表示无风险。

name String: 检测项名称。
result String: 该检测项对应结果。
riskCode String: 风险描述码。
riskLevel String: 风险等级。若该参数返回值为空，表示无风险。

GetImageSnapshot

Size int: 快照大小。单位为GiB。
SnapshotId string: 快照ID。
VolumeKind string: 云盘种类。system：系统盘。data：数据盘。

Size int: 快照大小。单位为GiB。
SnapshotId string: 快照ID。
VolumeKind string: 云盘种类。system：系统盘。data：数据盘。

size Integer: 快照大小。单位为GiB。
snapshotId String: 快照ID。
volumeKind String: 云盘种类。system：系统盘。data：数据盘。

size number: 快照大小。单位为GiB。
snapshotId string: 快照ID。
volumeKind string: 云盘种类。system：系统盘。data：数据盘。

size int: 快照大小。单位为GiB。
snapshot_id str: 快照ID。
volume_kind str: 云盘种类。system：系统盘。data：数据盘。

size Number: 快照大小。单位为GiB。
snapshotId String: 快照ID。
volumeKind String: 云盘种类。system：系统盘。data：数据盘。

GetImageTag

Key string: 镜像标签的标签键。
Value string: 镜像标签的值。

Key string: 镜像标签的标签键。
Value string: 镜像标签的值。

key String: 镜像标签的标签键。
value String: 镜像标签的值。

key string: 镜像标签的标签键。
value string: 镜像标签的值。

key str: 镜像标签的标签键。
value str: 镜像标签的值。

key String: 镜像标签的标签键。
value String: 镜像标签的值。

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine

volcengine/pulumi-volcenginecc

volcenginecc.ecs.getImage

On this page

On this page

Using getImage

getImage Result

Supporting Types

GetImageDetectionResults

GetImageDetectionResultsItem

GetImageSnapshot

GetImageTag

Package Details

On this page

On this page