UpdateStackGroup - Resource Orchestration Service - Centro de documentación de Alibaba Cloud

Actualiza un grupo de pilas existente.

Descripción de la operación

Este tema proporciona un ejemplo sobre cómo actualizar la plantilla de un grupo de pilas existente llamado MyStackGroup que utiliza el modo de permisos autogestionados en la región China (Hangzhou) a {"ROSTemplateFormatVersion": "2015-09-01"}.

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

ros:UpdateStackGroup

update

*StackGroup.

acs:ros:{#regionId}:{#accountId}:stackgroup/{#StackGroupName}

Template.

acs:ros:{#regionId}:{#accountId}:template/{#TemplateId}

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	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.	cn-hangzhou
StackGroupName	string	Sí	El nombre del grupo de pilas. El nombre debe ser único dentro de una región. El nombre puede tener hasta 255 caracteres de longitud y debe comenzar con un dígito o una letra. Puede contener dígitos, letras, guiones (-) y guiones bajos (_).	MyStackGroup
Description	string	No	La descripción del grupo de pilas. La descripción debe tener de 1 a 256 caracteres de longitud.	My Stack Group
AccountIds	array	No	La lista de ID de cuentas de ejecución utilizadas para desplegar pilas en el modo de permisos autogestionados. Puede agregar hasta 50 ID de cuentas de ejecución.	["12****"]
	string	No	La lista de ID de cuentas de ejecución utilizadas para desplegar pilas en el modo de permisos autogestionados. Puede agregar hasta 50 ID de cuentas de ejecución.	["151266687691**","141261387191**"]
RegionIds	array	No	La lista de regiones de destino donde se despliegan las pilas. Puede agregar hasta 20 regiones.	["cn-hangzhou", "cn-beijing"]
	string	No	La lista de regiones de destino donde se despliegan las pilas. Puede agregar hasta 20 regiones.	["cn-hangzhou","cn-beijing"]
TemplateBody	string	No	La estructura del cuerpo de la plantilla. El cuerpo de la plantilla debe tener de 1 a 524,288 bytes de longitud. Si el cuerpo de la plantilla es grande, utilice el método HTTP POST e incluya el parámetro en el cuerpo de la solicitud para evitar fallos en la solicitud causados por una URL excesivamente larga. Nota Debe especificar solo uno de los siguientes parámetros: TemplateBody, TemplateURL y TemplateId.	{"ROSTemplateFormatVersion": "2015-09-01"}
TemplateURL	string	No	La URL del archivo que contiene el cuerpo de la plantilla. La URL debe apuntar a una plantilla que se encuentre en un servidor web HTTP o HTTPS, o en un bucket de Object Storage Service (OSS). La plantilla debe tener de 1 a 524,288 bytes de longitud. Ejemplo de URL de bucket de OSS: oss://ros/template/demo o oss://ros/template/demo?RegionId=cn-hangzhou. Si no se especifica la región del bucket de OSS, la región del bucket de OSS será la misma que el valor del parámetro RegionId. Nota Debe especificar solo uno de los siguientes parámetros: TemplateBody, TemplateURL y TemplateId.	oss://ros-template/demo
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 token puede tener hasta 64 caracteres de longitud y puede contener letras, dígitos, guiones (-) y guiones bajos (_). Para obtener más información, consulte Garantizar la idempotencia.	123e4567-e89b-12d3-a456-42665544****
OperationDescription	string	No	La descripción de la operación de actualización del grupo de pilas.	Update stack instances in hangzhou
OperationPreferences	object	No	La configuración de la operación para actualizar el grupo de pilas. Este parámetro incluye los siguientes campos: {"FailureToleranceCount": N} El número máximo de cuentas simultáneas en las que se toleran fallos de pila en cada región. Si el número de pilas con errores supera este valor, la operación en la región se detiene. Si la operación en una región se detiene, la operación no continúa en otras regiones. Valores válidos de N: 0 a 20. Valor predeterminado: 0. {"FailureTolerancePercentage": N} El porcentaje máximo de cuentas simultáneas en las que se toleran fallos de pila en cada región. Si el porcentaje de pilas con errores supera este valor, la operación en la región se detiene. Valores válidos de N: 0 a 100. Si el porcentaje calculado no es un número entero, Resource Orchestration Service (ROS) redondea el porcentaje hacia abajo. Valor predeterminado: 0. {"MaxConcurrentCount": N} El número máximo de cuentas simultáneas en las que se pueden desplegar pilas al mismo tiempo en cada región. Valores válidos de N: 1 a 20. Valor predeterminado: 1. {"MaxConcurrentPercentage": N} El porcentaje máximo de cuentas simultáneas en las que se pueden desplegar pilas al mismo tiempo en cada región. Valores válidos de N: 1 a 100. Si el porcentaje calculado no es un número entero, ROS redondea el porcentaje hacia abajo. Valor predeterminado: 1. {"RegionConcurrencyType": N} El tipo de concurrencia a nivel de región para desplegar instancias de pila. Valores válidos: SEQUENTIAL (predeterminado): despliega instancias de pila en las regiones especificadas una por una. Solo se despliega una región a la vez. PARALLEL: despliega instancias de pila en todas las regiones especificadas en paralelo. Separe varios parámetros con comas (,). Nota No puede especificar MaxConcurrentCount y MaxConcurrentPercentage al mismo tiempo. No puede especificar FailureToleranceCount y FailureTolerancePercentage al mismo tiempo.	{"FailureToleranceCount": 1,"MaxConcurrentCount": 2}
AdministrationRoleName	string	No	El nombre del rol de administrador de Resource Access Management (RAM) que asume ROS cuando se crea un grupo de pilas con permisos autogestionados. Si no especifica este parámetro, se utiliza AliyunROSStackGroupAdministrationRole de forma predeterminada. ROS asume este rol para asumir a su vez el rol de ejecución (AliyunROSStackGroupExecutionRole) y administrar las pilas que corresponden a las instancias de pila en el grupo de pilas. El nombre debe tener de 1 a 64 caracteres de longitud y puede contener letras, dígitos y guiones (-).	AliyunROSStackGroupAdministrationRole
ExecutionRoleName	string	No	El nombre del rol de ejecución de RAM que asume el rol de administrador (AliyunROSStackGroupAdministrationRole) cuando se crea un grupo de pilas con permisos autogestionados. Si no especifica este parámetro, se utiliza AliyunROSStackGroupExecutionRole de forma predeterminada. ROS asume este rol para administrar las pilas que corresponden a las instancias de pila en el grupo de pilas. El nombre debe tener de 1 a 64 caracteres de longitud y puede contener letras, dígitos y guiones (-).	AliyunROSStackGroupExecutionRole
TemplateId	string	No	El ID de la plantilla. Se admiten plantillas compartidas y plantillas privadas. Nota Debe especificar solo uno de los siguientes parámetros: TemplateBody, TemplateURL y TemplateId.	5ecd1e10-b0e9-4389-a565-e4c15efc****
TemplateVersion	string	No	La versión de la plantilla. Si no especifica este parámetro, se utiliza la versión más reciente de forma predeterminada. Nota TemplateVersion solo surte efecto cuando se especifica TemplateId.	v1
Parameters	array<object>	No	La lista de parámetros para el grupo de pilas.
	object	No
ParameterKey	string	Sí	El nombre del parámetro. Si no especifica el nombre y el valor del parámetro, ROS utiliza el valor predeterminado que se especifica en la plantilla. Valor máximo de N: 200. Nota El parámetro Parameters es opcional. Si especifica Parameters, se requiere Parameters.N.ParameterKey.	Amount
ParameterValue	string	Sí	El valor del parámetro. Valor máximo de N: 200. Nota El parámetro Parameters es opcional. Si especifica Parameters, se requiere Parameters.N.ParameterValue.	1
PermissionModel	string	No	El modelo de autorización. Valores válidos: SELF_MANAGED (predeterminado): el modelo de permisos autogestionados. Si utiliza este modelo, debe crear manualmente roles de RAM en la cuenta de administrador y las cuentas de ejecución para establecer una relación de confianza entre ambas, y luego realizar el despliegue de pilas en las cuentas de ejecución. SERVICE_MANAGED: el modelo de permisos administrados por el servicio. Si utiliza este modelo, ROS crea automáticamente roles vinculados al servicio (asociados) para la cuenta de administrador y las cuentas de ejecución. La cuenta de administrador realiza el despliegue de pilas en las cuentas de ejecución mediante los roles vinculados al servicio. Nota Si el grupo de pilas ya contiene instancias de pila, no puede cambiar el modelo de autorización. Cuando utiliza el modelo de permisos administrados por el servicio para el despliegue de pilas, la cuenta actual debe ser la cuenta de administración o una cuenta de administrador delegado de un directorio de recursos (carpeta), y el acceso de confianza debe estar habilitado. Para obtener más información, consulte Configuración para cuentas de administrador delegado y Habilitar el acceso de confianza.	SELF_MANAGED
AutoDeployment	object	No	La configuración de despliegue automático. Nota Este parámetro solo es obligatorio cuando PermissionModel se establece en SERVICE_MANAGED.	{"Enabled": true, "RetainStacksOnAccountRemoval": true}
Enabled	boolean	Sí	Especifica si se debe habilitar el despliegue automático. Valores válidos: true: habilita el despliegue automático. Una vez habilitado el despliegue automático, si se agrega una cuenta de miembro a la carpeta de destino, el grupo de pilas despliega automáticamente una instancia de pila en la cuenta. Si se elimina una cuenta de miembro de la carpeta de destino, el grupo de pilas elimina automáticamente la instancia de pila en la cuenta. false: deshabilita el despliegue automático. Una vez deshabilitado el despliegue automático, las instancias de pila no cambian cuando cambian las cuentas de miembro en la carpeta de destino.	true
RetainStacksOnAccountRemoval	boolean	No	Especifica si se deben conservar las pilas en las cuentas de miembro cuando las cuentas de miembro se eliminan de la carpeta de destino. Valores válidos: true: conserva las pilas. false: elimina las pilas. Nota RetainStacksOnAccountRemoval es obligatorio cuando Enabled se establece en true.	true
DeploymentTargets	object	No	Los destinos de despliegue para actualizar pilas en el modo de permisos administrados por el servicio.	{"RdFolderIds": ["fd-4PvlVLOL8v"]}
RdFolderIds	array	No	La lista de ID de carpetas en el directorio de recursos.
	string	No	La lista de ID de carpetas en el directorio de recursos. Puede agregar hasta 20 ID de carpetas. Debe especificar al menos uno de los parámetros RdFolderIds y AccountIds según las siguientes reglas: Si especifica RdFolderIds pero no especifica AccountIds, las pilas se despliegan en todas las cuentas de miembro en las carpetas especificadas. Si selecciona la carpeta Root, las pilas se despliegan en todas las cuentas de miembro en todo el directorio de recursos. Si especifica AccountIds pero no especifica RdFolderIds, las pilas se despliegan en las cuentas de miembro especificadas. Si especifica ambos parámetros, las cuentas especificadas por AccountIds deben pertenecer a las carpetas especificadas por RdFolderIds, y las pilas se despliegan en las cuentas de miembro especificadas. Nota Puede ver los ID de las carpetas en la página Información general de la consola Administración de recursos. Para obtener más información, consulte Ver la información básica de una carpeta.	["fd-4PvlVLOL8v"]
AccountIds	array	No	La lista de ID de cuentas de miembro en el directorio de recursos (carpeta). Puede agregar hasta 30 ID de cuentas de miembro. Nota Puede ver los ID de las cuentas de miembro en la página Información general de la consola Administración de recursos. Para obtener más información, consulte Ver los detalles de una cuenta de miembro.
	string	No	La lista de ID de cuentas de miembro en el directorio de recursos (carpeta). Puede agregar hasta 30 ID de cuentas de miembro. Nota Puede ver los ID de las cuentas de miembro en la página Información general de la consola Administración de recursos. Para obtener más información, consulte Ver los detalles de una cuenta de miembro.	["151266687691**","141261387191**"]
Capabilities	array	No	La lista de opciones para el grupo de pilas. Longitud máxima: 1.
	string	No	Las opciones para el grupo de pilas. Valor válido: ExpandModules, que expande los módulos en la cuenta actual. Nota Esta opción solo surte efecto cuando se utilizan módulos en la plantilla. De forma predeterminada, los módulos no se expanden en la cuenta actual, y los módulos relevantes deben existir en todas las cuentas de despliegue de destino. Si los módulos se expanden en la cuenta actual, los módulos relevantes deben existir en la cuenta actual.	ExpandModules
DeploymentOptions	array	No	La lista de opciones de despliegue para actualizar el grupo de pilas en el modo de permisos administrados por el servicio. Puede especificar hasta 1 opción de despliegue.
	string	No	Valores válidos: Deploy: actualiza las instancias existentes en las cuentas del directorio de recursos especificadas. Configure: modifica el directorio de recursos de despliegue de destino sin actualizar las instancias existentes.	Deploy

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

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	14A07460-EBE7-47CA-9757-12CC4761D47A
OperationId	string	El ID de la operación.	6da106ca-1784-4a6f-a7e1-e723863d****

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "OperationId": "6da106ca-1784-4a6f-a7e1-e723863d****"
}

Códigos de error

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.