Use DescribeImagePipelines to query details of image templates - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries the details of one or more image templates.

Operation description

You can set the NextToken query token, which is the value of the NextToken parameter returned by the last call to the DescribeImagePipelines operation, and use MaxResults to specify the maximum number of entries to return on a single page.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeImagePipelines

get

*ImagePipeline

acs:ecs:{#regionId}:{#accountId}:imagepipeline/*

*ImagePipeline

acs:ecs:{#regionId}:{#accountId}:imagepipeline/{#imagepipelineId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ResourceGroupId	string	No	The ID of the resource group. When you use this parameter to filter resources, the resource count cannot exceed 1,000. Note Filtering by the default resource group is not supported.	rg-bp67acfmxazb4p****
Tag	array<object>	No	The tags.
	object	No	The tags.
Key	string	No	The tag key. Valid values of N: 1 to 20.	TestKey
Value	string	No	The tag value. Valid values of N: 1 to 20.	TestValue
Name	string	No	The name of the image template.	testImagePipeline
NextToken	string	No	The query token. The value is the `NextToken` parameter value returned by the previous call to this operation. You do not need to specify this parameter when you call this operation for the first time.	AAAAAdDWBF2****
MaxResults	integer	No	The maximum number of entries to return per page for paging in a paged query. Valid values: 1 to 500. Default value: 50.	50
ImagePipelineId	array	No	The ID of the image template. Valid values of N: 1 to 20.	ip-2ze5tsl5bp6nf2b3****
	string	No	The ID of the image template. Valid values of N: 1 to 20.	ip-2ze5tsl5bp6nf2b3****

Response elements

Element	Type	Description	Example
	object
NextToken	string	The query token returned by the current call. For more information about how to use the token, see the operation description.	AAAAAdDWBF2****
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	The total number of image templates returned.	1
MaxResults	integer	The maximum number of entries returned per page for paging in a paged query.	50
ImagePipeline	object
ImagePipelineSet	array<object>	The list of image templates.
	array<object>
CreationTime	string	The time when the image template was created. The time follows the ISO 8601 standard and is displayed in UTC.	2020-11-24T06:00:00Z
DeleteInstanceOnFailure	boolean	Specifies whether to release the intermediate instance if the image build fails.	true
InstanceType	string	The instance type.	ecs.g6.large
InternetMaxBandwidthOut	integer	The outbound public bandwidth of the intermediate instance. Unit: Mbit/s.	0
ImagePipelineId	string	The ID of the image template.	ip-2ze5tsl5bp6nf2b3****
VSwitchId	string	The ID of the vSwitch in the VPC.	vsw-bp67acfmxazb4p****
SystemDiskSize	integer	The size of the system disk of the intermediate instance. Unit: GiB.	40
Description	string	The description.	This is description.
BaseImage	string	The source image. If `BaseImageType` is set to `IMAGE`, the value of this parameter is the ID of the custom image. If `BaseImageType` is set to `IMAGE_FAMILY`, the value of this parameter is the name of the image family.	m-bp67acfmxazb4p****
ResourceGroupId	string	The ID of the resource group.	rg-bp67acfmxazb4p****
ImageName `deprecated`	string	[Deprecated] The prefix of the destination image name. Use ImageOptions.ImageName instead.	testImageName
BaseImageType	string	The type of the source image. Valid values: IMAGE: custom image IMAGE_FAMILY: image family	IMAGE
Name	string	The name of the image template.	testImagePipeline
BuildContent	string	The content of the image template.	COMPONENT ic-bp12dvdzvr9k9*** COMPONENT acs:ecs:cn-hangzhou:18689161186**:imagecomponent/ComponentName/1..*
Tags	object
Tag	array<object>	The list of tag key-value pairs.
	object
TagValue	string	The tag value.	TestValue
TagKey	string	The tag key.	TestKey
ToRegionIds	object
ToRegionId	array	The list of regions to which the destination image is to be distributed.
	string	The list of regions to which the destination image is to be distributed.	["cn-hangzhou"]
AddAccounts	object
AddAccount	array	The Alibaba Cloud account ID for image sharing of the destination image.
	string	The Alibaba Cloud account ID for image sharing of the destination image.	["1234567890"]
RepairMode	string	The repair option in the image template. Valid values: Standard: standard repair mode. The standard repair package for Linux systems includes: GUESTOS.CloudInit GUESTOS.Dhcp GUESTOS.Virtio GUESTOS.OnlineResizeFS GUESTOS.Grub GUESTOS.Fstab GUESTOS.Nvme The standard repair package for Windows systems includes: GUESTOS.Virtio GUESTOS.Update GUESTOS.Hotfix GUESTOS.Server GUESTOS.Bcd GUESTOS.Disk GUESTOS.Bootmgr GUESTOS.OSLoader GUESTOS.Vminit All: full repair mode. The full repair package for Linux systems includes the following items in addition to those in the standard repair package: GUESTOS.Selinux GUESTOS.SecurityCenterAgent The full repair package for Windows systems includes the following items in addition to those in the standard repair package: GUESTOS.Server Customized: custom repair mode. In this mode, the repair items in the repair package are specified by the RepairItem parameter. Note As the detection and repair capabilities continue to improve, the included repair items may increase. For more information about the specific meanings of the repair items, see Image check overview.	Standard
RepairItems	object
RepairItem	array	The image repair items. Repair items supported by Linux: fstab: fixes disk attach configuration issues grub: fixes GRUB boot configuration issues dhcp: fixes network DHCP issues selinux: fixes Security-Enhanced Linux (SELinux) issues growpart: fixes online automatic scale-out issues of the root partition cloudinit: installs the cloud-init initialization service aegis: installs the Security Center agent service nvme: fixes NVMe driver issues virtio: fixes virtio driver issues standardizedtimezone: fixes standard time zone issues Repair items supported by Windows: bcd: fixes Boot Configuration data file issues hotfix: fixes Windows patch issues disk: fixes disk Settings issues update: fixes Update process issues server: fixes service configuration issues bootmgr: fixes Windows Boot Manager issues vminit: fixes Windows initialization agent issues osloader: fixes Windows OS Loader issues virtio: fixes virtio driver issues standardizedtimezone: fixes standard time zone issues
	string	The image repair item.	fstab
TestContent	string	The content of the image test template.	COMPONENT ic-bp12dvdzvr9k9*** COMPONENT acs:ecs:cn-hangzhou:18689161186**:imagecomponent/ComponentName/1..*
ImageFamily `deprecated`	string	[Deprecated] The destination image family. Use ImageOptions.ImageFamily instead.	family
NvmeSupport `deprecated`	string	[Deprecated] Specifies whether the built destination image supports NVMe. Use ImageOptions.ImageFeatures.NvmeSupport instead.	auto
ImportImageOptions	object	The properties and settings of the imported image.
Architecture	string	The system architecture. Valid values: x86_64 arm64	x86_64
OSType	string	The operating system type. Valid values: windows linux	linux
Platform	string	The operating system version. Valid values: Aliyun Anolis CentOS Ubuntu CoreOS SUSE Debian OpenSUSE FreeBSD RedHat Kylin UOS Fedora Fedora CoreOS CentOS Stream AlmaLinux Rocky Linux Gentoo Customized Linux Others Linux Windows Server 2022 Windows Server 2019 Windows Server 2016 Windows Server 2012 Windows Server 2008 Windows Server 2003 Other Windows	Aliyun
BootMode	string	The boot mode of the imported image. Valid values: BIOS: BIOS boot mode UEFI: UEFI boot mode	BIOS
LicenseType	string	The type of license used to activate the operating system after the image is imported. Valid values: Auto: Alibaba Cloud detects the source operating system and assigns a license. In automatic mode, the system first checks whether the `Platform` you specified has a license from an official Alibaba Cloud channel and assigns it to the imported image. If no such license is available, the system switches to the Bring Your Own License (BYOL) method. Aliyun: uses a license from an official Alibaba Cloud channel based on the `Platform` you specified. BYOL: uses the license provided by the source operating system. If you use BYOL, you must ensure that your license key is supported in Alibaba Cloud.	Auto
DiskDeviceMappings	object
DiskDeviceMapping	array<object>	The list of information about the created custom images. If N is set to 1, the disk is a system disk. If N is set to 2 to 17, the disk is a data disk.
	object
OSSBucket	string	The OSS bucket where the image file is stored.	ecsimageos
OSSObject	string	The name (key) of the image file saved in the OSS bucket after the image is uploaded to the bucket.	CentOS_5.4_32.raw
Format	string	The image format. Valid values: RAW VHD QCOW2	RAW
DiskImageSize	integer	The size of the custom image after the image is imported. The space consists of the system disk and data disks. You must ensure that the size of the system disk is greater than or equal to the size of the imported image file. Valid values: If N is set to 1, the disk is a system disk. Valid values: 1 to 2048. Unit: GiB. If N is set to 2 to 17, the disk is a data disk. Valid values: 1 to 2048. Unit: GiB. After you upload the source image file to OSS, you can view the size of the image file in the OSS bucket.	40
Features	object	The properties related to image features.
NvmeSupport	string	Specifies whether the imported image supports NVMe. Valid values: supported: supported. Instances created from this image support the NVMe protocol. unsupported: not supported. Instances created from this image do not support the NVMe protocol.	supported
ImdsSupport	string	The metadata access mode of the image. Valid values: v1: When you create an ECS instance from this image, you cannot set the metadata access mode to enforced. v2: When you create an ECS instance from this image, you can set the metadata access mode to enforced. Default value: v1.	v2
RetainImportedImage	boolean	[Deprecated] Use ImportImageOptions.RetentionStrategy instead.	false
RetentionStrategy	string	The data retention policy for the imported image. Valid values: RetainOnlySuccessful: The image is retained only if the build is successful. RetainOnlyFailed: The image is retained only if the build fails. RetainAlways: The image is always retained regardless of the build result. RetainNever: The image is never retained regardless of the build result. Default value: RetainNever.	RetainAlways
ImageName	string	The name of the imported image.	fvt-ecs-imported-image-1812b2d7
Description	string	The description of the imported image.	created by acc
RoleName	string	The name of the RAM role used when the image is imported.	AliyunECSImageImportDefaultRole
ImportImageTags	object
ImportImageTag	array<object>
	object	The tag key-value pairs of the imported image.
Key	string	The tag key of the image.	testKey
Value	string	The tag value of the image.	testValue
AdvancedOptions	object	The advanced settings.
RetainCloudAssistant	boolean	Specifies whether to retain Cloud Assistant. During the build process, the system automatically installs Cloud Assistant on the intermediate instance to execute commands. You can choose whether to retain it in the built destination image. Valid values: true: retains Cloud Assistant. false: does not retain Cloud Assistant. Note This setting does not affect the Cloud Assistant that is already installed in your image.	true
ImageNameSuffix	string	Specifies whether to disable the automatic addition of a suffix to the destination image name. Valid values: disable: disabled.	disable
ImageOptions	object	The properties of the destination image.
ImageName	string	The prefix of the destination image name.	imageName
ImageFamily	string	The destination image family.	family
Description	string	The description of the destination image.	description.
ImageFeatures	object	The properties related to the features of the destination image.
NvmeSupport	string	Specifies whether the built destination image supports NVMe. Valid values: supported: supported. Instances created from this image support the NVMe protocol. unsupported: not supported. Instances created from this image do not support the NVMe protocol. auto: automatic detection. The system automatically detects whether the NVMe driver is installed in your image. This detection occurs before the build phase. If you install or uninstall the NVMe driver during the build, the result may be inaccurate. We recommend that you set this parameter to supported or unsupported based on the build content.	auto
ImageTags	object
ImageTag	array<object>	The tags of the destination image.
	object
TagKey	string	The tag key.	testKey
TagValue	string	The tag value.	testValue

Examples

Success response

JSON format

{
  "NextToken": "AAAAAdDWBF2****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount": 1,
  "MaxResults": 50,
  "ImagePipeline": {
    "ImagePipelineSet": [
      {
        "CreationTime": "2020-11-24T06:00:00Z",
        "DeleteInstanceOnFailure": true,
        "InstanceType": "ecs.g6.large",
        "InternetMaxBandwidthOut": 0,
        "ImagePipelineId": "ip-2ze5tsl5bp6nf2b3****",
        "VSwitchId": "vsw-bp67acfmxazb4p****",
        "SystemDiskSize": 40,
        "Description": "This is description.",
        "BaseImage": "m-bp67acfmxazb4p****",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "ImageName": "testImageName",
        "BaseImageType": "IMAGE",
        "Name": "testImagePipeline",
        "BuildContent": "COMPONENT ic-bp12dvdzvr9k9*****\nCOMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.*",
        "Tags": {
          "Tag": [
            {
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "ToRegionIds": {
          "ToRegionId": [
            "[\"cn-hangzhou\"]"
          ]
        },
        "AddAccounts": {
          "AddAccount": [
            "[\"1234567890\"]"
          ]
        },
        "RepairMode": "Standard",
        "RepairItems": {
          "RepairItem": [
            "fstab"
          ]
        },
        "TestContent": "COMPONENT ic-bp12dvdzvr9k9*****\nCOMPONENT acs:ecs:cn-hangzhou:18689161186*****:imagecomponent/ComponentName/1.*.*",
        "ImageFamily": "family",
        "NvmeSupport": "auto",
        "ImportImageOptions": {
          "Architecture": "x86_64",
          "OSType": "linux",
          "Platform": "Aliyun",
          "BootMode": "BIOS",
          "LicenseType": "Auto",
          "DiskDeviceMappings": {
            "DiskDeviceMapping": [
              {
                "OSSBucket": "ecsimageos",
                "OSSObject": "CentOS_5.4_32.raw",
                "Format": "RAW",
                "DiskImageSize": 40
              }
            ]
          },
          "Features": {
            "NvmeSupport": "supported",
            "ImdsSupport": "v2"
          },
          "RetainImportedImage": false,
          "RetentionStrategy": "RetainAlways",
          "ImageName": "fvt-ecs-imported-image-1812b2d7",
          "Description": "created by acc",
          "RoleName": "AliyunECSImageImportDefaultRole",
          "ImportImageTags": {
            "ImportImageTag": [
              {
                "Key": "testKey",
                "Value": "testValue"
              }
            ]
          }
        },
        "AdvancedOptions": {
          "RetainCloudAssistant": true,
          "ImageNameSuffix": "disable"
        },
        "ImageOptions": {
          "ImageName": "imageName",
          "ImageFamily": "family",
          "Description": "description.",
          "ImageFeatures": {
            "NvmeSupport": "auto"
          },
          "ImageTags": {
            "ImageTag": [
              {
                "TagKey": "testKey",
                "TagValue": "testValue"
              }
            ]
          }
        }
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidImagePipelineIdSize.ExceededMaxNumber	%s	The number of specified ImagePipelineId.N parameters exceeds the upper limit. Valid values of N: 1 to 20.
400	InvalidName.Malformed	%s
403	Invalid.NextToken	The specified NextToken is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.