CreateStackGroup - - Centro de documentación de Alibaba Cloud

Crea un grupo de pilas.

Un grupo de pilas es un conjunto de pilas de Resource Orchestration Service (ROS) que se gestionan como una unidad. Puede usar una plantilla de ROS de un grupo de pilas para crear pilas en cuentas de Alibaba Cloud y en varias regiones.

Puede crear un grupo de pilas con permisos autogestionados o gestionados por el servicio:

Si usa una cuenta de Alibaba Cloud para crear un grupo de pilas autogestionado, tanto la cuenta administradora como la cuenta de ejecución son cuentas de Alibaba Cloud.
Si habilita un directorio de recursos y usa la cuenta de administración o una cuenta de administrador delegado del directorio de recursos para crear un grupo de pilas gestionado por el servicio, la cuenta administradora será la cuenta de administración o la cuenta de administrador delegado, y la cuenta de ejecución será un miembro del directorio de recursos.

Para obtener más información sobre los grupos de pilas, consulte Descripción general.

Este tema proporciona un ejemplo de cómo crear un grupo de pilas autogestionado llamado MyStackGroup mediante una plantilla. En este ejemplo, el ID de la plantilla es 5ecd1e10-b0e9-4389-a565-e4c15efc****. El ID de región del grupo de pilas es cn-hangzhou.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos llamar a esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente el código de muestra de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	CreateStackGroup	La operación que desea ejecutar. Establezca el valor en CreateStackGroup.
RegionId	String	Sí	cn-hangzhou	El ID de región del grupo de pilas. Puede llamar a la operación DescribeRegions para consultar la lista de regiones más reciente.
StackGroupName	String	Sí	MyStackGroup	El nombre del grupo de pilas. El nombre debe ser único dentro de una región. El nombre puede tener hasta 255 caracteres y contener dígitos, letras, guiones (-) y guiones bajos (_). Debe comenzar con un dígito o una letra.
Description	String	No	StackGroup Description	La descripción del grupo de pilas. La descripción debe tener entre 1 y 256 caracteres.
TemplateBody	String	No	{"ROSTemplateFormatVersion":"2015-09-01"}	La estructura que contiene el cuerpo de la plantilla. El cuerpo de la plantilla debe tener entre 1 y 524,288 bytes. Si la longitud del cuerpo excede el límite superior, le recomendamos agregar parámetros al cuerpo de la solicitud HTTP POST para evitar fallos causados por URL excesivamente largas. Nota Debe especificar solo uno de los siguientes parámetros: TemplateBody, TemplateURL y TemplateId.
TemplateURL	String	No	oss://ros-template/demo	La URL del archivo que contiene el cuerpo de la plantilla. La URL debe apuntar a una plantilla ubicada en un servidor web HTTP o HTTPS, o en un bucket de Object Storage Service (OSS) de Alibaba Cloud, como oss://ros/template/demo u oss://ros/template/demo?RegionId=cn-hangzhou. El cuerpo de la plantilla debe tener entre 1 y 524,288 bytes. Si no especifica el ID de región del bucket de OSS, se usará el valor del parámetro RegionId. Nota Debe especificar solo uno de los siguientes parámetros: TemplateBody, TemplateURL y TemplateId.
ClientToken	String	No	123e4567-e89b-12d3-a456-42665544****	El token de cliente que se usa para garantizar la idempotencia de la solicitud. Puede usar el cliente para generar el valor, pero debe asegurarse de que sea único entre distintas solicitudes. El token puede tener hasta 64 caracteres y contener letras, dígitos, guiones (-) y guiones bajos (_). Para obtener más información, consulte Garantizar la idempotencia.
AdministrationRoleName	String	No	AliyunROSStackGroupAdministrationRole	El nombre del rol de RAM que se especifica para la cuenta administradora al crear un grupo de pilas autogestionado. ROS asume el rol de administrador para ejecutar operaciones. Si no especifica este parámetro, se usa el valor predeterminado AliyunROSStackGroupAdministrationRole. ROS usa el rol de administrador para asumir el rol de ejecución AliyunROSStackGroupExecutionRole y así gestionar las pilas del grupo. El nombre debe tener entre 1 y 64 caracteres, y puede contener letras, dígitos y guiones (-).
ExecutionRoleName	String	No	AliyunROSStackGroupExecutionRole	El nombre del rol de RAM que se especifica para la cuenta de ejecución al crear un grupo de pilas autogestionado. El rol de administrador AliyunROSStackGroupAdministrationRole asume el rol de ejecución para realizar operaciones. Si no especifica este parámetro, se usa el valor predeterminado AliyunROSStackGroupExecutionRole. ROS asume el rol de ejecución para gestionar las pilas del grupo. El nombre debe tener entre 1 y 64 caracteres, y puede contener letras, dígitos y guiones (-).
TemplateId	String	No	5ecd1e10-b0e9-4389-a565-e4c15efc****	El ID de la plantilla. Este parámetro aplica a plantillas compartidas y privadas. Nota Debe especificar solo uno de los siguientes parámetros: TemplateBody, TemplateURL y TemplateId.
TemplateVersion	String	No	v1	La versión de la plantilla. Si no especifica este parámetro, se usa la versión más reciente. Nota Este parámetro solo surte efecto cuando se especifica el parámetro TemplateId.
Parameters.N.ParameterKey	String	Sí	Amount	El nombre del parámetro N. Si no especifica el nombre y el valor de un parámetro, ROS usa el nombre y el valor predeterminados definidos en la plantilla. Valor máximo de N: 200. Nota El parámetro Parameters es opcional. Si lo especifica, debe indicar también el parámetro Parameters.N.ParameterKey.
Parameters.N.ParameterValue	String	Sí	12	El valor del parámetro N. Valor máximo de N: 200. Nota El parámetro Parameters es opcional. Si lo especifica, debe indicar también el parámetro Parameters.N.ParameterValue.
ResourceGroupId	String	No	rg-acfmxazb4ph6aiy****	El ID del resource group. Si no especifica este parámetro, el grupo de pilas se agrega al resource group predeterminado. Para obtener más información sobre los resource groups, consulte la sección "Resource Group" del tema ¿Qué es Resource Management?.
PermissionModel	String	No	SELF_MANAGED	El modelo de permisos. Valor predeterminado: SELF_MANAGED. Valores válidos: SELF_MANAGED: modelo de permisos autogestionados. Si crea un grupo de pilas autogestionado, debe crear roles de RAM en las cuentas administradora y de ejecución, además de establecer una relación de confianza entre ellas. Después, podrá desplegar pilas en la cuenta de ejecución. SERVICE_MANAGED: modelo de permisos gestionados por el servicio. Si crea un grupo de pilas gestionado por el servicio, ROS crea roles vinculados al servicio para las cuentas administradora y de ejecución; la cuenta administradora usa su rol para desplegar pilas en la cuenta de ejecución. Nota Cuando use el modelo de permisos gestionados por el servicio para desplegar pilas, asegúrese de que su cuenta sea la cuenta de administración o una cuenta de administrador delegado en el directorio de recursos, y de que la función de acceso de confianza esté habilitada para su cuenta. Para obtener más información, consulte Paso 1: (Opcional) Crear una cuenta de administrador delegado y Paso 2: Habilitar el acceso de confianza.
Tags.N.Key	String	Sí	usage	La clave de la etiqueta N que desea agregar al grupo de pilas. Nota El parámetro Tags es opcional. Si lo especifica, debe indicar también el parámetro Tags.N.Key.
Tags.N.Value	String	No	test	El valor de la etiqueta N que desea agregar al grupo de pilas.
AutoDeployment	Object	No		La información sobre la configuración de despliegue automático. Nota Este parámetro es obligatorio solo si el parámetro PermissionModel está establecido en SERVICE_MANAGED.
Enabled	Boolean	Sí	true	Especifica si se debe habilitar el despliegue automático. Valores válidos: true: habilita el despliegue automático. Si agrega un miembro a la carpeta a la que pertenece el grupo de pilas después de habilitar esta opción, ROS agregará automáticamente las pilas del grupo a dicho miembro. Si quita un miembro de la carpeta, ROS eliminará automáticamente las pilas de ese miembro. false: deshabilita el despliegue automático. Tras deshabilitarlo, las pilas permanecerán sin cambios aunque modifique los miembros de la carpeta.
RetainStacksOnAccountRemoval	Boolean	No	true	Especifica si se deben conservar las pilas dentro de un miembro cuando este se quita de la carpeta. Valores válidos: true: conserva las pilas. false: elimina las pilas. Nota Este parámetro es obligatorio si el parámetro Enabled está establecido en true.

