CreateImageComponent - Elastic Compute Service - Centro de documentación de Alibaba Cloud

Crea un componente de imagen. Los componentes de imagen se utilizan para almacenar comandos de plantillas de compilación de uso frecuente para la creación de imágenes.

Descripción de la operación

Antes de crear un componente de imagen, tenga en cuenta los siguientes puntos:

Solo se pueden crear componentes de imagen personalizados.
Los números de versión de los componentes deben ser únicos para el mismo nombre de componente. Al utilizar un componente en una plantilla, puede hacer referencia a él mediante su nombre y número de versión.
El tamaño del contenido de un componente de imagen no puede superar los 16 KB. Para obtener más información sobre los comandos admitidos, consulte Comandos admitidos por Image Builder.

Para obtener más información, consulte Descripción general de Image Builder.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

ecs:CreateImageComponent

create

*ImageComponent

acs:ecs:{#regionId}:{#accountId}:imagecomponent/*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región. Puede llamar a DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
ResourceGroupId	string	No	El ID del grupo de recursos empresariales.	rg-bp67acfmxazb4p****
Tag	array<object>	No	Las etiquetas.
	object	No
Key	string	No	La clave de la etiqueta. Valores válidos de N: 1 a 20. La clave de la etiqueta no puede ser una cadena vacía. La clave de la etiqueta puede tener hasta 128 caracteres de longitud y no puede comenzar con aliyun o acs:. La clave de la etiqueta no puede contener http:// o https://.	TestKey
Value	string	No	El valor de la etiqueta. Valores válidos de N: 1 a 20. El valor de la etiqueta puede ser una cadena vacía. El valor de la etiqueta puede tener hasta 128 caracteres de longitud y no puede comenzar con acs:. El valor de la etiqueta no puede contener http:// o https://.	TestValue
Name	string	No	El nombre del componente. El nombre debe tener entre 2 y 128 caracteres de longitud y debe comenzar con una letra o un carácter chino. El nombre no puede comenzar con http:// o https://. El nombre puede contener letras, caracteres chinos, dígitos, dos puntos (:), guiones bajos (_), puntos (.) o guiones (-). Nota Si no especifica `Name`, se utiliza el valor de retorno `ImageComponentId` de forma predeterminada.	testComponent
Description	string	No	La descripción. La descripción debe tener entre 2 y 256 caracteres de longitud y no puede comenzar con http:// o https://.	Esta es la descripción
SystemType	string	No	El sistema operativo compatible con el componente. Valores válidos: Linux Windows Valor predeterminado: Linux.	Linux
ComponentType	string	No	El tipo de componente. Se admiten componentes de compilación de imágenes y componentes de prueba. Valores válidos: Build Test Valor predeterminado: Build. Nota Los componentes de compilación solo se pueden utilizar en plantillas de compilación, y los componentes de prueba solo se pueden utilizar en plantillas de prueba.	Build
Content	string	No	El contenido del componente. El contenido consta de múltiples comandos y no puede superar los 16 KB. Para obtener más información sobre los comandos admitidos y los formatos de comando, consulte Comandos admitidos por Image Builder.	Tasks: - Name: HelloWorld Action: RunShellCommand Properties: commandContent: echo hello world
ClientToken	string	No	El token de cliente que se utiliza para garantizar la idempotencia de la solicitud. Puede utilizar el cliente para generar el token, pero debe asegurarse de que el token sea único entre diferentes solicitudes. El valor de ClientToken solo puede contener caracteres ASCII y no puede superar los 64 caracteres de longitud. Para obtener más información, consulte Cómo garantizar la idempotencia.	123e4567-e89b-12d3-a456-426655440000
ComponentVersion	string	No	El número de versión del componente. Este parámetro se utiliza junto con el nombre del componente. El formato es mayor.menor.parche, donde todos los valores son enteros no negativos. Valor predeterminado: (x+1).0.0, donde x es el número de versión mayor máxima actual del componente.	1.0.0

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
ImageComponentId	string	El ID del componente de imagen.	ic-bp67acfmxazb4p****
RequestId	string	El ID de la solicitud.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Ejemplos

Respuesta exitosa

JSON Formato

{
  "ImageComponentId": "ic-bp67acfmxazb4p****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
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.	If the RUN command exists in the template, you must specify RUN.
400	EmptyCommandContent.ENV	%s.	If the ENV command exists in the template, you must specify ENV.
400	EmptyCommandContent.LABEL	%s.	If the LABEL command exists in the template, you must specify LABEL.
400	EmptyCommandContent.COPY	%s.	If the COPY command exists in the template, you must specify COPY.
400	EmptyCommandContent.ENTRYPOINT	%s.	If the ENTRYPOINT command exists in the template, you must specify ENTRYPOINT.
400	EmptyCommandContent.CMD	%s.	If the CMD command exists in the template, you must specify CMD.
400	NotEmptyCommandContent.RESTART	%s.	If the RESTART command exists in the template, you must specify RESTART.
400	EmptyCommandContent.WORKDIR	%s.	If the WORKDIR command exists in the template, you must specify WORKDIR.
400	EmptyCommandContent.USER	%s.	If the USER command exists in the template, you must specify USER.
400	QuotaExceed.ImageComponent	%s.	Image component quota exceeded in current region.
400	InvalidParameter.Content	%s.	The image component content is invalid.
400	InvalidImage.OsTypeUnsupported	The specified base image does not support image building.	The operating system of the specified base image does not support image building.
400	InvalidParameter.ComponentVersion	The specified ComponentVersion is invalid.	The specified ComponentVersion is invalid.
403	InvalidComponentVersion.Exist	The specified ComponentVersion does exist with the specified Name.	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.	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.	The specified resource group does not exist.
404	NotSupportedCommand.FROM	%s

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.