CLI命令参考
镜像任务
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 异步任务进度查询 | hcloud IMS ShowJobProgress | 该接口为扩展接口,主要用于查询异步任务进度。 |
镜像
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 导出镜像 | hcloud IMS ExportImage | 该接口为扩展接口,用于用户将自己的私有镜像导出到指定的OBS桶中。 | |
| 导出镜像(新) | hcloud IMS ExportImageInSafeMode | 该接口为扩展接口,用于用户将自己的私有镜像导出到指定的OBS桶中。 | |
| 查询镜像列表 | hcloud IMS ListImages | 根据不同条件查询镜像列表信息。 | |
| 更新镜像信息 | hcloud IMS UpdateImage | 更新镜像信息接口,主要用于镜像属性的修改。当前仅支持可用(active)状态的镜像更新相关信息。 | |
| 使用外部镜像文件制作数据镜像 | hcloud IMS CreateDataImage | 使用上传至OBS桶中的外部数据卷镜像文件制作数据镜像。作为异步接口,调用成功,只是说明后台收到了制作请求,镜像是否制作成功需要通过异步任务查询接口查询该任务的执行状态。具体请参考异步任务进度查询。 | |
| 使用外部镜像文件制作数据镜像(新) | hcloud IMS CreateDataImageInSafeMode | 使用上传至OBS桶中的外部数据卷镜像文件制作数据镜像。作为异步接口,调用成功,只是说明后台收到了制作请求,镜像是否制作成功需要通过异步任务查询接口查询该任务的执行状态。具体请参考异步任务进度查询。 | |
| 制作镜像 | hcloud IMS CreateImage | 本接口用于制作私有镜像,支持:
| |
| 制作镜像(新) | hcloud IMS CreateImageInSafeMode | 本接口用于制作私有镜像,支持:
| |
| 注册镜像 | hcloud IMS RegisterImage | 该接口用于将镜像文件注册为云平台未初始化的私有镜像。 | |
| 镜像文件快速导入 | hcloud IMS ImportImageQuick | 使用上传至OBS桶中的超大外部镜像文件制作私有镜像,目前仅支持RAW或ZVHD2格式镜像文件。且要求镜像文件大小不能超过1TB。 | |
| 镜像文件快速导入(新) | hcloud IMS ImportImageQuickInSafeMode | 使用上传至OBS桶中的超大外部镜像文件制作私有镜像,目前仅支持RAW或ZVHD2格式镜像文件。且要求镜像文件大小不能超过1TB。 | |
| 制作整机镜像 | hcloud IMS CreateWholeImage | 使用云服务器或者云服务器备份制作整机镜像。作为异步接口,调用成功,只是说明后台收到了制作整机镜像的请求,镜像是否制作成功需要通过异步任务查询接口查询该任务的执行状态,具体请参考异步任务进度查询。 | |
| 查询镜像支持的OS列表 | hcloud IMS ListOsVersions | 查询当前区域弹性云服务器的OS兼容性列表。 |
镜像共享
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 批量添加镜像成员 | hcloud IMS BatchAddMembers | 该接口为扩展接口,主要用于镜像共享时用户将多个镜像共享给多个用户。 | |
| 批量更新镜像成员状态 | hcloud IMS BatchUpdateMembers | 该接口为扩展接口,主要用于用户接受或者拒绝多个共享镜像时批量更新镜像成员的状态。 | |
| 批量删除镜像成员 | hcloud IMS BatchDeleteMembers | 该接口为扩展接口,主要用于取消镜像共享。 | |
| 获取镜像成员详情 | hcloud IMS ShowImageMember | 该接口主要用于镜像共享中查询某个镜像成员的详情。 | |
| 获取镜像成员列表 | hcloud IMS ListImageMembers | 该接口用于共享镜像过程中,获取接受该镜像的成员列表。 |
镜像复制
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| Region内复制镜像 | hcloud IMS CopyImageInRegion | 该接口为扩展接口,主要用于用户将一个已有镜像复制为另一个镜像。复制镜像时,可以更改镜像的加密等属性,以满足不同的场景。 | |
| Region内复制镜像(新) | hcloud IMS CopyImageInRegionInSafeMode | 该接口为扩展接口,主要用于用户将一个已有镜像复制为另一个镜像。复制镜像时,可以更改镜像的加密等属性,以满足不同的场景。 | |
| 跨Region复制镜像 | hcloud IMS CopyImageCrossRegion | 该接口为扩展接口,用户在一个区域制作的私有镜像,可以通过跨Region复制镜像将镜像复制到其他区域,在其他区域发放相同类型的云服务器,帮助用户实现区域间的业务迁移。 |
镜像标签
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 按条件查询租户镜像标签列表 | hcloud IMS ListTags | 根据不同条件查询镜像标签列表信息。 | |
| 增加或修改标签 | hcloud IMS CreateOrUpdateTags | 该接口主要用于为某个镜像增加或修改一个自定义标签。通过自定义标签,用户可以将镜像进行分类。 | |
| 按标签查询镜像 | hcloud IMS ListImageByTags | 该接口用于按标签或其他条件对镜像进行过滤或者计数使用。 | |
| 查询租户所有镜像标签 | hcloud IMS ListImagesTags | 该接口用于查询租户的所有镜像上的标签。 | |
| 查询镜像标签 | hcloud IMS ListImageTags | 该接口用于查询指定镜像上的所有标签。 | |
| 添加镜像标签 | hcloud IMS AddImageTag | 该接口用于为指定镜像添加或更新指定的单个标签。 | |
| 批量添加删除镜像标签 | hcloud IMS BatchAddOrDeleteTags | 该接口用于为指定镜像批量添加/更新、删除标签。 | |
| 删除镜像标签 | hcloud IMS DeleteImageTag | 该接口用于为镜像删除指定的标签。 | |
| 批量删除镜像标签 | hcloud IMS BatchDeleteTags | 该接口用于为指定镜像批量删除标签。 |
镜像配额
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询镜像配额 | hcloud IMS ShowImageQuota | 该接口为扩展接口,主要用于查询租户在当前Region的私有镜像的配额数量。 |
镜像共享(OpenStack原生)
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 获取镜像成员列表(OpenStack原生) | hcloud IMS GlanceListImageMembers | 该接口用于共享镜像过程中,获取接受该镜像的成员列表。 | |
| 添加镜像成员(OpenStack原生) | hcloud IMS GlanceAddImageMember | 用户共享镜像给其他用户时,使用该接口向该镜像成员中添加接受镜像用户的项目ID。 | |
| 获取镜像成员详情(OpenStack原生) | hcloud IMS GlanceShowImageMember | 该接口主要用于镜像共享中查询某个镜像成员的详情。 | |
| 更新镜像成员状态(OpenStack原生) | hcloud IMS GlanceUpdateImageMember | 用户接受或者拒绝共享镜像时,使用该接口更新镜像成员的状态。 | |
| 删除指定的镜像成员(OpenStack原生) | hcloud IMS GlanceDeleteImageMember | 该接口用于取消对某个用户的镜像共享。 |
镜像标签(OpenStack原生)
镜像视图(OpenStack原生)
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询镜像视图(OpenStack原生) | hcloud IMS GlanceShowImageSchemas | 该接口主要用于查询镜像视图,通过视图,用户可以了解到镜像包含哪些属性,同时也可以了解每个属性的数据类型等。 | |
| 查询镜像成员列表视图(OpenStack原生) | hcloud IMS GlanceListImageMemberSchemas | 该接口主要用于查询镜像成员列表视图,通过视图,用户可以了解到镜像成员包含哪些属性,同时也可以了解每个属性的数据类型。 | |
| 查询镜像列表视图(OpenStack原生) | hcloud IMS GlanceListImageSchemas | 该接口主要用于查询镜像列表视图,通过该接口用户可以了解到镜像列表的详细情况和数据结构。 | |
| 查询镜像成员视图(OpenStack原生) | hcloud IMS GlanceShowImageMemberSchemas | 该接口主要用于查询镜像成员视图,通过视图,用户可以了解到镜像成员包含哪些属性,同时也可以了解每个属性的数据类型。 |
镜像(OpenStack原生)
| API名称 | 命令 | 描述 | 操作 |
|---|---|---|---|
| 查询镜像列表(OpenStack原生) | hcloud IMS GlanceListImages | 获取镜像列表。 | |
| 创建镜像元数据(OpenStack原生) | hcloud IMS GlanceCreateImageMetadata | 创建镜像元数据。调用创建镜像元数据接口成功后,只是创建了镜像的元数据,镜像对应的实际镜像文件并不存在。 | |
| 查询镜像详情(OpenStack原生) | hcloud IMS GlanceShowImage | 查询单个镜像详情,用户可以通过该接口查询单个私有或者公共镜像的详情。 | |
| 删除镜像(OpenStack原生) | hcloud IMS GlanceDeleteImage | 该接口主要用于删除镜像,用户可以通过该接口将自己的私有镜像删除。 | |
| 更新镜像信息(OpenStack原生) | hcloud IMS GlanceUpdateImage | 修改镜像信息。 |