外部镜像导入
最近更新时间: 2024-09-03 18:49:49
1. 接口描述
接口请求域名: cvm.api3.cloud.sunhongs.com。
本接口(ImportImage)用于导入镜像,导入后的镜像可用于创建实例。
默认接口请求频率限制:10次/秒。
接口更新时间:2023-07-19 10:40:59。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:ImportImage |
| Version | 是 | 否 | String | 公共参数,本接口取值:2017-03-12 |
| Region | 是 | 否 | String | 公共参数,详见产品支持的地域列表(TODO) |
| Architecture | 是 | 否 | String | 导入镜像的操作系统架构,x86_64 或 arm_64 |
| OsType | 是 | 否 | String | 导入镜像的操作系统类型,通过DescribeImportImageOs获取 |
| OsVersion | 是 | 否 | String | 导入镜像的操作系统版本,通过DescribeImportImageOs获取 |
| ImageUrl | 是 | 否 | String | 导入镜像存放的cos地址 |
| ImageName | 是 | 否 | String | 镜像名称。镜像名称不能与已有的自定义镜像名称重复,长度不超过60 |
| ImageDescription | 否 | 否 | String | 镜像描述 |
| DryRun | 否 | 否 | Bool | 只检查参数,不执行任务 |
| Force | 否 | 否 | Bool | 是否强制导入,参考强制导入镜像 |
| PublicImage | 否 | 否 | Bool | 是否导入公共镜像,导入公共镜像为true,走imagestage流程,默认为false; |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ImageId | String | 此参数对外不可见。 镜像id |
| TaskId | String | 此参数对外不可见。 任务ID |
| FlowId | Int64 | 此参数对外不可见。 任务流转ID |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.NoAvailablePublicImage | |
| FailedOperation.NoQuotaForUserInstance | |
| FailedOperation.NoAvailableInstanceFamily | |
| FailedOperation.NoAvailableInstanceType | |
| FailedOperation.NoAvailableIpAddressCount | |
| FailedOperation.NoAvailableCbs | |
| FailedOperation.NoCVMPermission | |
| FailedOperation.NoAvailableVpc | |
| FailedOperation.NoAvailableSubnet | |
| FailedOperation.NoAvailableSecurityGroup | |
| ImageQuotaLimitExceeded | |
| InvalidImageName.Duplicate | |
| InvalidImageOsVersion.Unsupported | |
| InvalidParameter.InvalidParameterUrlError | |
| RegionAbilityLimit.UnsupportedToImportImage | |
| InvalidImageOsType.Unsupported | |
| MissingParameter |