BuilderImageByParent - 基于已有镜像创建镜像

更新时间:
复制 MD 格式

基于已有镜像创建自定义镜像,并启动镜像制作任务。

接口说明

调用前请确认父镜像可用,且在制作地域存在可用的镜像分发记录。

  1. 调用 ListImage 获取父镜像 ID。

  2. 指定制作模式、磁盘容量和资源类型,调用本接口。

  3. 保存返回的 ImageId、VersionId 和 TaskId。

  4. 调用 GetTask 查询制作进度。请求处理成功不代表镜像已制作完成。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

appstreaming:BuilderImageByParent

create

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

ImageName

string

否

新镜像名称。必须提供。必须以字母或中文开头,可包含字母、数字、中文、半角冒号(:)、下划线(_)、英文句点(.)和短划线(-),不能以 http:// 或 https:// 开头。长度按中文字符计 3、其他字符计 1 计算,合计为 2~64。

OfficeImage_202611

PackageType

string

否

镜像封装类型。请与所选父镜像及制作场景保持一致。可选值:

  • Ecs:ECS 实例镜像。

  • Vhd:VHD 应用镜像。

  • Container:容器镜像。

  • Ecs_Container:ECS 与容器组合镜像。

  • K8s_Node:Kubernetes 节点镜像。

当前接口没有提供 BaseImageId 参数,不能显式指定需要另行配置基础镜像的 Vhd 或 Container 类型。

Ecs

BizType

integer

否

镜像所属业务类型。必须提供。可选值:

  • 1:基础产品。

  • 2:个人云。

  • 3:云上办公室。

  • 4:云 Flow。

  • 10:个人版。

  • 20:商业版。

  • 60:灵构团队版。

1

ProductType

string

否

镜像所属产品。必须提供。请使用已开通的产品,且与所选父镜像保持一致。可选值:

  • CloudGame:云游戏。

  • CloudApp:无影云应用。

  • CloudBrowser:安全浏览器。

  • CloudDesktop:无影云电脑。

  • ImageBuilder:镜像制作资源。

  • ImageValidate:镜像验证资源。

  • AndroidCloud:安卓云。

  • GpuRender:GPU 渲染。

  • AndroidGpuRender:安卓云 GPU 渲染。

  • WuyingServer:企业版工作站。

  • GpuProxy:GPU 远程渲染代理。

  • GpuCache:GPU 远程渲染缓存。

  • AIAgent:AI Agent 服务。

  • HostedDesktop:托管电脑。

  • WuyingWorkstation:个人版容器工作站。

  • WuyingWorkstationBusiness:商业版容器工作站。

  • WuyingWorkstationTeam:灵构容器工作站团队版。

CloudApp

Language

string

否

镜像语言。可选值:

  • zh-CN:简体中文。

  • zh-HK:繁体中文(香港)。

  • en-US:英语。

  • ja-JP:日语。

  • CN:简体中文的兼容取值。

  • EN:英语的兼容取值。

  • JP:日语的兼容取值。

  • CN-HK:繁体中文(香港)的兼容取值。

zh-CN

Description

string

否

新镜像的用途说明,便于后续查询和区分镜像。

包含办公应用及标准配置的业务镜像

ParentImageId

string

是

用于制作新镜像的父镜像 ID。必填。可调用 ListImage 查询;制作地域必须存在该父镜像的可用分发记录。

imgc-bp1parent****

PropertyMap

object

否

镜像扩展属性。键和值均为字符串;无需扩展配置时可省略。

驱动列表对应的属性键为 DRIVER_LIST,值为驱动 ID 数组的 JSON 字符串。建议通过 DriverIdList 指定驱动;**同时传入 DriverIdList 和 PropertyMap.DRIVER_LIST 时,以 DriverIdList 为准。**其他扩展属性仅在已确认其用途及取值时填写。

{"DRIVER_LIST":"[\"6d4af751-f522-40d7-ab6c-4a0ae587****\",\"b5bdf6c0-41de-4878-8963-e8324106****\"]"}

string

否

一个镜像扩展属性的字符串值。

["6d4af751-f522-40d7-ab6c-4a0ae587****","b5bdf6c0-41de-4878-8963-e8324106****"]

ImageCreateMode

string

是

镜像制作模式。当前请使用以下模式:

  • BUILDER_MANUAL:手动进入制作环境安装应用并配置镜像。

BUILDER_MANUAL

SystemDiskSize

integer

是

制作环境的系统盘容量。单位:GiB。容量不能小于父镜像所需的系统盘容量,并应满足所选资源规格的磁盘要求。

80

DataDiskSize

integer

否

制作环境的数据盘容量。单位:GiB。需要数据盘时填写,并满足所选资源规格的磁盘要求。

100

PerformanceType

string

是

