Executes an image creation task by using an image template.

Description

  • After an image template is created, you must call the StartImagePipelineExecution operation to execute an image creation task. The system creates, distributes, and shares an image based on the parameters configured in the image template.
  • Only one image creation task can be executed at a time based on a single image template. You can call the CancelImagePipelineExecution operation multiple times to cancel multiple image creation tasks at a time. If you cancel some image creation tasks, the other 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.

RegionId String Yes cn-hangzhou

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

TemplateTag.N.Key String No null
Note This parameter is deprecated.
TemplateTag.N.Value String No null
Note This parameter is deprecated.
ImagePipelineId String Yes ip-2ze5tsl5bp6nf2b3****

The ID of the image template.

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 the value is unique among different requests. The value of the ClientToken parameter can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

Response parameters

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

The ID of the image creation 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 

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

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

JSON format 

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

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

Error codes

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