GetStackGroup - - Centro de documentación de Alibaba Cloud

Consulta la información sobre un grupo de pilas.

En este ejemplo se consulta la información sobre un grupo de pilas llamado MyStackGroup. El grupo de pilas cuenta con permisos autogestionados y se creó en la región China (Hangzhou).

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Para su comodidad, le recomendamos que invoque esta operación en esta herramienta, la cual genera dinámicamente el código de ejemplo de la operación para diferentes SDK.

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	GetStackGroup	La operación que desea realizar. Establezca el valor en GetStackGroup.
RegionId	String	Sí	cn-hangzhou	El ID de la región del grupo de pilas. Puede invocar la operación DescribeRegions para consultar la lista más reciente de regiones.
StackGroupName	String	No	MyStackGroup	El nombre del grupo de pilas. El nombre debe ser único dentro de una región. El nombre puede tener una longitud máxima de 255 caracteres y puede contener dígitos, letras, guiones (-) y guiones bajos (_). Debe comenzar con un dígito o una letra. Nota Especifique uno de los parámetros StackGroupName y StackGroupId.
StackGroupId	String	No	fd0ddef9-9540-4b42-a464-94f77835****	El ID del grupo de pilas. Nota Especifique uno de los parámetros StackGroupName y StackGroupId.

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.
StackGroup	Object		Los detalles del grupo de pilas.
StackGroupId	String	fd0ddef9-9540-4b42-a464-94f77835****	El ID del grupo de pilas.
Status	String	ACTIVE	El estado del grupo de pilas. Valores válidos: ACTIVE DELETED
AdministrationRoleName	String	AliyunROSStackGroupAdministrationRole	El nombre del rol de RAM que se especifica para la cuenta de administrador en Resource Orchestration Service (ROS) al crear el grupo de pilas autogestionado. Si no se especifica este parámetro, se devuelve el valor predeterminado AliyunROSStackGroupAdministrationRole.
Parameters	Array of Parameter		Los parámetros del grupo de pilas.
ParameterKey	String	Amount	La clave del parámetro.
ParameterValue	String	12	El valor del parámetro.
Description	String	StackGroup Description	La descripción del grupo de pilas.
StackGroupName	String	MyStackGroup	El nombre del grupo de pilas.
ExecutionRoleName	String	AliyunROSStackGroupExecutionRole	El nombre del rol de RAM que se especifica para la cuenta de ejecución al crear el grupo de pilas autogestionado. El rol de administrador AliyunROSStackGroupAdministrationRole asume el rol de ejecución. Si no se especifica este parámetro, se devuelve el valor predeterminado AliyunROSStackGroupExecutionRole.
TemplateBody	String	{"ROSTemplateFormatVersion": "2015-09-01"}	El cuerpo de la plantilla.
StackGroupDriftDetectionDetail	Object		Los detalles de la última detección de desviaciones realizada en el grupo de pilas.
DriftDetectionTime	String	2020-02-27T07:47:47	La hora en la que se realizó la detección de desviaciones en el grupo de pilas.
TotalStackInstancesCount	Integer	2	El número de instancias de pila.
FailedStackInstancesCount	Integer	0	El número de instancias de pila con errores en la detección de desviaciones.
DriftDetectionStatus	String	COMPLETED	El estado de la detección de desviaciones en el grupo de pilas. Valores válidos: COMPLETED: la detección de desviaciones se realizó y se completó en todas las instancias de pila. FAILED: la detección de desviaciones se realizó y el número de instancias de pila con errores en la detección de desviaciones supera el umbral especificado. PARTIAL_SUCCESS: la detección de desviaciones se realizó, pero el número de instancias de pila con errores en la detección de desviaciones no supera el umbral especificado. IN_PROGRESS: la detección de desviaciones se está realizando en el grupo de pilas. STOPPED: la detección de desviaciones se canceló para el grupo de pilas.
StackGroupDriftStatus	String	DRIFTED	El estado de desviación del grupo de pilas. Valores válidos: DRIFTED: como mínimo, una instancia de pila del grupo de pilas se desvió. NOT_CHECKED: no se completó ninguna detección de desviaciones en el grupo de pilas. IN_SYNC: todas las instancias de pila del grupo de pilas se están sincronizando.
InProgressStackInstancesCount	Integer	0	El número de instancias de pila en las que se estaba realizando la detección de desviaciones.
InSyncStackInstancesCount	Integer	1	El número de instancias de pila que se estaban sincronizando.
CancelledStackInstancesCount	Integer	0	El número de instancias de pila para las que se canceló la detección de desviaciones.
DriftedStackInstancesCount	Integer	1	El número de instancias de pila que se desviaron.
ResourceGroupId	String	rg-acfmxazb4ph6aiy****	El ID del resource group. Este parámetro se especifica al crear el grupo de pilas.
PermissionModel	String	SELF_MANAGED	El modelo de permisos. Valores válidos: SELF_MANAGED: el modelo de permisos autogestionados SERVICE_MANAGED: el modelo de permisos gestionados por el servicio Nota Para obtener más información sobre los modelos de permisos de los grupos de pilas, consulte Descripción general.
AutoDeployment	Object		La información sobre la configuración de despliegue automático. Nota Este parámetro solo se devuelve cuando el parámetro PermissionModel se establece en SERVICE_MANAGED.
Enabled	Boolean	true	Indica si el despliegue automático está habilitado. Valores válidos: true: el despliegue automático está habilitado. Si se agrega una cuenta miembro a la carpeta a la que pertenece el grupo de pilas después de habilitar el despliegue automático, el grupo de pilas despliega sus instancias de pila en la región especificada en la que se despliega la cuenta agregada. Si la cuenta se elimina de la carpeta, las instancias de pila de la región especificada se eliminan del grupo de pilas. false: el despliegue automático está deshabilitado. Una vez deshabilitado el despliegue automático, las instancias de pila permanecen sin cambios si cambia la cuenta miembro de la carpeta.
RetainStacksOnAccountRemoval	Boolean	true	Indica si las pilas de la cuenta miembro se conservan cuando esta se elimina de la carpeta. Valores válidos: true: las pilas se conservan. false: las pilas se eliminan. Nota Este parámetro solo se devuelve cuando el parámetro Enabled se establece en true.
RdFolderIds	Array of String	["fd-4PvlVLOL8v"]	Los ID de carpeta del directorio de recursos. Este parámetro se usa para desplegar instancias de pila en todas las cuentas de las carpetas. Nota Este parámetro solo se devuelve cuando el parámetro PermissionModel se establece en SERVICE_MANAGED.

