You can call this operation to query the details of an image build task.

Description

  • The image template specified by the ImagePipelineId parameter cannot be a deleted image template. The corresponding build task is deleted when an image template is deleted.
  • You must set the ImagePipelineId parameter to specify the ID of an image template or the ExecutionId parameter to specify the ID of a build task.
  • You can configure the query token by using the NextToken parameter. Set the value of NextToken to the NextToken value that was returned when you last called the DescribeImagePipelineExecutions 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 build task.

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 DescribeImagePipelineExecutions

The operation that you want to perform. Set the value to DescribeImagePipelineExecutions.
RegionId String Yes cn-hangzhou

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

ImagePipelineId String No ip-2ze5tsl5bp6nf2b3****

The ID of the image template.

ExecutionId String No exec-5fb8facb8ed7427c****

The ID of the image build task.

Status String No BUILDING

The status of the image build task. You can specify multiple values at the same time. Separate the values with commas (,). Example format: BUILDING,DISTRIBUTING. Valid values:

  • BUILDING: The image is being built.
  • DISTRIBUTING: The image is being distributed.
  • RELEASING: The image is being recycled.
  • SUCCESS: The image is built.
  • FAILED: The image fails to be built.
  • CANCELLING: The image build task is being canceled.
  • CANCELLED: The image build task is canceled.
Note You cannot query the image build tasks in all status by leaving this parameter empty.
NextToken String No AAAAAdDWBF2****

The query token. Set the value to the NextToken value that was returned when you last called the DescribeImagePipelineExecutions 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
ImagePipelineExecution Array of ImagePipelineExecutionSet

Details of the image build task.

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

The time when the image build task was created.

ExecutionId String exec-5fb8facb8ed7427c****

The ID of the image build task.

ImageId String m-bp67acfmxazb4p****

The ID of the image to be created by using the image build task.

ImagePipelineId String ip-2ze5tsl5bp6nf2b3****

The ID of the image template.

Message String Create transition vpc "vpc-2ze70rc7093j9idu6****" success!

The execution result of the image build task.

ModifiedTime String 2020-11-25T06:00:00Z

The last time when the image build task was updated.

ResourceGroupId String rg-bp67acfmxazb4p****

The ID of the resource group.

Status String BUILDING

The status of the image build task. Valid values:

  • BUILDING: The image was being built.
  • DISTRIBUTING: The image was being distributed.
  • RELEASING: The image was being recycled.
  • SUCCESS: The image was built.
  • FAILED: The image failed to be built.
  • CANCELLING: The image build task was being canceled.
  • CANCELLED: The image build task was cancelled.
Tags Array of Tag

The list of tag key-value pairs.

Tag
TagKey String TestKey

The key of the tag.

TagValue String TestValue

The value of the tag.

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 components.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=DescribeImagePipelineExecutions
&RegionId=cn-hangzhou
&ExecutionId=exec-5fb8facb8ed7427c****
&Status=BUILDING
&<Common request parameters>

Sample success responses

XML format 

<DescribeImagePipelineExecutionsResponse>
      <TotalCount>1</TotalCount>
      <NextToken>AAAAAdDWBF2****</NextToken>
      <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
      <MaxResults>50</MaxResults>
      <ImagePipelineExecution>
            <ImagePipelineExecutionSet>
                  <Status>BUILDING</Status>
                  <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
                  <Message>Create transition vpc "vpc-2ze70rc7093j9idu6****" success!</Message>
                  <ModifiedTime>2020-11-25T06:00:00Z</ModifiedTime>
                  <ImagePipelineId>ip-2ze5tsl5bp6nf2b3****</ImagePipelineId>
                  <ImageId>m-bp67acfmxazb4p****</ImageId>
                  <CreationTime>2020-11-24T06:00:00Z</CreationTime>
                  <ExecutionId>exec-5fb8facb8ed7427c****</ExecutionId>
            </ImagePipelineExecutionSet>
            <ImagePipelineExecutionSet>
                  <Tags>
                        <Tag>
                              <TagKey>TestKey</TagKey>
                              <TagValue>TestValue</TagValue>
                        </Tag>
                  </Tags>
            </ImagePipelineExecutionSet>
      </ImagePipelineExecution>
</DescribeImagePipelineExecutionsResponse>

JSON format 

{
    "TotalCount": "1", 
    "NextToken": "AAAAAdDWBF2****", 
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E", 
    "MaxResults": "50", 
    "ImagePipelineExecution": {
        "ImagePipelineExecutionSet": [
            {
                "Status": "BUILDING", 
                "ResourceGroupId": "rg-bp67acfmxazb4p****", 
                "Message": "Create transition vpc \"vpc-2ze70rc7093j9idu6****\" success!", 
                "ModifiedTime": "2020-11-25T06:00:00Z", 
                "ImagePipelineId": "ip-2ze5tsl5bp6nf2b3****", 
                "ImageId": "m-bp67acfmxazb4p****", 
                "CreationTime": "2020-11-24T06:00:00Z", 
                "ExecutionId": "exec-5fb8facb8ed7427c****"
            }, 
            {
                "Tags": {
                    "Tag": [
                        {
                            "TagKey": "TestKey", 
                            "TagValue": "TestValue"
                        }
                    ]
                }
            }
        ]
    }
}

Error codes

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