CreateImageComponent_云服务器 ECS_API文档-阿里云OpenAPI开发者门户

接口说明

创建镜像组件前，您需要注意：

仅支持创建您自定义的镜像组件。
相同名称的组件版本号不能重复，当在模板中使用组件时，可以通过名称和版本号进行引用。
镜像组件的内容大小不能超过 16 KB。支持的命令详情，请参见镜像构建服务支持的命令说明。

更多信息，请参见镜像构建概述。

流控信息

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

授权信息

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

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

ecs:CreateImageComponent	Create	ImageComponent acs:ecs:{#regionId}:{#accountId}:imagecomponent/*	无	无

请求参数

字段名称	字段详情
RegionIdstring	所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。示例值:cn-hangzhou参考取值来源: DescribeRegions
ResourceGroupIdstring	企业资源组 ID。示例值:rg-bp67acfmxazb4p****参考取值来源: DescribeSecurityGroups
Tagarray<object>	标签列表。子级条数 <= 20
Namestring	组件名称。长度为 2~128 个字符，必须以大小写字母或中文开头，不能以 http://和 https://开头。可以包含中文、英文、数字、半角冒号（:）、下划线（_）、半角句号（.）或者短划线（-）。展开详情示例值:testComponent
Descriptionstring	描述信息。长度为 2~256 个英文或中文字符，不能以 http://和 https://开头。示例值:This is description.
SystemTypestring	组件支持的操作系统。展开详情示例值:Linux
ComponentTypestring	组件类型。支持镜像构建组件和测试组件。展开详情示例值:Build参考取值来源: DescribeImageComponents
Contentstring	组件内容。由多条命令组成，命令内容不能超过 16KB。支持的命令和命令格式详情，请参见镜像构建服务支持的命令说明。示例值:Tasks: - Name: HelloWorld Action: RunShellCommand Properties: commandContent: echo hello world
ClientTokenstring	保证请求幂等性。从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符，且不能超过 64 个字符。更多信息，请参见如何保证幂等性。示例值:123e4567-e89b-12d3-a456-426655440000
ComponentVersionstring	组件版本号，与组件名称配合使用，格式为 major.minor.patch，均为非负整数。展开详情示例值:1.0.0参考取值来源: DescribeImageComponents

返回参数

字段名称	字段详情
ImageComponentIdstring	镜像组件 ID。示例值:ic-bp67acfmxazb4p****
RequestIdstring	请求 ID。示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	InvalidCommand.Component	Image component does not support component command.	诊断
400	InvalidName.Malformed	%s	诊断
400	InvalidDescription.Malformed	%s	诊断
400	InvalidSystemType.NotSupportedValue	%s	诊断
400	InvalidComponentType.NotSupportedValue	%s	诊断
400	InvalidContent.LengthExceeded	%s	诊断
400	InvalidImageTemplateCommandSize.ExceededMaxNumber	%s	诊断
400	InvalidImageTemplateCommand.NotSupported	%s	诊断
400	InvalidCommandContent.RUN	%s	诊断
400	InvalidCommandContent.ENV	%s	诊断
400	InvalidCommandContent.WORKDIR	%s	诊断
400	InvalidCommandContent.COPY	%s	诊断
400	InvalidCommandContent.USER	%s	诊断
400	InvalidCommandContent.CMD	%s	诊断
400	InvalidCommandContent.ENTRYPOINT	%s	诊断
400	MissingParameter.Content	%s	诊断
400	EmptyCommandContent.RUN	%s.	诊断
400	EmptyCommandContent.ENV	%s.	诊断
400	EmptyCommandContent.LABEL	%s.	诊断
400	EmptyCommandContent.COPY	%s.	诊断
400	EmptyCommandContent.ENTRYPOINT	%s.	诊断
400	EmptyCommandContent.CMD	%s.	诊断
400	NotEmptyCommandContent.RESTART	%s.	诊断
400	EmptyCommandContent.WORKDIR	%s.	诊断
400	EmptyCommandContent.USER	%s.	诊断
400	QuotaExceed.ImageComponent	%s.	诊断
400	InvalidParameter.Content	%s.	诊断
400	InvalidImage.OsTypeUnsupported	The specified base image does not support image building.	诊断
400	InvalidParameter.ComponentVersion	The specified ComponentVersion is invalid.	诊断
403	InvalidComponentVersion.Exist	The specified ComponentVersion does exist with the specified Name.	诊断
403	InvalidOperation.NoPermissionCreateServiceLinkedRole	You are not authorized to create Service-linked role. The system will automatically create it when the API is called for the first time. Check your RAM policies, and ensure that you are using the correct credentials.	诊断
404	InvalidResourceGroup.NotFound	The ResourceGroup provided does not exist in our records.	诊断
404	NotSupportedCommand.FROM	%s	诊断

变更历史

	变更时间	变更内容概要	操作
	2024-12-26	变更错误码403
	2024-10-10	变更错误码400 新增错误码403 新增请求参数ComponentVersion
	2023-03-28	变更错误码400 删除返回参数

CreateImageComponent_云服务器 ECS_API文档

接口说明

流控信息

授权信息

请求参数

返回参数

返回示例

错误码

变更历史

相关示例