DescribeImagePipelines-阿里云帮助中心

Queries the details of one or more image templates.

Operation description

You can set the NextToken query token to the NextToken value returned from the previous DescribeImagePipelines call, and use MaxResults to specify the maximum number of entries per page for the query.

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 resource group ID. 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 template.	testImagePipeline
NextToken	string	No	The query token. Set the value to the `NextToken` value returned from the previous API call. You do not need to specify this parameter for the first call.	AAAAAdDWBF2****
MaxResults	integer	No	The maximum number of entries per page for paging. 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
ImagePipeline	object
ImagePipelineSet	array<object>	The list of image templates.
	array<object>
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"]
AdvancedOptions	object	The advanced settings.
ImageNameSuffix	string	Specifies whether to disable the automatic addition of a suffix to the destination image name. Valid values: disable: Disabled.	disable
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: Retained. false: Not retained. Note This setting does not affect the Cloud Assistant that is pre-installed in your image.	true
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****
BaseImageType	string	The type of the source image. Valid values: IMAGE: custom image. IMAGE_FAMILY: image family.	IMAGE
BuildContent	string	The content of the image template.	COMPONENT ic-bp12dvdzvr9k9*** COMPONENT acs:ecs:cn-hangzhou:18689161186**:imagecomponent/ComponentName/1..*
CreationTime	string	The time when the 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
Description	string	The description.	This is description.
ImageFamily `deprecated`	string	The image family of the destination image. Important [Deprecated] Use ImageOptions.ImageFamily instead.	family
ImageName `deprecated`	string	The name prefix of the destination image. Important [Deprecated] Use ImageOptions.ImageName instead.	testImageName
ImageOptions	object	The properties of the destination image.
Description	string	The description of the destination image.	description.
ImageFamily	string	The image family of the destination image.	family
ImageFeatures	object	The feature-related properties 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 before the build phase. If you install or uninstall the NVMe driver during the build, the detection result may be inaccurate. We recommend that you set this parameter to supported or unsupported based on the build content.	auto
ImageName	string	The name prefix of the destination image.	imageName
ImageTags	object
ImageTag	array<object>	The tags of the destination image.
	object
TagKey	string	The tag key.	testKey
TagValue	string	The tag value.	testValue
ImagePipelineId	string	The ID of the image template.	ip-2ze5tsl5bp6nf2b3****
ImageSecurityOptions	object	The security-related properties and settings of the image.
SecurityScanMode	string	The security scan mode. Valid values: agentless: Uses the agentless scan mode of Security Center.	agentless
ImportImageOptions	object	The properties and settings of the imported image.
Architecture	string	The system architecture. Valid values: x86_64 arm64	x86_64
BootMode	string	The boot mode of the imported image. Valid values: BIOS: BIOS boot mode. UEFI: UEFI boot mode.	BIOS
Description	string	The description of the imported image.	created by acc
DiskDeviceMappings	object
DiskDeviceMapping	array<object>	The list of custom image information. If N is set to 1, the disk is a system disk. If N ranges from 2 to 17, the disk is a data disk.
	object
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 ranges from 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
Format	string	The image format. Valid values: RAW VHD QCOW2	RAW
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.	CentOS_5.4_32.raw
Features	object	The feature-related properties of the image.
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
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
ImageName	string	The name of the imported image.	fvt-ecs-imported-image-1812b2d7
ImportImageTags	object
ImportImageTag	array<object>	The list of tags used when the image is imported.
	object	The tag key-value pair of the imported image.
Key	string	The tag key of the image.	testKey
Value	string	The tag value of the image.	testValue
LicenseType	string	The license type 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 auto mode, the system first checks whether the operating system specified by `Platform` has a license from Alibaba Cloud official channels and assigns it to the imported image. If no such license is available, the system switches to the Bring Your Own License (BYOL) mode. Aliyun: Uses a license from Alibaba Cloud official channels based on the operating system specified by `Platform`. BYOL: Uses the license provided by the source operating system. If you use BYOL, you must ensure that your license key is supported on Alibaba Cloud.	Auto
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
RetainImportedImage	boolean	Important [Deprecated] Use ImportImageOptions.RetentionStrategy instead.	false
RetentionStrategy	string	The data retention policy for the imported image. Valid values: RetainOnlySuccessful: Retains the image only if the build succeeds. RetainOnlyFailed: Retains the image only if the build fails. RetainAlways: Always retains the image regardless of the build result. RetainNever: Never retains the image regardless of the build result. Default value: RetainNever.	RetainAlways
RoleName	string	The name of the RAM role used when the image is imported.	AliyunECSImageImportDefaultRole
InstanceType	string	The instance type.	ecs.g6.large
InternetMaxBandwidthOut	integer	The outbound public bandwidth of the intermediate instance. Unit: Mbit/s.	0
Name	string	The name of the template.	testImagePipeline
NvmeSupport `deprecated`	string	Specifies whether the built destination image supports NVMe. Important [Deprecated] Use ImageOptions.ImageFeatures.NvmeSupport instead.	auto
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. 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 Windows 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
RepairMode	string	The repair option in the image template. Valid values: Standard: Standard repair mode. The standard repair package for Linux includes: GUESTOS.CloudInit GUESTOS.Dhcp GUESTOS.Virtio GUESTOS.OnlineResizeFS GUESTOS.Grub GUESTOS.Fstab GUESTOS.Nvme The standard repair package for Windows 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 includes the following items in addition to those in the standard repair package: GUESTOS.Selinux GUESTOS.SecurityCenterAgent The full repair package for Windows 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 detection and repair capabilities continue to improve, the included repair items may increase. For more information about the specific meanings of repair items, see Image inspection overview.	Standard
ResourceGroupId	string	The ID of the resource group.	rg-bp67acfmxazb4p****
SystemDiskSize	integer	The size of the system disk of the intermediate instance. Unit: GiB.	40
Tags	object
Tag	array<object>	The list of tag key-value pairs.
	object
TagKey	string	The tag key.	TestKey
TagValue	string	The tag value.	TestValue
TestContent	string	The content of the image test template.	COMPONENT ic-bp12dvdzvr9k9*** COMPONENT acs:ecs:cn-hangzhou:18689161186**:imagecomponent/ComponentName/1..*
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"]
VSwitchId	string	The ID of the vSwitch in the VPC.	vsw-bp67acfmxazb4p****
MaxResults	integer	The number of entries per page in a paging query.	50
NextToken	string	The query token returned by this 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

Examples

Success response

JSON format

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

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.