Ejemplos

Solicitudes de ejemplo

http(s)://ros.aliyuncs.com/?Action=GetStackGroup
&RegionId=cn-hangzhou
&StackGroupName=MyStackGroup
&<Common request parameters>

Respuestas de ejemplo correctas

Formato XML

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

<GetStackGroupResponse>
    <RequestId>14A07460-EBE7-47CA-9757-12CC4761D47A</RequestId>
    <StackGroup>
        <Status>ACTIVE</Status>
        <ResourceGroupId>rg-acfmxazb4ph6aiy****</ResourceGroupId>
        <StackGroupName>MyStackGroup</StackGroupName>
        <StackGroupId>fd0ddef9-9540-4b42-a464-94f77835****</StackGroupId>
        <AdministrationRoleName>AliyunROSStackGroupAdministrationRole</AdministrationRoleName>
        <TemplateBody>
            <ROSTemplateFormatVersion>2015-09-01</ROSTemplateFormatVersion>
        </TemplateBody>
        <PermissionModel>SELF_MANAGED</PermissionModel>
        <ExecutionRoleName>AliyunROSStackGroupExecutionRole</ExecutionRoleName>
    </StackGroup>
</GetStackGroupResponse>

Formato JSON

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

{
  "RequestId" : "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "StackGroup" : {
    "Status" : "ACTIVE",
    "Parameters" : [ ],
    "ResourceGroupId" : "rg-acfmxazb4ph6aiy****",
    "StackGroupName" : "MyStackGroup",
    "StackGroupId" : "fd0ddef9-9540-4b42-a464-94f77835****",
    "AdministrationRoleName" : "AliyunROSStackGroupAdministrationRole",
    "TemplateBody" : {
      "ROSTemplateFormatVersion" : "2015-09-01"
    },
    "PermissionModel" : "SELF_MANAGED",
    "ExecutionRoleName" : "AliyunROSStackGroupExecutionRole"
  }
}

Códigos de error

Para consultar una 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
StackGroupNotFound	The StackGroup ({name}) could not be found.	404	Este mensaje de error se devuelve porque el grupo de pilas especificado no existe. name indica el nombre del grupo de pilas.