You can call this operation to perform an image build task based on an image template.

Description

  • After an image template is created, you need to call the StartImagePipelineExecution operation to perform an image build task. The system builds, distributes, and shares an image based on the parameters configured in the image template.
  • You can perform only one image build task at a time based on a single image template. You can call the CancelImagePipelineExecution operation multiple times to cancel multiple image build tasks at the same time. If you cancel some image build tasks, the other image build tasks are not affected.

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 StartImagePipelineExecution

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

ImagePipelineId String Yes ip-2ze5tsl5bp6nf2b3****

The ID of the image template.

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.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The ClientToken value can only contain ASCII characters and cannot exceed 64 characters in length. For more information, see How can I ensure idempotence?

Response parameters

Parameter Type Example Description
ExecutionId String exec-5fb8facb8ed7427c****

The ID of the image build task.

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

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

<StartImagePipelineExecutionResponse>
      <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
      <ExecutionId>exec-5fb8facb8ed7427c****</ExecutionId>
</StartImagePipelineExecutionResponse>

JSON format

{
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E", 
    "ExecutionId": "exec-5fb8facb8ed7427c****"
}

Error codes

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