CreateCustomImage_轻量应用服务器_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

自定义镜像是您通过轻量应用服务器的快照创建的镜像。您可以通过已配置好的自定义镜像创建更多包含相同配置的轻量应用服务器,也可以将自定义镜像共享至云服务器 ECS,进而通过共享镜像创建 ECS 实例或更换操作系统。 关于自定义镜像的更多消息,请参见自定义镜像概述

创建自定义镜像之前,您需要先创建轻量应用服务器的系统盘快照。具体操作,请参见 CreateSnapshot

说明 如果您创建自定义镜像时需要服务器的数据盘数据,请先创建一份服务器的数据盘快照。

创建自定义镜像时,您需要先阅读以下注意事项:

  • 创建的自定义镜像所属地域与对应的轻量应用服务器所属地域相同。

  • 创建的自定义镜像数量上限为已创建的服务器数量的 3 倍,但最多不超过 15 个。

  • 只有服务器的系统盘快照可以直接创建自定义镜像。如果您需要自定义镜像中包含服务器的数据盘数据,在创建自定义镜像的过程中,需要手动选择对应的数据盘快照。

  • 如果轻量应用服务器到期或者退款后释放,该服务器对应的自定义镜像也会随之释放。

  • 重置系统或更换镜像会清除服务器上的磁盘数据,请您根据需要做好数据备份。

流控信息

请求速率为100/60(s)。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
swas-open:CreateCustomImage
Create
CustomImage
acs:swas-open:{#regionId}:{#accountId}:customimage/*

请求参数

字段名称字段详情
RegionIdstring

地域 ID。您可以调用 ListRegions 查询可用地域。

示例值:cn-hangzhou参考取值来源:
    ListRegions
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

示例值:123e4567-e89b-12d3-a456-426655440000
InstanceIdstring

指定的轻量应用服务器的实例 ID。

示例值:ace0706b2ac4454d984295a94213****参考取值来源:
    ListInstances
    CreateInstances
    DescribeDatabaseInstances
ImageNamestring

自定义镜像名称。长度为 2~128 个英文或中文字符,必须以大小写字母或中文开头或数字开头,可以包含数字、半角冒号(:)、下划线(_)或者短划线(-)。展开详情

示例值:customImage-test参考取值来源:
    ListImages
SystemSnapshotIdstring

系统盘快照 ID。

示例值:s-acscasca****
Descriptionstring

镜像描述信息。

示例值:test
DataSnapshotIdstring

数据盘快照 ID。

示例值:s-acscasca****
Tagarray<object>

标签列表,最多包含 20 个子项。

子级条数 <= 100
ResourceGroupIdstring

资源组 ID。

示例值:rg-aek2bti7cf7****

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
ImageIdstring

自定义镜像 ID。

示例值:m-csaascsaccscs****

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidParam.DataSnapshotIdNotFound
The specified parameter dataSnapshotId is not found.诊断
400
InvalidParam.SystemSnapshotIdNotFound
The specified parameter systemSnapshotId is not found.诊断
400
InvalidParam.IllegalImageName
The specified parameter imageName is illegal.诊断
400
ImageNameAlreadyExist
The image name already exists.诊断
400
CustomImageQuotaLimit
The maximum number of custom image in this region is exceeded.诊断
400
InvalidParam.SystemSnapshotIdNotSupport
You cannot create custom images in the specified parameter system snapshotId.诊断
403
IncorrectInstanceStatus
The state of the current instance does not support this operation.诊断
404
InvalidInstanceId.NotFound
The specified InstanceId does not exist.诊断
500
InternalError
An error occurred while processing your request.诊断

变更历史

变更时间变更内容概要操作
2024-08-08
删除请求参数ResoureGroupId
新增请求参数ResourceGroupId
2024-05-29
新增请求参数ResoureGroupId
2024-04-17
变更请求参数SystemSnapshotId
2024-02-20
新增请求参数Tag
2021-10-27
新增OpenAPI,创建自定义镜像

相关示例