制作资源的计算类型。

  • CPU:使用 CPU 计算资源。

  • GPU:使用 GPU 计算资源。

CPU

ResourceList

array<object>

否

镜像制作所需的资源列表,例如待安装应用的下载地址。最多 100 项;每项的 ResourceType 与 Resource 必须相互对应。

object

否

ResourceType

string

否

资源内容的提供方式。可选值:

  • HOSTED:托管资源。

  • TEXT:文本资源。

  • URL:通过 URL 提供的资源。

URL

Resource

string

否

与 ResourceType 对应的资源内容。URL 类型填写或返回可访问的资源地址。

https://example.com/apps/business/setup.exe

RunMode

string

否

镜像制作环境的运行模式。可选值:

  • NORMAL:普通运行模式。

  • COMPATIBLE:兼容运行模式。

NORMAL

VersionName

string

否

新镜像版本的显示名称,用于区分同一镜像的不同版本。

办公环境-202611

Distro

string

否

镜像操作系统发行版信息。填写与所用父镜像一致的发行版标识。

Ubuntu 22.04 64位

SourceRegion

string

否

镜像制作地域 ID。所选父镜像必须已分发到该地域;可用地域还受账号和产品的地域配置影响。

cn-hangzhou

DriverIdList

array

否

制作镜像时使用的驱动 ID 列表,最多 200 项。需要指定驱动时填写已存在且适用于目标镜像的驱动 ID。

同时指定 PropertyMap.DRIVER_LIST 时,本参数会覆盖其中的驱动列表。

["6d4af751-f522-40d7-ab6c-4a0ae587****","b5bdf6c0-41de-4878-8963-e8324106****"]

string

否

一个已存在的镜像驱动 ID。

6d4af751-f522-40d7-ab6c-4a0ae587****

OfficeSiteId

string

否

制作资源使用的办公网络 ID。需要使用指定办公网络时填写,并与制作地域保持一致。

cn-hangzhou+dir-example****

NodeInstanceType

string

否

制作资源的节点规格 ID。可通过 ListNodeInstanceType 查询;应选择在制作地域和所属产品下可用、且满足 CPU 或 GPU 计算要求的规格。

appstreaming.general.4c8g

VSwitchIdList

array

否

制作资源使用的交换机 ID 列表,最多 100 项。交换机须属于所选办公网络并位于制作地域。

string

否

制作地域内的一个交换机 ID。

vsw-bp1example****

返回参数

名称

类型

描述

示例值

object

本次 API 调用的响应结果。

Data

object

本次操作返回的业务数据。

ImageId

string

镜像 ID,用于后续查询或修改镜像。

imgc-bp1example****

VersionId

string

镜像版本 ID,用于查询或操作该镜像的指定版本。

iv-bp1example****

TaskId

string

任务 ID,可用于调用 GetTask 查询任务状态。

tid-bp1example****

Success

boolean

请求是否处理成功。true 表示本次请求处理成功;异步任务是否完成须另外查询任务状态。

Code

string

错误码。请求失败时返回;成功响应可能不包含该字段。

ExceedBuilderQuota

Message

string

错误或结果提示。请求失败时用于说明原因,成功响应可能不包含该字段。

The maximum number of builders is reached.

RequestId

string

本次请求的唯一标识,排查问题时可提供该值。

01A1A962-5503-107B-AC8F-EBA85DF905AC

示例

正常返回示例

JSON格式

{
  "Data": {
    "ImageId": "imgc-bp1example****",
    "VersionId": "iv-bp1example****",
    "TaskId": "tid-bp1example****"
  },
  "Success": true,
  "Code": "ExceedBuilderQuota",
  "Message": "The maximum number of builders is reached.",
  "RequestId": "01A1A962-5503-107B-AC8F-EBA85DF905AC"
}

错误码

HTTP status code

错误码

错误信息

描述

400 ExceedBuilderQuota The maximum number of builders is reached. Builder数量达到了上限。
400 InvalidBaseImage.NotConfigured Configuration required for Vhd/Container images. Vhd/Container镜像类型需要配置BaseImageId。
400 CreateDesktopImageRecord.Failed Create cloud computer image failed. 创建云电脑镜像失败。
400 Image.NotExist The image does not exist. 镜像不存在。
400 ImageRegionDistribute.NotAllow This image cannot be distributed. 镜像不允许分发操作。
400 ImageUpdateFailed.NotAllow The image is not allowed to be modified. 镜像不允许修改。
400 ImageUpdateSharedImageFailed.NotAllow The shared image is not allowed to be modified. 共享镜像不允许修改。
400 ImageCreateByInstance.TaskExist The image task of instance creation already exists. 实例创建镜像任务已存在。
400 ParentImageRegionDistribute.NotExist The target distribution region of the parent image does not exist. 依赖父镜像分发地址不存在。
400 InternalError Internal error. 内部错误

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。