Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
published on Thursday, Apr 23, 2026 by Volcengine
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
published on Thursday, Apr 23, 2026 by Volcengine
Data Source schema for Volcengine::ECS::Image
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 dictionaryThe 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
- Image architecture type. Options: amd64 (x86 compute), arm64 (ARM compute).
- Boot
Mode string - Image boot mode. You can select BIOS or UEFI
- Create
Whole boolImage - Whether to create a full instance image. Values: false: Default, do not create a full instance image. true: Create a full instance image.
- Created
At string - Image creation time
- Description string
- Image description. Must start with a letter or Chinese character. Can contain Chinese characters, letters, numbers, underscores "_", hyphens "-", equals signs "=", English commas ",", English periods ".", Chinese commas ",", Chinese periods "。", and spaces. Length: 0–255 characters. If left blank, defaults to empty.
- Detection
Results Volcengine.Get Image Detection Results - Image check result.
- Id string
- Uniquely identifies the resource.
- Image
Id string - Image ID
- Image
Name string - Image name. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods ".". Length: 1–128 characters
- Image
Owner stringId - Account ID to which the image belongs.
- Import
Image Volcengine.Get Image Import Image - Imported image information
- Instance
Id string - Instance ID. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.
- Is
Install boolRun Command Agent - Whether Cloud Assistant Agent is installed in the image
- Is
Lts bool - Whether the public image is maintained long-term.
- Is
Support boolCloud Init - Whether the image supports Cloud-init.
- Kernel string
- Image kernel version.
- License
Type string - Image license type. VolcanoEngine: Default, uses the official license based on your platform setting. BYOL: Bring Your Own License (BYOL)
- Need
Detection bool - Whether to perform image check. Values: true: Default, check enabled. false: Check disabled.
- Os
Name string - Name of the image operating system.
- Os
Type string - Operating system type
- Platform string
- Release version of the image operating system. Options: CentOS, Debian, veLinux, Windows Server, Fedora, OpenSUSE, Ubuntu.
- Platform
Version string - Image release version.
- Product
Code string - Product code for marketplace image
- Project
Name string - Project to which the resource belongs. If the API caller account only has permissions for certain projects, you must provide a project with the required permissions
- List<string>
- Accounts with which the image is shared
- string
- Image sharing status. HasShared: The custom image has been shared with other users. If the custom image is not shared or a public image is used, ShareStatus returns empty.
- Size int
- Image size, in GiB.
- Snapshot
Group stringId - Snapshot consistency group ID, used to create a custom image from a snapshot consistency group. One of Snapshot consistency group ID, SnapshotId, or InstanceId must be provided
- Snapshot
Id string - System disk snapshot ID, used to create a custom image from a system disk snapshot. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.
- Snapshots
List<Volcengine.
Get Image Snapshot> - Information about snapshots associated with the image.
- Status string
- Image status.
-
List<Volcengine.
Get Image Tag> - List of tags bound to the image.
- Updated
At string - Image update time
- Virtual
Size double - Image size, in Bytes.
- Visibility string
- Image visibility. public: Public image. private: Private image. shared: Shared image.
- Architecture string
- Image architecture type. Options: amd64 (x86 compute), arm64 (ARM compute).
- Boot
Mode string - Image boot mode. You can select BIOS or UEFI
- Create
Whole boolImage - Whether to create a full instance image. Values: false: Default, do not create a full instance image. true: Create a full instance image.
- Created
At string - Image creation time
- Description string
- Image description. Must start with a letter or Chinese character. Can contain Chinese characters, letters, numbers, underscores "_", hyphens "-", equals signs "=", English commas ",", English periods ".", Chinese commas ",", Chinese periods "。", and spaces. Length: 0–255 characters. If left blank, defaults to empty.
- Detection
Results GetImage Detection Results - Image check result.
- Id string
- Uniquely identifies the resource.
- Image
Id string - Image ID
- Image
Name string - Image name. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods ".". Length: 1–128 characters
- Image
Owner stringId - Account ID to which the image belongs.
- Import
Image GetImage Import Image - Imported image information
- Instance
Id string - Instance ID. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.
- Is
Install boolRun Command Agent - Whether Cloud Assistant Agent is installed in the image
- Is
Lts bool - Whether the public image is maintained long-term.
- Is
Support boolCloud Init - Whether the image supports Cloud-init.
- Kernel string
- Image kernel version.
- License
Type string - Image license type. VolcanoEngine: Default, uses the official license based on your platform setting. BYOL: Bring Your Own License (BYOL)
- Need
Detection bool - Whether to perform image check. Values: true: Default, check enabled. false: Check disabled.
- Os
Name string - Name of the image operating system.
- Os
Type string - Operating system type
- Platform string
- Release version of the image operating system. Options: CentOS, Debian, veLinux, Windows Server, Fedora, OpenSUSE, Ubuntu.
- Platform
Version string - Image release version.
- Product
Code string - Product code for marketplace image
- Project
Name string - Project to which the resource belongs. If the API caller account only has permissions for certain projects, you must provide a project with the required permissions
- []string
- Accounts with which the image is shared
- string
- Image sharing status. HasShared: The custom image has been shared with other users. If the custom image is not shared or a public image is used, ShareStatus returns empty.
- Size int
- Image size, in GiB.
- Snapshot
Group stringId - Snapshot consistency group ID, used to create a custom image from a snapshot consistency group. One of Snapshot consistency group ID, SnapshotId, or InstanceId must be provided
- Snapshot
Id string - System disk snapshot ID, used to create a custom image from a system disk snapshot. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.
- Snapshots
[]Get
Image Snapshot - Information about snapshots associated with the image.
- Status string
- Image status.
-
[]Get
Image Tag - List of tags bound to the image.
- Updated
At string - Image update time
- Virtual
Size float64 - Image size, in Bytes.
- Visibility string
- Image visibility. public: Public image. private: Private image. shared: Shared image.
- architecture String
- Image architecture type. Options: amd64 (x86 compute), arm64 (ARM compute).
- boot
Mode String - Image boot mode. You can select BIOS or UEFI
- create
Whole BooleanImage - Whether to create a full instance image. Values: false: Default, do not create a full instance image. true: Create a full instance image.
- created
At String - Image creation time
- description String
- Image description. Must start with a letter or Chinese character. Can contain Chinese characters, letters, numbers, underscores "_", hyphens "-", equals signs "=", English commas ",", English periods ".", Chinese commas ",", Chinese periods "。", and spaces. Length: 0–255 characters. If left blank, defaults to empty.
- detection
Results GetImage Detection Results - Image check result.
- id String
- Uniquely identifies the resource.
- image
Id String - Image ID
- image
Name String - Image name. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods ".". Length: 1–128 characters
- image
Owner StringId - Account ID to which the image belongs.
- import
Image GetImage Import Image - Imported image information
- instance
Id String - Instance ID. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.
- is
Install BooleanRun Command Agent - Whether Cloud Assistant Agent is installed in the image
- is
Lts Boolean - Whether the public image is maintained long-term.
- is
Support BooleanCloud Init - Whether the image supports Cloud-init.
- kernel String
- Image kernel version.
- license
Type String - Image license type. VolcanoEngine: Default, uses the official license based on your platform setting. BYOL: Bring Your Own License (BYOL)
- need
Detection Boolean - Whether to perform image check. Values: true: Default, check enabled. false: Check disabled.
- os
Name String - Name of the image operating system.
- os
Type String - Operating system type
- platform String
- Release version of the image operating system. Options: CentOS, Debian, veLinux, Windows Server, Fedora, OpenSUSE, Ubuntu.
- platform
Version String - Image release version.
- product
Code String - Product code for marketplace image
- project
Name String - Project to which the resource belongs. If the API caller account only has permissions for certain projects, you must provide a project with the required permissions
- List<String>
- Accounts with which the image is shared
- String
- Image sharing status. HasShared: The custom image has been shared with other users. If the custom image is not shared or a public image is used, ShareStatus returns empty.
- size Integer
- Image size, in GiB.
- snapshot
Group StringId - Snapshot consistency group ID, used to create a custom image from a snapshot consistency group. One of Snapshot consistency group ID, SnapshotId, or InstanceId must be provided
- snapshot
Id String - System disk snapshot ID, used to create a custom image from a system disk snapshot. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.
- snapshots
List<Get
Image Snapshot> - Information about snapshots associated with the image.
- status String
- Image status.
-
List<Get
Image Tag> - List of tags bound to the image.
- updated
At String - Image update time
- virtual
Size Double - Image size, in Bytes.
- visibility String
- Image visibility. public: Public image. private: Private image. shared: Shared image.
- architecture string
- Image architecture type. Options: amd64 (x86 compute), arm64 (ARM compute).
- boot
Mode string - Image boot mode. You can select BIOS or UEFI
- create
Whole booleanImage - Whether to create a full instance image. Values: false: Default, do not create a full instance image. true: Create a full instance image.
- created
At string - Image creation time
- description string
- Image description. Must start with a letter or Chinese character. Can contain Chinese characters, letters, numbers, underscores "_", hyphens "-", equals signs "=", English commas ",", English periods ".", Chinese commas ",", Chinese periods "。", and spaces. Length: 0–255 characters. If left blank, defaults to empty.
- detection
Results GetImage Detection Results - Image check result.
- id string
- Uniquely identifies the resource.
- image
Id string - Image ID
- image
Name string - Image name. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods ".". Length: 1–128 characters
- image
Owner stringId - Account ID to which the image belongs.
- import
Image GetImage Import Image - Imported image information
- instance
Id string - Instance ID. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.
- is
Install booleanRun Command Agent - Whether Cloud Assistant Agent is installed in the image
- is
Lts boolean - Whether the public image is maintained long-term.
- is
Support booleanCloud Init - Whether the image supports Cloud-init.
- kernel string
- Image kernel version.
- license
Type string - Image license type. VolcanoEngine: Default, uses the official license based on your platform setting. BYOL: Bring Your Own License (BYOL)
- need
Detection boolean - Whether to perform image check. Values: true: Default, check enabled. false: Check disabled.
- os
Name string - Name of the image operating system.
- os
Type string - Operating system type
- platform string
- Release version of the image operating system. Options: CentOS, Debian, veLinux, Windows Server, Fedora, OpenSUSE, Ubuntu.
- platform
Version string - Image release version.
- product
Code string - Product code for marketplace image
- project
Name string - Project to which the resource belongs. If the API caller account only has permissions for certain projects, you must provide a project with the required permissions
- string[]
- Accounts with which the image is shared
- string
- Image sharing status. HasShared: The custom image has been shared with other users. If the custom image is not shared or a public image is used, ShareStatus returns empty.
- size number
- Image size, in GiB.
- snapshot
Group stringId - Snapshot consistency group ID, used to create a custom image from a snapshot consistency group. One of Snapshot consistency group ID, SnapshotId, or InstanceId must be provided
- snapshot
Id string - System disk snapshot ID, used to create a custom image from a system disk snapshot. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.
- snapshots
Get
Image Snapshot[] - Information about snapshots associated with the image.
- status string
- Image status.
-
Get
Image Tag[] - List of tags bound to the image.
- updated
At string - Image update time
- virtual
Size number - Image size, in Bytes.
- visibility string
- Image visibility. public: Public image. private: Private image. shared: Shared image.
- architecture str
- Image architecture type. Options: amd64 (x86 compute), arm64 (ARM compute).
- boot_
mode str - Image boot mode. You can select BIOS or UEFI
- create_
whole_ boolimage - Whether to create a full instance image. Values: false: Default, do not create a full instance image. true: Create a full instance image.
- created_
at str - Image creation time
- description str
- Image description. Must start with a letter or Chinese character. Can contain Chinese characters, letters, numbers, underscores "_", hyphens "-", equals signs "=", English commas ",", English periods ".", Chinese commas ",", Chinese periods "。", and spaces. Length: 0–255 characters. If left blank, defaults to empty.
- detection_
results GetImage Detection Results - Image check result.
- id str
- Uniquely identifies the resource.
- image_
id str - Image ID
- image_
name str - Image name. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods ".". Length: 1–128 characters
- image_
owner_ strid - Account ID to which the image belongs.
- import_
image GetImage Import Image - Imported image information
- instance_
id str - Instance ID. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.
- is_
install_ boolrun_ command_ agent - Whether Cloud Assistant Agent is installed in the image
- is_
lts bool - Whether the public image is maintained long-term.
- is_
support_ boolcloud_ init - Whether the image supports Cloud-init.
- kernel str
- Image kernel version.
- license_
type str - Image license type. VolcanoEngine: Default, uses the official license based on your platform setting. BYOL: Bring Your Own License (BYOL)
- need_
detection bool - Whether to perform image check. Values: true: Default, check enabled. false: Check disabled.
- os_
name str - Name of the image operating system.
- os_
type str - Operating system type
- platform str
- Release version of the image operating system. Options: CentOS, Debian, veLinux, Windows Server, Fedora, OpenSUSE, Ubuntu.
- platform_
version str - Image release version.
- product_
code str - Product code for marketplace image
- project_
name str - Project to which the resource belongs. If the API caller account only has permissions for certain projects, you must provide a project with the required permissions
- Sequence[str]
- Accounts with which the image is shared
- str
- Image sharing status. HasShared: The custom image has been shared with other users. If the custom image is not shared or a public image is used, ShareStatus returns empty.
- size int
- Image size, in GiB.
- snapshot_
group_ strid - Snapshot consistency group ID, used to create a custom image from a snapshot consistency group. One of Snapshot consistency group ID, SnapshotId, or InstanceId must be provided
- snapshot_
id str - System disk snapshot ID, used to create a custom image from a system disk snapshot. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.
- snapshots
Sequence[Get
Image Snapshot] - Information about snapshots associated with the image.
- status str
- Image status.
-
Sequence[Get
Image Tag] - List of tags bound to the image.
- updated_
at str - Image update time
- virtual_
size float - Image size, in Bytes.
- visibility str
- Image visibility. public: Public image. private: Private image. shared: Shared image.
- architecture String
- Image architecture type. Options: amd64 (x86 compute), arm64 (ARM compute).
- boot
Mode String - Image boot mode. You can select BIOS or UEFI
- create
Whole BooleanImage - Whether to create a full instance image. Values: false: Default, do not create a full instance image. true: Create a full instance image.
- created
At String - Image creation time
- description String
- Image description. Must start with a letter or Chinese character. Can contain Chinese characters, letters, numbers, underscores "_", hyphens "-", equals signs "=", English commas ",", English periods ".", Chinese commas ",", Chinese periods "。", and spaces. Length: 0–255 characters. If left blank, defaults to empty.
- detection
Results Property Map - Image check result.
- id String
- Uniquely identifies the resource.
- image
Id String - Image ID
- image
Name String - Image name. Must start with a letter or Chinese character. Can only contain Chinese characters, letters, numbers, underscores "_", hyphens "-", and periods ".". Length: 1–128 characters
- image
Owner StringId - Account ID to which the image belongs.
- import
Image Property Map - Imported image information
- instance
Id String - Instance ID. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.
- is
Install BooleanRun Command Agent - Whether Cloud Assistant Agent is installed in the image
- is
Lts Boolean - Whether the public image is maintained long-term.
- is
Support BooleanCloud Init - Whether the image supports Cloud-init.
- kernel String
- Image kernel version.
- license
Type String - Image license type. VolcanoEngine: Default, uses the official license based on your platform setting. BYOL: Bring Your Own License (BYOL)
- need
Detection Boolean - Whether to perform image check. Values: true: Default, check enabled. false: Check disabled.
- os
Name String - Name of the image operating system.
- os
Type String - Operating system type
- platform String
- Release version of the image operating system. Options: CentOS, Debian, veLinux, Windows Server, Fedora, OpenSUSE, Ubuntu.
- platform
Version String - Image release version.
- product
Code String - Product code for marketplace image
- project
Name String - Project to which the resource belongs. If the API caller account only has permissions for certain projects, you must provide a project with the required permissions
- List<String>
- Accounts with which the image is shared
- String
- Image sharing status. HasShared: The custom image has been shared with other users. If the custom image is not shared or a public image is used, ShareStatus returns empty.
- size Number
- Image size, in GiB.
- snapshot
Group StringId - Snapshot consistency group ID, used to create a custom image from a snapshot consistency group. One of Snapshot consistency group ID, SnapshotId, or InstanceId must be provided
- snapshot
Id String - System disk snapshot ID, used to create a custom image from a system disk snapshot. You must specify one of InstanceId, SnapshotId, or SnapshotGroupId.
- snapshots List<Property Map>
- Information about snapshots associated with the image.
- status String
- Image status.
- List<Property Map>
- List of tags bound to the image.
- updated
At String - Image update time
- virtual
Size Number - Image size, in Bytes.
- visibility String
- Image visibility. public: Public image. private: Private image. shared: Shared image.
Supporting Types
GetImageDetectionResults
- Detection
Status string - Check status. Options: Finished (completed), Processing (in progress).
- Items
List<Volcengine.
Get Image Detection Results Item> - Details of image check items.
- Detection
Status string - Check status. Options: Finished (completed), Processing (in progress).
- Items
[]Get
Image Detection Results Item - Details of image check items.
- detection
Status String - Check status. Options: Finished (completed), Processing (in progress).
- items
List<Get
Image Detection Results Item> - Details of image check items.
- detection
Status string - Check status. Options: Finished (completed), Processing (in progress).
- items
Get
Image Detection Results Item[] - Details of image check items.
- detection_
status str - Check status. Options: Finished (completed), Processing (in progress).
- items
Sequence[Get
Image Detection Results Item] - Details of image check items.
- detection
Status String - Check status. Options: Finished (completed), Processing (in progress).
- items List<Property Map>
- Details of image check items.
GetImageDetectionResultsItem
- name str
- Check item name
- result str
- Result for this check item.
- risk_
code str - Risk description code
- risk_
level str - Risk level. If this parameter is empty, it means no risk
GetImageImportImage
- Import
Data List<string>Volumes - Data disk files included in the custom image, at the TOS bucket URL.
- Url string
- System disk files included in the custom image, at the TOS bucket URL.
- Import
Data []stringVolumes - Data disk files included in the custom image, at the TOS bucket URL.
- Url string
- System disk files included in the custom image, at the TOS bucket URL.
- import
Data List<String>Volumes - Data disk files included in the custom image, at the TOS bucket URL.
- url String
- System disk files included in the custom image, at the TOS bucket URL.
- import
Data string[]Volumes - Data disk files included in the custom image, at the TOS bucket URL.
- url string
- System disk files included in the custom image, at the TOS bucket URL.
- import_
data_ Sequence[str]volumes - Data disk files included in the custom image, at the TOS bucket URL.
- url str
- System disk files included in the custom image, at the TOS bucket URL.
- import
Data List<String>Volumes - Data disk files included in the custom image, at the TOS bucket URL.
- url String
- System disk files included in the custom image, at the TOS bucket URL.
GetImageSnapshot
- Size int
- Snapshot size (GiB)
- Snapshot
Id string - Snapshot ID
- Volume
Kind string - Cloud disk type. system: System disk. data: Data disk.
- Size int
- Snapshot size (GiB)
- Snapshot
Id string - Snapshot ID
- Volume
Kind string - Cloud disk type. system: System disk. data: Data disk.
- size Integer
- Snapshot size (GiB)
- snapshot
Id String - Snapshot ID
- volume
Kind String - Cloud disk type. system: System disk. data: Data disk.
- size number
- Snapshot size (GiB)
- snapshot
Id string - Snapshot ID
- volume
Kind string - Cloud disk type. system: System disk. data: Data disk.
- size int
- Snapshot size (GiB)
- snapshot_
id str - Snapshot ID
- volume_
kind str - Cloud disk type. system: System disk. data: Data disk.
- size Number
- Snapshot size (GiB)
- snapshot
Id String - Snapshot ID
- volume
Kind String - Cloud disk type. system: System disk. data: Data disk.
GetImageTag
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
published on Thursday, Apr 23, 2026 by Volcengine
