You can call this operation to query the details of one or more image templates.

Description

You can configure the query token by using the NextToken parameter. Set the NextToken value to the NextToken value that was returned when you last called the DescribeImagePipelines operation. Then, use the MaxResults parameter to configure the maximum number of entries to return on each page to query the details of the image templates.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeImagePipelines

The operation that you want to perform. Set the value to DescribeImagePipelines.

RegionId String Yes cn-hangzhou

The region ID of the image template. You can call the DescribeRegions operation to query the most recent region list.

Tag.N.Key String No TestKey

The key of tag N. Valid values of N: 1 to 20.

Tag.N.Value String No TestValue

The value of tag N. Valid values of N: 1 to 20.

ResourceGroupId String No rg-bp67acfmxazb4p****

The ID of the resource group to which to assign the image template.

Name String No testImagePipeline

The name of the image template.

ImagePipelineId.N RepeatList No ip-2ze5tsl5bp6nf2b3****

The ID of image template N. Valid values of N: 1 to 20.

NextToken String No AAAAAdDWBF2****

The query token. Set the value to the NextToken value that was returned when you last called the DescribeImagePipelines operation. Leave this parameter empty when you call this operation for the first time.

MaxResults Integer No 50

The maximum number of entries to return on each page. Valid values: 1 to 500.

Default value: 50.

Response parameters

Parameter Type Example Description
ImagePipeline Array of ImagePipelineSet

Details of the image template.

ImagePipelineSet
AddAccounts List ["1234567890"]

The IDs of Alibaba Cloud accounts to which to share the image.

BaseImage String m-bp67acfmxazb4p****

The source image.

  • When BaseImageType is set to IMAGE, the value of this parameter is the ID of a custom image.
  • When BaseImageType is set to IMAGE_FAMILY, the value of this parameter is the name of an image family.
BaseImageType String IMAGE

The type of the source image. Valid values:

  • IMAGE: custom images
  • IMAGE_FAMILY: image families
BuildContent String FROM IMAGE:m-bp67acfmxazb4p****

The content of the image template.

CreationTime String 2020-11-24T06:00:00Z

The time when the image template was created.

DeleteInstanceOnFailure Boolean true

Indicates whether the intermediate instance was released when the image failed to be built.

Description String This is description.

The description of the image template.

ImageName String testImageName

The name prefix of the created image.

ImagePipelineId String ip-2ze5tsl5bp6nf2b3****

The ID of the image template.

InstanceType String ecs.g6.large

The instance type of the instance.

InternetMaxBandwidthOut Integer 0

The size of the outbound public bandwidth for the intermediate instance. Unit: Mbit/s.

Name String testImagePipeline

The name of the image template.

ResourceGroupId String rg-bp67acfmxazb4p****

The ID of the resource group to which the image template was assigned.

SystemDiskSize Integer 40

The system disk size of the intermediate instance. Unit: GiB.

Tags Array of Tag

The list of tag key-value pairs.

Tag
TagKey String TestKey

The tag key.

TagValue String TestValue

The tag value.

ToRegionIds List ["cn-hangzhou"]

The IDs of regions to which to distribute the image.

VSwitchId String vsw-bp67acfmxazb4p****

The ID of the vSwitch.

MaxResults Integer 50

The maximum number of entries returned per page.

NextToken String AAAAAdDWBF2****

The query token returned in this call. For information about how to use this return value, see the Description section in this topic.

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

TotalCount Integer 1

The total number of returned image templates.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribeImagePipelines
&RegionId=cn-hangzhou
&ImagePipelineId.1=ip-2ze5tsl5bp6nf2b3****
&<Common request parameters>

Sample success responses

XML format

<CreateDiskResponse>
      <TotalCount>1</TotalCount>
      <NextToken>AAAAAdDWBF2****</NextToken>
      <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
      <MaxResults>50</MaxResults>
      <ImagePipeline>
            <ImagePipelineSet>
                  <BaseImageType>IMAGE</BaseImageType>
                  <Description>This is description. </Description>
                  <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
                  <SystemDiskSize>40</SystemDiskSize>
                  <ImagePipelineId>ip-2ze5tsl5bp6nf2b3****</ImagePipelineId>
                  <VSwitchId>vsw-bp67acfmxazb4p****</VSwitchId>
                  <Name>testImagePipeline</Name>
                  <DeleteInstanceOnFailure>true</DeleteInstanceOnFailure>
                  <ImageName>testImageName</ImageName>
                  <InternetMaxBandwidthOut>0</InternetMaxBandwidthOut>
                  <CreationTime>2020-11-24T06:00:00Z</CreationTime>
                  <InstanceType>ecs.g6.large</InstanceType>
                  <BuildContent>FROM IMAGE:m-bp67acfmxazb4p****</BuildContent>
                  <BaseImage>m-bp67acfmxazb4p****</BaseImage>
            </ImagePipelineSet>
            <ImagePipelineSet>
                  <Tags>
                        <Tag>
                              <TagKey>TestKey</TagKey>
                              <TagValue>TestValue</TagValue>
                        </Tag>
                  </Tags>
            </ImagePipelineSet>
            <ImagePipelineSet>
                  <AddAccounts>
                        <AddAccount>["1234567890"]</AddAccount>
                  </AddAccounts>
                  <ToRegionIds>
                        <ToRegionId>["cn-hangzhou"]</ToRegionId>
                  </ToRegionIds>
            </ImagePipelineSet>
      </ImagePipeline>
</CreateDiskResponse>

JSON format

{
    "TotalCount": "1", 
    "NextToken": "AAAAAdDWBF2****", 
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E", 
    "MaxResults": "50", 
    "ImagePipeline": {
        "ImagePipelineSet": [
            {
                "BaseImageType": "IMAGE", 
                "Description": "This is description.", 
                "ResourceGroupId": "rg-bp67acfmxazb4p****", 
                "SystemDiskSize": "40", 
                "ImagePipelineId": "ip-2ze5tsl5bp6nf2b3****", 
                "VSwitchId": "vsw-bp67acfmxazb4p****", 
                "Name": "testImagePipeline", 
                "DeleteInstanceOnFailure": "true", 
                "ImageName": "testImageName", 
                "InternetMaxBandwidthOut": "0", 
                "CreationTime": "2020-11-24T06:00:00Z", 
                "InstanceType": "ecs.g6.large", 
                "BuildContent": "FROM IMAGE:m-bp67acfmxazb4p****", 
                "BaseImage": "m-bp67acfmxazb4p****"
            }, 
            {
                "Tags": {
                    "Tag": [
                        {
                            "TagKey": "TestKey", 
                            "TagValue": "TestValue"
                        }
                    ]
                }
            }, 
            {
                "AddAccounts": {
                    "AddAccount": "[\"1234567890\"]"
                }, 
                "ToRegionIds": {
                    "ToRegionId": "[\"cn-hangzhou\"]"
                }
            }
        ]
    }
}

Error codes

For a list of error codes, visit the API Error Center.