調用CreateImageCache接口創建一個鏡像緩存,以便后續創建ECI實例可以加速鏡像拉取,減少實例啟動耗時。
接口說明
注意事項
- 創建鏡像緩存涉及資源計費。建議您提前了解相關計費信息。更多信息,請參見鏡像緩存計費。
- 創建鏡像緩存前,您需要評估待緩存鏡像的總大小,如果鏡像總大小超過設置的緩存大小,將會創建失敗。
- 創建鏡像緩存時,系統將自動創建一個 ECI 實例和一塊 ESSD PL1 類型的云盤用于中轉創建鏡像緩存。創建過程中請勿刪除 ECI 實例和云盤,否則鏡像緩存將創建失敗。
- 創建鏡像緩存將生成對應的快照。請勿刪除快照,否則鏡像緩存將會失效。
- 如果使用 SDK,則對應版本為:Java 1.0.10 以上,Python 1.0.7 以上。
使用建議
- 對于使用自定義域名的 ACR 企業版鏡像,需要指定 ACR 實例(設置 AcrRegistryInfo 相關參數)來配置免密。設置 AcrRegistryInfo 相關參數時,必須設置 AcrRegistryInfo.N.InstanceId。
- 如果該鏡像緩存將用于批量創建多個(超過 1000 個)ECI 實例,建議您設置 StandardCopyCount 和 FlashCopyCount 實現快照多副本功能。快照多副本按增量數據收費,由于本次創建的多個快照副本數據均一致,因此使用快照多副本功能不會增加額外費用。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
eci:CreateImageCache | create | *ImageCache acs:eci:{#regionId}:{#accountId}:imagecache/* |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
ZoneId | string | 否 | 可用區。 | cn-hangzhou-g |
SecurityGroupId | string | 是 | 安全組 ID。 | sg-uf66jeqopgqa9hdn**** |
VSwitchId | string | 是 | 交換機 ID。支持指定多個交換機 ID(單次最多 10 個),各交換機 ID 之間可以用半角逗號(,)進行分割,例如 | vsw-uf6h3rbwbm90urjwa**** |
ImageCacheName | string | 是 | 鏡像緩存名稱。 | testcache |
EipInstanceId | string | 否 | 彈性公網 IP。如果需要拉取公網鏡像,需要確保 ECI 實例能夠訪問公網,您可以配置 EIP 或者 NAT 網關實現公網訪問。 | eip-2zedsm5mfl3uhdj2d**** |
ResourceGroupId | string | 否 | 資源組 ID。 | rg-aekzh43v***** |
ClientToken | string | 否 | 保證請求冪等性。從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。只支持 ASCII 字符,且不能超過 64 個字符。更多信息,請參見如何保證冪等性。 | 123e4567-xxx-xxx-xxxx-42665544xxxx |
ImageCacheSize | integer | 否 | 鏡像緩存的大小。默認為 20 GiB。 | 20 |
RetentionDays | integer | 否 | 鏡像緩存保留時間,過期將會被清理,默認永不過期。 說明
創建失敗的鏡像緩存僅保留一天。
| 7 |
AutoMatchImageCache | boolean | 否 | 是否開啟鏡像緩存復用。開啟后,新創建的鏡像緩存可以復用已有鏡像緩存的鏡像層,加快鏡像緩存的制作速度。取值范圍:
默認為 false。 | true |
ImageRegistryCredential | array<object> | 否 | 鏡像倉庫信息。 | |
object | 否 | 鏡像倉庫信息。 | ||
Password | string | 否 | 鏡像倉庫密碼。 | password |
Server | string | 否 | 不帶 | registry-vpc.cn-hangzhou.aliyuncs.com |
UserName | string | 否 | 鏡像倉庫用戶名。 | username |
Image | array | 是 | 用于制作鏡像緩存的容器鏡像。 | |
string | 是 | 用于制作鏡像緩存的容器鏡像。 | registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.15.10-perl | |
Tag | array<object> | 否 | 鏡像緩存標簽信息,最多 20 個。 | |
object | 否 | 鏡像緩存標簽信息,最多 20 個。 | ||
Key | string | 否 | 鏡像緩存標簽鍵。 | imc |
Value | string | 否 | 鏡像緩存標簽值。 | test |
Flash | boolean | 否 | 是否開啟極速鏡像緩存功能,開啟后,可以加速鏡像緩存創建。取值范圍:
默認為 false。 | true |
AcrRegistryInfo | array<object> | 否 | ACR 實例信息。更多信息,請參見免密拉取 ACR 鏡像。 | |
object | 否 | ACR 實例信息。 | ||
Domain | array | 否 | ACR 企業版實例的域名。默認為相應實例的所有域名。支持指定個別域名,多個以半角逗號分隔。 | |
string | 否 | ACR 企業版實例的域名。默認為相應實例的所有域名。支持指定個別域名,多個以半角逗號分隔。 | test****-registry.cn-beijing.cr.aliyuncs.com | |
InstanceName | string | 否 | ACR 企業版實例的名稱。 | test**** |
InstanceId | string | 否 | ACR 企業版實例 ID。 | cri-nwj395hgf6f3**** |
RegionId | string | 否 | ACR 企業版實例所屬地域。 | cn-beijing |
ArnService | string | 否 | ECI 實例等資源歸屬賬號下的 RAM 角色的 ARN。 | acs:ram::1609982529******:role/role-assume |
ArnUser | string | 否 | ACR 實例歸屬賬號下的 RAM 角色的 ARN。 | acs:ram::1298452580******:role/role-acr |
Annotations | string | 否 | 注解。該參數暫不對外使用。 | hide |
PlainHttpRegistry | string | 否 | 自建鏡像倉庫地址。使用 HTTP 協議的自建鏡像倉庫中的鏡像創建鏡像緩存時,需配置該參數,使得 ECI 使用 HTTP 協議拉取鏡像,避免因協議不同而導致鏡像拉取失敗。 | "harbor***.pre.com,192.168.XX.XX:5000,reg***.test.com:80" |
InsecureRegistry | string | 否 | 自建鏡像倉庫地址。 使用自簽發證書的自建鏡像倉庫中的鏡像創建鏡像緩存時,需配置該參數來跳過證書認證,避免因證書認證失敗而導致鏡像拉取失敗。 | "harbor***.pre.com,192.168.XX.XX:5000,reg***.test.com:80" |
StandardCopyCount | integer | 否 | 標準快照副本數。默認情況下,一個鏡像緩存對應一個快照。如果該鏡像緩存將用于批量創建多個 ECI 實例,建議您配置該參數實現快照多副本。推薦每 1000 個 ECI 實例增加一個快照副本。 說明
未開啟極速鏡像緩存功能(Flash 取值為 false)時,創鏡像緩存的過程中僅生成標準快照。
| 7 |
FlashCopyCount | integer | 否 | 本地快照副本數。默認情況下,一個鏡像緩存對應一個快照。如果該鏡像緩存將用于批量創建多個 ECI 實例,建議您配置該參數實現快照多副本。推薦每 1000 個 ECI 實例增加一個快照副本。 說明
開啟極速鏡像緩存功能(Flash 取值為 true)時,創建鏡像緩存的過程中將先創建本地快照,在本地快照創建完成后開始創建標準快照,待標準快照創建完成后會自動刪除本地快照。
| 7 |
EliminationStrategy | string | 否 | 鏡像緩存的淘汰策略。默認為空,表示一直保留。 支持配置為 LRU,表示可以被自動刪除。當鏡像緩存數量達到配額限制時,系統將自動刪除最不常用的 EliminationStrategy 為 LRU 的鏡像緩存。 | LRU |
OsType | string | 否 | 容器鏡像的操作系統。取值范圍:
說明
Windows 正在邀測中,如需使用,請提交工單申請。
| Linux |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "0E234675-3465-4CC3-9D0F-9A864BC391DD",
"ImageCacheId": "imc-2zebxkiifuyzzlhl****",
"ContainerGroupId": "eci-2zebxkiifuyzzlhl****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | Account.Arrearage | Your account has an outstanding payment. | 賬號已經欠費。 |
400 | DryRunOperation | Request validation has been passed with DryRun flag set. | 此次DryRun預檢請求合格。 |
400 | InvalidParameter.CPU.Memory | The specified cpu and memory are not allowed | - |
400 | IncorrectStatus | %s | 指定的實例狀態不正確。 |
400 | ServiceNotEnabled | %s | 該次請求所依賴的服務沒有開通,請開通后再試。 |
400 | DiskVolume.NotSupport | The disk volume is not supported. | 云盤卷暫不支持,如有需要請聯系我們。 |
400 | RamRole.NotSupport | The RAM role is not supported. | ram實例角色不支持。 |
400 | ImageCache.IncorrectStatus | %s | 鏡像緩存當前的狀態不對。 |
400 | ImageCacheNotSupport | Image cache is not available for all users. If you want to enable this function, contact us. | 鏡像緩存功能還未全網開放,如果有需要請聯系我們。 |
400 | EipAddressPoolIpNotEnough | The ip address of specified PublicIpAddressPool is not enough. | 指定的eip公網地址池地址資源不足。 |
400 | OperationConflict | The request was denied. It conflicts with a previous request. | 該請求被禁止,因為與之前的請求沖突 |
403 | OperationDenied.VswZoneMisMatch | The specified VSwitchId is not in the specified Zone. | - |
403 | QuotaExceeded | %s quota exceeded. | 用戶允許創建的實例已經超過限制。 |
403 | Zone.NotOnSale | The specified zone is not available for purchase. | 創建實例的可用區已經關閉售賣,請更換其他可用區。或者無法在該可用區使用指定 VPC 的虛擬交換機。 |
403 | Forbidden.RiskControl | This operation has been identified as an abnormal operation and cannot be processed. | 此操作已被確定為一個操作異常,無法處理。 |
403 | Forbidden.SubUser | The specified action is not available for you. | 當前用戶無法執行該操作。 |
403 | Forbidden.OnlyForInvitedTest | Eci create action is only open to invited users during public beta. | Eci公測階段只對受邀的用戶開放。 |
403 | OperationDenied.SecurityGroupMisMatch | The specified VSwitchId and SecurityGroupId are not in the same VPC. | 指定的交換機和安全組不在同一個VPC下。 |
403 | InvalidVSwitchId.IpNotEnough | The specified VSwitch does not have enough IP addresses. | - |
403 | Forbidden.UserBussinessStatus | This operation is not allowed, because you have overdue bills. Pay the overdue bill and try again. | 用戶處于欠費狀態不允許創建,請充值后再嘗試。 |
403 | Forbidden.UserNotRealNameAuthentication | This operation is not allowed, because you have not passed the real-name verification. | 操作被禁止,因為用戶還未進行實名認證。 |
403 | InvalidUser.PassRoleForbidden | The RAM user is not authorized to assume a RAM role. | 子賬號用戶沒有權限使用RAM實例角色。 |
403 | OperationDenied.NoStock | Sales of this resource are temporarily suspended in the specified zone. We recommend that you use the multi-zone creation function to avoid the risk of insufficient resource. For more information, see http://bestwisewords.com/document_detail/157290.html | - |
403 | NoPermission | The RAM role AliyunECIContainerGroupRole does not belong to eci.aliyuncs.com. Please check and try again. | - |
403 | SecurityRisk.3DVerification | We have detected a security risk with your default credit or debit card. Please proceed with verification via the link in your email. | 我們檢測到您的默認信用卡或借記卡存在安全風險。請通過電子郵件中的鏈接進行驗證。 |
403 | CreateServiceLinkedRole.Denied | Please make sure the account has ram:CreateServiceLinkedRole permission. | 請確保賬號擁有ram:CreateServiceLinkedRole權限。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-09-26 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-08-02 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-06-27 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2022-03-01 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2022-03-01 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2021-09-10 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2021-08-12 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |