1. 接口描述
接口请求域名: cvm.api3.gsesgpucloud.com。
本接口(ImportImage)用于导入镜像,导入后的镜像可用于创建实例。
默认接口请求频率限制:10次/秒。
接口更新时间:2022-10-27 11:52:47。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
参数名称 | 必选 | 允许NULL | 类型 | 描述 |
---|---|---|---|---|
Action | 是 | 否 | String | 公共参数,本接口取值:ImportImage |
Version | 是 | 否 | String | 公共参数,本接口取值:2017-03-12 |
Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
Architecture | 是 | 否 | String | 导入镜像的操作系统架构,x86_64 或 arm_64 示例值: x86_64 |
OsType | 是 | 否 | String | 导入镜像的操作系统类型,通过DescribeImportImageOs 获取示例值: CentOS |
OsVersion | 是 | 否 | String | 导入镜像的操作系统版本,通过DescribeImportImageOs 获取示例值: 6 |
ImageUrl | 是 | 否 | String | 导入镜像存放的cos地址 示例值: http://111-1251433127.cosd.myqcloud.com/Windows%20Server%202008%20R2%20x64a.vmdk |
ImageName | 是 | 否 | String | 镜像名称。镜像名称不能与已有的自定义镜像名称重复,长度不超过60 示例值: sample |
ImageDescription | 否 | 否 | String | 镜像描述 示例值: sampleimage |
DryRun | 否 | 否 | Bool | 只检查参数,不执行任务 示例值: false |
Force | 否 | 否 | Bool | 是否强制导入,参考强制导入镜像 示例值: false |
PublicImage | 否 | 否 | Bool | 是否导入公共镜像,导入公共镜像为true ,走imagestage流程,默认为false ;示例值: true |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ImageId | String | 镜像id 示例值: img-c1otssej |
TaskId | String | 任务ID 示例值: 432322 |
FlowId | Int64 | 任务流转ID 示例值: 3 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.NoAvailablePublicImage | 没有可用的公共镜像。 |
FailedOperation.NoQuotaForUserInstance | 配额不足,无法创建实例。 |
FailedOperation.NoAvailableInstanceFamily | 没有可用的实例族。 |
FailedOperation.NoAvailableInstanceType | 没有可用的实例类型。 |
FailedOperation.NoAvailableIpAddressCount | 子网没有可用的ip地址。 |
FailedOperation.NoAvailableCbs | 没有可用的云盘资源。 |
FailedOperation.NoCVMPermission | 没有实例操作权限。 |
FailedOperation.NoAvailableVpc | 没有可用的Vpc资源。 |
FailedOperation.NoAvailableSubnet | 没有可用的子网资源。 |
FailedOperation.NoAvailableSecurityGroup | 没有可用的安全组。 |
ImageQuotaLimitExceeded | 镜像配额超过了限制。 |
InvalidImageName.Duplicate | 镜像名称与原有镜像重复。 |
InvalidImageOsVersion.Unsupported | 不支持的操作系统版本。 |
InvalidParameter.InvalidParameterUrlError | 错误的url地址。 |
RegionAbilityLimit.UnsupportedToImportImage | 该地域不支持导入镜像。 |
InvalidImageOsType.Unsupported | 不支持的操作系统类型。 |
MissingParameter | 参数缺失。请求没有带必选参数。 |