通過一個鏡像模板執行構建鏡像的任務。
介面說明
鏡像模板建立好之後,需要通過該介面執行構建鏡像的任務,系統將根據鏡像模板設定好的參數進行構建、分發、共用鏡像。
同一個鏡像模板,同一時間只能執行一個構建鏡像任務。取消構建鏡像任務(CancelImagePipelineExecution)可同時執行多次,並且取消構建鏡像任務和構建鏡像任務之間互不干擾。
執行鏡像構建模板時,需要建立多台中轉執行個體輔助構建鏡像,中轉執行個體為隨用隨付的 ECS 執行個體,將收取一定的費用。更多資訊,請參見隨用隨付。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:StartImagePipelineExecution |
update |
*ImagePipeline
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
所屬的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。 |
cn-hangzhou |
TemplateTag
deprecated
|
array<object> |
否 |
說明
該參數已廢棄。 |
|
|
object |
否 |
|||
| Key |
string |
否 |
說明
該參數已廢棄。 |
null |
| Value |
string |
否 |
說明
該參數已廢棄。 |
null |
| Tag |
array<object> |
否 |
標籤列表。 |
|
|
object |
否 |
標籤對象。 |
||
| Key |
string |
否 |
標籤鍵。N 的取值範圍:1~20。一旦傳入該值,則不允許為空白字串。最多支援 128 個字元,不能以 |
TestKey |
| Value |
string |
否 |
資源的標籤值。N 的取值範圍:1~20。一旦傳入該值,可以為空白字串。最多支援 128 個字元,不能以 |
TestValue |
| RegionId |
string |
是 |
所屬的地區 ID。您可以調用 DescribeRegions 查看最新的阿里雲地區列表。 |
cn-hangzhou |
| ImagePipelineId |
string |
是 |
鏡像模板 ID。 |
ip-2ze5tsl5bp6nf2b3**** |
| ClientToken |
string |
否 |
保證請求等冪性。從您的用戶端產生一個參數值,確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元,且不能超過 64 個字元。更多詳情,請參見如何保證等冪性。 |
123e4567-e89b-12d3-a456-426655440000 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| ExecutionId |
string |
構建任務 ID。 |
exec-5fb8facb8ed7427c**** |
| RequestId |
string |
請求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
樣本
正常返回樣本
JSON格式
{
"ExecutionId": "exec-5fb8facb8ed7427c****",
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidImage.OsTypeUnsupported | The specified base image does not support image building. | 指定的基礎鏡像作業系統不支援進行鏡像構建。 |
| 400 | InvalidParameter.BuildContent | %s. | 構建模板內容無效。 |
| 400 | InvalidParameter.TestContent | %s. | 測試模板的內容無效。 |
| 400 | InvalidImageComponent.NotSupported | %s. | 指定的鏡像組件不可用。 |
| 400 | Duplicate.TagKey | The Tag.N.Key contain duplicate key. | 標籤中存在重複的鍵,請保持鍵的唯一性。 |
| 400 | InvalidTagKey.Malformed | The specified Tag.N.Key is not valid. Tag keys cannot be empty or null, support up to 128 characters, cannot start with "aliyun" or "acs:", and cannot contain "http://" or "https://". | 指定的標籤鍵無效。標籤鍵不可為空或 null,最多支援 128 個字元,不能以“aliyun”或“acs:”開頭,不能包含“http://”或“https://”。 |
| 400 | InvalidTagValue.Malformed | The specified Tag.N.Value is not valid. Tag values support up to 128 characters, and cannot contain "http://" or "https://". | 指定的標籤值無效。標籤值最多支援 128 個字元,並且不能包含“http://”或“https://”。 |
| 400 | InvalidDockerRepositoryCredential.DockerRegistryMalformed | The specified parameter DockerRepositoryCredential.DockerRegistry is invalid. The length should be between 1 to 512 characters. | 指定的Docker註冊表長度應在1到512字元之間。 |
| 400 | InvalidDockerRepositoryCredential.UserMalformed | The specified parameter DockerRepositoryCredential.User is invalid. The length should be between 1 to 128 characters. | 指定的使用者名稱長度應在1到128字元之間。 |
| 400 | InvalidImageName.Duplicated | The specified image name is already in use. | 指定的鏡像名稱已被使用。 |
| 500 | StartImagePipelineExecution.Failed | Start image pipeline execution failed. | 執行鏡像模版任務失敗。 |
| 403 | InvalidImagePipeline.HasRunningExecution | %s | |
| 403 | InvalidImagePipeline.OSSObjectNotAuthorized | The ImportImageOptions.DiskDeviceMappings.OSSObject of the specified ImagePipeline is not allowed to access. | 指定的入參ImagePipeline中的ImportImageOptions.DiskDeviceMappings.OSSObject不允許被訪問。 |
| 403 | InvalidImagePipeline.OSSObjectNeedRestore | The ImportImageOptions.DiskDeviceMappings.OSSObject of the specified ImagePipeline is an archived object and needs to be restored first. | 指定的ImagePipeline中ImportImageOptions.DiskDeviceMappings.OSSObject是一個歸檔對象,需要先進行恢複。 |
| 403 | InvalidOperation.NoRightAccessOSS | ECS service is not authorized to access your OSS. Check your RAM roles and policies, and ensure that ecs.aliyuncs.com is authorized to assume AliyunECSImageImportDefaultRole. | ECS服務沒有許可權訪問您的OSS。請檢查你的RAM角色和策略,確保"ecs.aliyuncs.com"被授予了扮演"AliyunECSImageImportDefaultRole"的許可權。 |
| 404 | InvalidImagePipeline.NotFound | %s | |
| 404 | InvalidInstanceType.NotFound | The specified instance type does not exist. | 指定的參數“InstanceType”不存在。 |
| 404 | InvalidVSwitchId.NotFound | The specified VSwitchId does not exist. | 指定的VSwitchId不存在 |
| 404 | InvalidRegionId.NotFound | %s | 提供的地區 ID 不存在。 |
| 404 | InvalidImage.NotFound | %s. | 給定的鏡像ID不存在。 |
| 404 | ImageComponent.NotFound | %s. | 指定的鏡像組件ID未找到。 |
| 404 | InvalidImagePipeline.BaseImageNotFound | The BaseImage of the specified ImagePipeline is not found. | 指定模板的基礎鏡像沒有找到。 |
| 404 | InvalidImagePipeline.OSSObjectNotFound | The ImportImageOptions.DiskDeviceMappings.OSSObject of the specified ImagePipeline is not found in this region. | 指定的ImagePipeline的參數ImportImageOptions.DiskDeviceMappings.OSSObject在當前地區沒有查詢到。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。