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

Describes one or more image templates.

Operation description

To page through results, set the NextToken parameter to the NextToken value from the previous DescribeImagePipelines response, and use MaxResults to limit the number of results per 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 latest Alibaba Cloud regions.	cn-hangzhou
ResourceGroupId	string	No	The ID of the enterprise resource group. When you use this parameter to filter resources, the query returns a maximum of 1,000 resources. Note You cannot filter by the default resource group.	rg-bp67acfmxazb4p****
Tag	array<object>	No	A list of tags.
	object	No	A tag object.
Key	string	No	The key of tag N. You can specify up to 20 tags.	TestKey
Value	string	No	The value of tag N. You can specify up to 20 tags.	TestValue
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the latest Alibaba Cloud regions.	cn-hangzhou
ResourceGroupId	string	No	The ID of the enterprise resource group. When you use this parameter to filter resources, the query returns a maximum of 1,000 resources. Note You cannot filter by the default resource group.	rg-bp67acfmxazb4p****
Name	string	No	The name of the image pipeline.	testImagePipeline
NextToken	string	No	The token for the next page of results. To retrieve the next page, set this parameter to the NextToken value from the previous response. Omit this parameter for the first request.	AAAAAdDWBF2****
MaxResults	integer	No	The maximum number of entries to return per page. Valid values: 1 to 500. Default value: 50.	50
ImagePipelineId	array	No	The ID of an image pipeline. You can specify up to 20 IDs.	ip-2ze5tsl5bp6nf2b3****
	string	No	The ID of an image pipeline.	ip-2ze5tsl5bp6nf2b3****

Response elements

Element	Type	Description	Example
	object
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. For more information, see the "Usage notes" section.	AAAAAdDWBF2****
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	The total number of image templates.	1
MaxResults	integer	The number of entries per page.	50
ImagePipeline	object
ImagePipelineSet	array<object>	The details of the image templates.
	array<object>
CreationTime	string	The time when the image template was created.	2020-11-24T06:00:00Z
DeleteInstanceOnFailure	boolean	Indicates whether to release the intermediate instance when the image fails to be created.	true
InstanceType	string	The instance type.	ecs.g6.large
InternetMaxBandwidthOut	integer	The public egress 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.	vsw-bp67acfmxazb4p****
SystemDiskSize	integer	The system disk size of the intermediate instance. Unit: GiB.	40
Description	string	The description of the image template.	This is description.
BaseImage	string	The source image. If `BaseImageType` is set to `IMAGE`, the value of this parameter is the ID of a custom image. If `BaseImageType` is set to `IMAGE_FAMILY`, the value of this parameter is the name of an image family.	m-bp67acfmxazb4p****
ResourceGroupId	string	The ID of the resource group.	rg-bp67acfmxazb4p****
ImageName `deprecated`	string	The prefix of the destination image name. Important This parameter is deprecated. 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 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 tags.
	object
TagValue	string	The value of the tag.	TestValue
TagKey	string	The key of the tag.	TestKey
ToRegionIds	object
ToRegionId	array	The IDs of destination regions.
	string	The IDs of destination regions.	["cn-hangzhou"]
AddAccounts	object
AddAccount	array	The IDs of Alibaba Cloud accounts with which to share the image.
	string	The IDs of Alibaba Cloud accounts with which to share the image.	["1234567890"]
RepairMode	string	The repair option in the image template. Valid value: Standard: standard mode	Standard
TestContent	string	The content of the image test template.	COMPONENT ic-bp12dvdzvr9k9*** COMPONENT acs:ecs:cn-hangzhou:18689161186**:imagecomponent/ComponentName/1..*
ImageFamily `deprecated`	string	The name of the destination image family. Important This parameter is deprecated. Use `ImageOptions.ImageFamily` instead.	family
NvmeSupport `deprecated`	string	Indicates whether the destination image supports NVMe. Important This parameter is deprecated. Use `ImageOptions.ImageFeatures.NvmeSupport` instead.	auto
ImportImageOptions	object	The attributes and settings for importing the image.
Architecture	string	The system architecture. Valid values: x86_64 arm64	x86_64
OSType	string	The operating system. Valid values: windows linux	linux
Platform	string	The operating system distribution. 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 image. Valid values: BIOS UEFI	BIOS
LicenseType	string	The license type used to activate the operating system after the image is imported. Valid values: Auto: Alibaba Cloud detects the operating system of the source image and allocates a license. In this mode, the system first checks whether an official Alibaba Cloud license is available for the operating system specified by `Platform`. If an official license is unavailable, the system switches to the Bring Your Own License (BYOL) mode. Aliyun: uses an official Alibaba Cloud license based on the operating system specified by `Platform`. BYOL: uses the license of the source image. When you use the BYOL mode, make sure that your license is supported by Alibaba Cloud.	Auto
DiskDeviceMappings	object
DiskDeviceMapping	array<object>	The information about the custom image. N=1 indicates the system disk. N can be an integer from 2 to 17, which indicates a data disk.
	object
OSSBucket	string	The OSS bucket in which the image file is stored.	ecsimageos
OSSObject	string	The name of the image file in the OSS 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 size consists of the system disk size and data disk size. You must make sure that the system disk size is greater than or equal to the size of the imported image file. Valid values: When N is 1, which indicates a system disk, the value ranges from 1 to 2,048. Unit: GiB. When N is an integer from 2 to 17, which indicates a data disk, the value ranges from 1 to 2,048. Unit: GiB. After you upload the source image file to an OSS bucket, you can view the image file size in the OSS bucket.	40
Features	object	The image attributes.
NvmeSupport	string	Indicates whether the imported image supports NVMe. Valid values: supported: Instances that are created from this image support the NVMe protocol. unsupported: Instances that are created from this image do not support the NVMe protocol.	supported
ImdsSupport	string
RetainImportedImage	boolean	Note This parameter is in invitational preview.	false
RetentionStrategy	string
ImageName	string
Description	string
RoleName	string
ImportImageTags	object
ImportImageTag	array<object>
	object
Key	string
Value	string
AdvancedOptions	object	Advanced settings.
RetainCloudAssistant	boolean	Indicates whether to retain Cloud Assistant. During the build process, the system automatically installs Cloud Assistant in the intermediate instance to run commands. You can select whether to retain Cloud Assistant in the destination image. Valid values: true: retains Cloud Assistant. false: does not retain Cloud Assistant. Note This setting does not affect the Cloud Assistant client that is included in your source image.	true
ImageNameSuffix	string	Indicates whether to disable the system from automatically appending a suffix to the destination image name. Valid value: disable: disables the system from appending a suffix.	disable
ImageOptions	object	The attributes of the destination image.
ImageName	string	The prefix of the destination image name.	imageName
ImageFamily	string	The name of the destination image family.	family
Description	string	The description of the destination image.	description.
ImageFeatures	object	The attributes of the destination image.
NvmeSupport	string	Indicates whether the destination image supports NVMe. Valid values: supported: Instances that are created from this image support the NVMe protocol. unsupported: Instances that are created from this image do not support the NVMe protocol. auto: The system automatically checks whether the source image has NVMe drivers installed. This check occurs before the build phase. If NVMe drivers are installed or uninstalled during the build, the detection may be inaccurate. In such cases, 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 key of the tag.	testKey
TagValue	string	The value of the tag.	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",
        "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": ""
          },
          "RetainImportedImage": false,
          "RetentionStrategy": "",
          "ImageName": "",
          "Description": "",
          "RoleName": "",
          "ImportImageTags": {
            "ImportImageTag": [
              {
                "Key": "",
                "Value": ""
              }
            ]
          }
        },
        "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.