Para obtener más información sobre los parámetros de solicitud comunes, consulte Parámetros comunes.

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	14A07460-EBE7-47CA-9757-12CC4761D47A	El ID de la solicitud.
StackGroupId	String	2c036e78-9e82-428e-afd6-177f5d04****	El ID del grupo de pilas.

Ejemplos

Solicitudes de muestra

http(s)://ros.aliyuncs.com/?Action=CreateStackGroup
&RegionId=cn-hangzhou
&StackGroupName=MyStackGroup
&TemplateId=5ecd1e10-b0e9-4389-a565-e4c15efc****
&PermissionModel=SELF_MANAGED
&<Common request parameters>

Respuestas exitosas de muestra

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateStackGroupResponse>
    <RequestId>14A07460-EBE7-47CA-9757-12CC4761D47A</RequestId>
    <StackGroupId>2c036e78-9e82-428e-afd6-177f5d04****</StackGroupId>
</CreateStackGroupResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "StackGroupId" : "2c036e78-9e82-428e-afd6-177f5d04****"
}

Códigos de error

Para consultar la lista de códigos de error, visite el Centro de errores de API.

Código de error	Mensaje de error	Código de estado HTTP	Descripción
CircularDependency	Circular Dependency Found: {reason}.	400	Mensaje de error devuelto porque la plantilla contiene dependencias circulares. reason indica la causa del error.
InvalidSchema	{reason}.	400	Mensaje de error devuelto porque el formato de la plantilla no es válido. reason indica la causa del error.
InvalidTemplateAttribute	The Referenced Attribute ({resource} {name}) is incorrect.	400	Mensaje de error devuelto porque la propiedad de recurso referenciada en la sección Outputs de la plantilla no es válida. resource indica el nombre del recurso. name indica el nombre de la propiedad.
InvalidTemplatePropertyType	The specified value type of ({resource} {section}) is incorrect.	400	Mensaje de error devuelto porque el tipo de la propiedad de recurso definida en una sección de la plantilla no es válido. resource indica el nombre del recurso. section indica el nombre de la sección.
InvalidTemplateReference	The specified reference "{name}" (in {referencer}) is incorrect.	400	Mensaje de error devuelto porque la plantilla contiene una referencia no válida. name indica el nombre de la referencia. referencer indica el nombre del elemento que hace la referencia.
InvalidTemplateSection	The template section is invalid: {section}.	400	Mensaje de error devuelto porque la plantilla contiene una sección no válida. section indica el nombre de la sección.
InvalidTemplateVersion	The template version is invalid: {reason}.	400	Mensaje de error devuelto porque la versión de la plantilla no es válida. reason indica la causa del error.
UnknownUserParameter	The Parameter ({name}) was not defined in template.	400	Mensaje de error devuelto porque el parámetro especificado no está definido en la plantilla. name indica el nombre del parámetro.
UserParameterMissing	The Parameter {name} was not provided.	400	Mensaje de error devuelto porque no se proporcionó ningún valor para un parámetro de la plantilla. name indica el nombre del parámetro.
StackGroupExists	The StackGroup ({name}) already exists.	409	Mensaje de error devuelto porque ya existe un grupo de pilas con el mismo nombre. name indica el nombre del grupo de pilas.
TemplateNotFound	The Tempalte ({ ID }) could not be found.	404	Mensaje de error devuelto porque la plantilla no existe. ID indica el ID de la plantilla.
TemplateNotFound	The Template { ID } with version { version } could not be found.	404	Mensaje de error devuelto porque la plantilla o la versión de plantilla especificada no existe. ID indica el ID de la plantilla. version indica la versión de la plantilla.