1. Packages
  2. Volcengine
  3. API Docs
  4. ecs
  5. getImages
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

volcengine.ecs.getImages

volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
Schema (JSON)
volcengine/pulumi-volcengine

    Use this data source to query detailed information of images

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@pulumi/volcengine";

const foo = volcengine.ecs.getImages({
    instanceTypeId: "ecs.g1.large",
    osType: "Linux",
    visibility: "public",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.ecs.get_images(instance_type_id="ecs.g1.large",
    os_type="Linux",
    visibility="public")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/ecs"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ecs.GetImages(ctx, &ecs.GetImagesArgs{
			InstanceTypeId: pulumi.StringRef("ecs.g1.large"),
			OsType:         pulumi.StringRef("Linux"),
			Visibility:     pulumi.StringRef("public"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = Volcengine.Ecs.GetImages.Invoke(new()
    {
        InstanceTypeId = "ecs.g1.large",
        OsType = "Linux",
        Visibility = "public",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.ecs.EcsFunctions;
import com.pulumi.volcengine.ecs.inputs.GetImagesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var foo = EcsFunctions.getImages(GetImagesArgs.builder()
            .instanceTypeId("ecs.g1.large")
            .osType("Linux")
            .visibility("public")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:ecs:getImages
      Arguments:
        instanceTypeId: ecs.g1.large
        osType: Linux
        visibility: public

    Using getImages

    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 getImages(args: GetImagesArgs, opts?: InvokeOptions): Promise<GetImagesResult>
function getImagesOutput(args: GetImagesOutputArgs, opts?: InvokeOptions): Output<GetImagesResult>
    def get_images(ids: Optional[Sequence[str]] = None,
               image_name: Optional[str] = None,
               instance_type_id: Optional[str] = None,
               is_support_cloud_init: Optional[bool] = None,
               is_tls: Optional[bool] = None,
               name_regex: Optional[str] = None,
               os_type: Optional[str] = None,
               output_file: Optional[str] = None,
               platform: Optional[str] = None,
               statuses: Optional[Sequence[str]] = None,
               tags: Optional[Sequence[GetImagesTag]] = None,
               visibility: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetImagesResult
def get_images_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               image_name: Optional[pulumi.Input[str]] = None,
               instance_type_id: Optional[pulumi.Input[str]] = None,
               is_support_cloud_init: Optional[pulumi.Input[bool]] = None,
               is_tls: Optional[pulumi.Input[bool]] = None,
               name_regex: Optional[pulumi.Input[str]] = None,
               os_type: Optional[pulumi.Input[str]] = None,
               output_file: Optional[pulumi.Input[str]] = None,
               platform: Optional[pulumi.Input[str]] = None,
               statuses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetImagesTagArgs]]]] = None,
               visibility: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetImagesResult]
    func GetImages(ctx *Context, args *GetImagesArgs, opts ...InvokeOption) (*GetImagesResult, error)
func GetImagesOutput(ctx *Context, args *GetImagesOutputArgs, opts ...InvokeOption) GetImagesResultOutput

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

    public static class GetImages 
{
    public static Task<GetImagesResult> InvokeAsync(GetImagesArgs args, InvokeOptions? opts = null)
    public static Output<GetImagesResult> Invoke(GetImagesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetImagesResult> getImages(GetImagesArgs args, InvokeOptions options)
public static Output<GetImagesResult> getImages(GetImagesArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:ecs/getImages:getImages
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Ids List<string>
    A list of Image IDs.
    ImageName string
    The name of Image.
    InstanceTypeId string
    The specification of Instance.
    IsSupportCloudInit bool
    Whether the Image support cloud-init.
    IsTls bool
    Whether the Image maintained for a long time.
    NameRegex string
    A Name Regex of Image.
    OsType string
    The operating system type of Image.
    OutputFile string
    File name where to save data source results.
    Platform string
    The platform of Image.
    Statuses List<string>
    A list of Image status, the value can be available or creating or error.
    Tags List<GetImagesTag>
    Tags.
    Visibility string
    The visibility of Image.
    Ids []string
    A list of Image IDs.
    ImageName string
    The name of Image.
    InstanceTypeId string
    The specification of Instance.
    IsSupportCloudInit bool
    Whether the Image support cloud-init.
    IsTls bool
    Whether the Image maintained for a long time.
    NameRegex string
    A Name Regex of Image.
    OsType string
    The operating system type of Image.
    OutputFile string
    File name where to save data source results.
    Platform string
    The platform of Image.
    Statuses []string
    A list of Image status, the value can be available or creating or error.
    Tags []GetImagesTag
    Tags.
    Visibility string
    The visibility of Image.
    ids List<String>
    A list of Image IDs.
    imageName String
    The name of Image.
    instanceTypeId String
    The specification of Instance.
    isSupportCloudInit Boolean
    Whether the Image support cloud-init.
    isTls Boolean
    Whether the Image maintained for a long time.
    nameRegex String
    A Name Regex of Image.
    osType String
    The operating system type of Image.
    outputFile String
    File name where to save data source results.
    platform String
    The platform of Image.
    statuses List<String>
    A list of Image status, the value can be available or creating or error.
    tags List<GetImagesTag>
    Tags.
    visibility String
    The visibility of Image.
    ids string[]
    A list of Image IDs.
    imageName string
    The name of Image.
    instanceTypeId string
    The specification of Instance.
    isSupportCloudInit boolean
    Whether the Image support cloud-init.
    isTls boolean
    Whether the Image maintained for a long time.
    nameRegex string
    A Name Regex of Image.
    osType string
    The operating system type of Image.
    outputFile string
    File name where to save data source results.
    platform string
    The platform of Image.
    statuses string[]
    A list of Image status, the value can be available or creating or error.
    tags GetImagesTag[]
    Tags.
    visibility string
    The visibility of Image.
    ids Sequence[str]
    A list of Image IDs.
    image_name str
    The name of Image.
    instance_type_id str
    The specification of Instance.
    is_support_cloud_init bool
    Whether the Image support cloud-init.
    is_tls bool
    Whether the Image maintained for a long time.
    name_regex str
    A Name Regex of Image.
    os_type str
    The operating system type of Image.
    output_file str
    File name where to save data source results.
    platform str
    The platform of Image.
    statuses Sequence[str]
    A list of Image status, the value can be available or creating or error.
    tags Sequence[GetImagesTag]
    Tags.
    visibility str
    The visibility of Image.
    ids List<String>
    A list of Image IDs.
    imageName String
    The name of Image.
    instanceTypeId String
    The specification of Instance.
    isSupportCloudInit Boolean
    Whether the Image support cloud-init.
    isTls Boolean
    Whether the Image maintained for a long time.
    nameRegex String
    A Name Regex of Image.
    osType String
    The operating system type of Image.
    outputFile String
    File name where to save data source results.
    platform String
    The platform of Image.
    statuses List<String>
    A list of Image status, the value can be available or creating or error.
    tags List<Property Map>
    Tags.
    visibility String
    The visibility of Image.

    getImages Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Images List<GetImagesImage>
    The collection of Image query.
    TotalCount int
    The total count of Image query.
    Ids List<string>
    ImageName string
    The name of Image.
    InstanceTypeId string
    IsSupportCloudInit bool
    Whether the Image support cloud-init.
    IsTls bool
    NameRegex string
    OsType string
    The operating system type of Image.
    OutputFile string
    Platform string
    The platform of Image.
    Statuses List<string>
    The status of Image.
    Tags List<GetImagesTag>
    Tags.
    Visibility string
    The visibility of Image.
    Id string
    The provider-assigned unique ID for this managed resource.
    Images []GetImagesImage
    The collection of Image query.
    TotalCount int
    The total count of Image query.
    Ids []string
    ImageName string
    The name of Image.
    InstanceTypeId string
    IsSupportCloudInit bool
    Whether the Image support cloud-init.
    IsTls bool
    NameRegex string
    OsType string
    The operating system type of Image.
    OutputFile string
    Platform string
    The platform of Image.
    Statuses []string
    The status of Image.
    Tags []GetImagesTag
    Tags.
    Visibility string
    The visibility of Image.
    id String
    The provider-assigned unique ID for this managed resource.
    images List<GetImagesImage>
    The collection of Image query.
    totalCount Integer
    The total count of Image query.
    ids List<String>
    imageName String
    The name of Image.
    instanceTypeId String
    isSupportCloudInit Boolean
    Whether the Image support cloud-init.
    isTls Boolean
    nameRegex String
    osType String
    The operating system type of Image.
    outputFile String
    platform String
    The platform of Image.
    statuses List<String>
    The status of Image.
    tags List<GetImagesTag>
    Tags.
    visibility String
    The visibility of Image.
    id string
    The provider-assigned unique ID for this managed resource.
    images GetImagesImage[]
    The collection of Image query.
    totalCount number
    The total count of Image query.
    ids string[]
    imageName string
    The name of Image.
    instanceTypeId string
    isSupportCloudInit boolean
    Whether the Image support cloud-init.
    isTls boolean
    nameRegex string
    osType string
    The operating system type of Image.
    outputFile string
    platform string
    The platform of Image.
    statuses string[]
    The status of Image.
    tags GetImagesTag[]
    Tags.
    visibility string
    The visibility of Image.
    id str
    The provider-assigned unique ID for this managed resource.
    images Sequence[GetImagesImage]
    The collection of Image query.
    total_count int
    The total count of Image query.
    ids Sequence[str]
    image_name str
    The name of Image.
    instance_type_id str
    is_support_cloud_init bool
    Whether the Image support cloud-init.
    is_tls bool
    name_regex str
    os_type str
    The operating system type of Image.
    output_file str
    platform str
    The platform of Image.
    statuses Sequence[str]
    The status of Image.
    tags Sequence[GetImagesTag]
    Tags.
    visibility str
    The visibility of Image.
    id String
    The provider-assigned unique ID for this managed resource.
    images List<Property Map>
    The collection of Image query.
    totalCount Number
    The total count of Image query.
    ids List<String>
    imageName String
    The name of Image.
    instanceTypeId String
    isSupportCloudInit Boolean
    Whether the Image support cloud-init.
    isTls Boolean
    nameRegex String
    osType String
    The operating system type of Image.
    outputFile String
    platform String
    The platform of Image.
    statuses List<String>
    The status of Image.
    tags List<Property Map>
    Tags.
    visibility String
    The visibility of Image.

    Supporting Types

    GetImagesImage

    Architecture string
    The architecture of Image.
    BootMode string
    The boot mode of Image.
    CreatedAt string
    The create time of Image.
    Description string
    The description of Image.
    ImageId string
    The ID of Image.
    ImageName string
    The name of Image.
    IsSupportCloudInit bool
    Whether the Image support cloud-init.
    OsName string
    The name of Image operating system.
    OsType string
    The operating system type of Image.
    Platform string
    The platform of Image.
    PlatformVersion string
    The platform version of Image.
    ShareStatus string
    The share mode of Image.
    Size int
    The size(GiB) of Image.
    Status string
    A list of Image status, the value can be available or creating or error.
    Tags List<GetImagesImageTag>
    Tags.
    UpdatedAt string
    The update time of Image.
    Visibility string
    The visibility of Image.
    Architecture string
    The architecture of Image.
    BootMode string
    The boot mode of Image.
    CreatedAt string
    The create time of Image.
    Description string
    The description of Image.
    ImageId string
    The ID of Image.
    ImageName string
    The name of Image.
    IsSupportCloudInit bool
    Whether the Image support cloud-init.
    OsName string
    The name of Image operating system.
    OsType string
    The operating system type of Image.
    Platform string
    The platform of Image.
    PlatformVersion string
    The platform version of Image.
    ShareStatus string
    The share mode of Image.
    Size int
    The size(GiB) of Image.
    Status string
    A list of Image status, the value can be available or creating or error.
    Tags []GetImagesImageTag
    Tags.
    UpdatedAt string
    The update time of Image.
    Visibility string
    The visibility of Image.
    architecture String
    The architecture of Image.
    bootMode String
    The boot mode of Image.
    createdAt String
    The create time of Image.
    description String
    The description of Image.
    imageId String
    The ID of Image.
    imageName String
    The name of Image.
    isSupportCloudInit Boolean
    Whether the Image support cloud-init.
    osName String
    The name of Image operating system.
    osType String
    The operating system type of Image.
    platform String
    The platform of Image.
    platformVersion String
    The platform version of Image.
    shareStatus String
    The share mode of Image.
    size Integer
    The size(GiB) of Image.
    status String
    A list of Image status, the value can be available or creating or error.
    tags List<GetImagesImageTag>
    Tags.
    updatedAt String
    The update time of Image.
    visibility String
    The visibility of Image.
    architecture string
    The architecture of Image.
    bootMode string
    The boot mode of Image.
    createdAt string
    The create time of Image.
    description string
    The description of Image.
    imageId string
    The ID of Image.
    imageName string
    The name of Image.
    isSupportCloudInit boolean
    Whether the Image support cloud-init.
    osName string
    The name of Image operating system.
    osType string
    The operating system type of Image.
    platform string
    The platform of Image.
    platformVersion string
    The platform version of Image.
    shareStatus string
    The share mode of Image.
    size number
    The size(GiB) of Image.
    status string
    A list of Image status, the value can be available or creating or error.
    tags GetImagesImageTag[]
    Tags.
    updatedAt string
    The update time of Image.
    visibility string
    The visibility of Image.
    architecture str
    The architecture of Image.
    boot_mode str
    The boot mode of Image.
    created_at str
    The create time of Image.
    description str
    The description of Image.
    image_id str
    The ID of Image.
    image_name str
    The name of Image.
    is_support_cloud_init bool
    Whether the Image support cloud-init.
    os_name str
    The name of Image operating system.
    os_type str
    The operating system type of Image.
    platform str
    The platform of Image.
    platform_version str
    The platform version of Image.
    share_status str
    The share mode of Image.
    size int
    The size(GiB) of Image.
    status str
    A list of Image status, the value can be available or creating or error.
    tags Sequence[GetImagesImageTag]
    Tags.
    updated_at str
    The update time of Image.
    visibility str
    The visibility of Image.
    architecture String
    The architecture of Image.
    bootMode String
    The boot mode of Image.
    createdAt String
    The create time of Image.
    description String
    The description of Image.
    imageId String
    The ID of Image.
    imageName String
    The name of Image.
    isSupportCloudInit Boolean
    Whether the Image support cloud-init.
    osName String
    The name of Image operating system.
    osType String
    The operating system type of Image.
    platform String
    The platform of Image.
    platformVersion String
    The platform version of Image.
    shareStatus String
    The share mode of Image.
    size Number
    The size(GiB) of Image.
    status String
    A list of Image status, the value can be available or creating or error.
    tags List<Property Map>
    Tags.
    updatedAt String
    The update time of Image.
    visibility String
    The visibility of Image.

    GetImagesImageTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    GetImagesTag

    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    Key string
    The Key of Tags.
    Value string
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.
    key string
    The Key of Tags.
    value string
    The Value of Tags.
    key str
    The Key of Tags.
    value str
    The Value of Tags.
    key String
    The Key of Tags.
    value String
    The Value of Tags.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate