DescribeImagePipelines -

Description

You can use NextToken to configure the query token. Set the value to the NextToken value that is returned in the last call to the DescribeImagePipelines operation. Then, use MaxResults to specify the maximum number of entries to return on each page.

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.
ResourceGroupId	String	No	rg-bp67acfmxazb4p****	The ID of the resource group. If this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response. Note Resources in the default resource group are displayed in the response regardless of how this parameter is set.
Tag.N.Key	String	No	TestKey	The key of tag N of the image template. Valid values of N: 1 to 20.
Tag.N.Value	String	No	TestValue	The value of tag N of the image template. Valid values of N: 1 to 20.
Name	String	No	testImagePipeline	The name of the image template.
NextToken	String	No	AAAAAdDWBF2****	The query token. Set the value to the `NextToken` value returned in the last call to the DescribeImagePipelines operation. Leave this parameter empty the first time you call this operation.
MaxResults	Integer	No	50	The maximum number of entries to return on each page. Valid values: 1 to 500. Default value: 50.
ImagePipelineId.N	String	No	ip-2ze5tsl5bp6nf2b3****	The ID of image template N. Valid values of N: 1 to 20.

Response parameters


Parameter	Type	Example	Description
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 image templates returned.
MaxResults	Integer	50	The maximum number of entries returned per page.
ImagePipeline	Array of ImagePipelineSet		Details of the image templates.
ImagePipelineSet
CreationTime	String	2020-11-24T06:00:00Z	The time when the image template was created.
DeleteInstanceOnFailure	Boolean	true	Indicates whether to release the intermediate instance when the image fails to be created.
InstanceType	String	ecs.g6.large	The instance type of the intermediate instance.
InternetMaxBandwidthOut	Integer	0	The size of the outbound public bandwidth for the intermediate instance. Unit: Mbit/s.
ImagePipelineId	String	ip-2ze5tsl5bp6nf2b3****	The ID of the image template.
VSwitchId	String	vsw-bp67acfmxazb4p****	The ID of the vSwitch.
SystemDiskSize	Integer	40	The system disk size of the intermediate instance. Unit: GiB.
Description	String	This is description.	The description of the image template.
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.
ResourceGroupId	String	rg-bp67acfmxazb4p****	The ID of the resource group.
ImageName	String	testImageName	The name prefix of the created image.
BaseImageType	String	IMAGE	The type of the source image. Valid values: IMAGE: custom image IMAGE_FAMILY: image family
Name	String	testImagePipeline	The name of the image template.
BuildContent	String	FROM IMAGE:m-bp67acfmxazb4p****	The content of the image template.
Tags	Array of Tag		The tags of the image template.
Tag
TagValue	String	TestValue	The tag value of the image template.
TagKey	String	TestKey	The tag key of the image template.
ToRegionIds	Array of String	["cn-hangzhou"]	The IDs of regions to which to distribute the created image.
AddAccounts	Array of String	["1234567890"]	The IDs of Alibaba Cloud accounts to which to share the created image.

Examples

Sample requests

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<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

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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


HTTP status code	Error code	Error message	Description
400	InvalidImagePipelineIdSize.ExceededMaxNumber	%s	The error message returned because the specified ImagePipelineId.N parameter is invalid. Valid values of N: 1 to 20.

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