Executes a pipeline task by using an image template.
Operation description
- After you create an image template, you can call the StartImagePipelineExecution operation to create a pipeline task. The system creates, copies, and shares images based on the parameters configured in the image template.
- You can execute only one pipeline task for each image template.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ecs:StartImagePipelineExecution | update | *ImagePipeline acs:ecs:{#regionId}:{#accountId}:imagepipeline/{#imagepipelineId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID. You can call the DescribeRegions operation to query the most recent list of regions. | cn-hangzhou |
| TemplateTag | array<object> | No | Note
This parameter is deprecated.
| |
| object | No | |||
| Key | string | No | Note
This parameter is deprecated.
| null |
| Value | string | No | Note
This parameter is deprecated.
| null |
| ImagePipelineId | string | Yes | The ID of the image template. | ip-2ze5tsl5bp6nf2b3**** |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but make sure that the token is unique among requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence. | 123e4567-e89b-12d3-a456-426655440000 |
Response parameters
Examples
Sample success responses
JSONformat
{
"ExecutionId": "exec-5fb8facb8ed7427c****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidImage.OsTypeUnsupported | The specified base image does not support image building. | - |
| 400 | InvalidParameter.BuildContent | %s. | The build content is invalid. |
| 400 | InvalidParameter.TestContent | %s. | The test content is invalid. |
| 400 | InvalidImageComponent.NotSupported | %s. | The specified image component is not available. |
| 403 | InvalidImagePipeline.HasRunningExecution | %s | - |
| 404 | InvalidImagePipeline.NotFound | %s | - |
| 404 | InvalidInstanceType.NotFound | The specified instance type does not exist. | The specified InstanceType parameter does not exist. |
| 404 | InvalidVSwitchId.NotFound | The specified VSwitchId does not exist. | The specified VSwitchId does not exist |
| 404 | InvalidRegionId.NotFound | %s | The specified region ID does not exist. |
| 404 | InvalidImage.NotFound | %s. | The specified image ID does not exist. |
| 404 | ImageComponent.NotFound | %s. | The specified image component ID is not found. |
| 404 | InvalidImagePipeline.BaseImageNotFound | The BaseImage of the specified ImagePipeline is not found. | The BaseImage of the specified ImagePipeline is not found. |
| 500 | StartImagePipelineExecution.Failed | Start image pipeline execution failed. | Failed to execute the image template task. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-11-07 | The Error code has changed | View Change Details |
| 2024-10-10 | The Error code has changed | View Change Details |