ListStackGroups - - Centro de documentación de Alibaba Cloud

Consulta la lista de grupos de pilas.

Este tema proporciona un ejemplo sobre cómo consultar la lista de grupos de pilas. En este ejemplo, se consultan los grupos de pilas que están en estado activo y desplegados en la región China (Hangzhou).

Depuración

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

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Ejemplo	Descripción
Action	String	Sí	ListStackGroups	La operación que desea ejecutar. Establezca el valor en ListStackGroups.
RegionId	String	Sí	cn-hangzhou	El ID de la región del grupo de pilas. Llame a la operación DescribeRegions para consultar la lista de regiones más reciente.
Status	String	No	ACTIVE	El estado del grupo de pilas. Si no especifica este parámetro, se consultan los grupos de pilas de todos los estados en la región indicada. Valores válidos: ACTIVE DELETED
PageSize	Long	No	10	El número de entradas que se devuelven en cada página. Valores válidos: de 1 a 50. Valor predeterminado: 10.
PageNumber	Long	No	1	El número de la página que se devuelve. Las páginas comienzan desde la página 1. Valor predeterminado: 1.
ResourceGroupId	String	No	rg-acfmzawhxxcj****	El ID del resource group. Si no especifica este parámetro, se consultan los grupos de pilas de todos los resource groups. Nota Para obtener el ID del resource group, vaya a la página Resource Group en la consola de Resource Management. Para obtener más información, consulte Consultar la información básica de un resource group.
Tags.N.Key	String	Sí	usage	La clave de la etiqueta N agregada 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 agregada al grupo de pilas.

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
StackGroups	Array of StackGroup		La lista de grupos 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
DriftDetectionTime	String	2020-02-27T07:47:47	La hora en la que se completó correctamente la última detección de desviaciones en el grupo de pilas.
Description	String	My Stack Group	La descripción del grupo de pilas.
StackGroupDriftStatus	String	IN_SYNC	El estado del grupo de pilas tras la última detección de desviaciones exitosa. Valores válidos: DRIFTED: el grupo de pilas presenta desviaciones. NOT_CHECKED: no se ejecutó ninguna detección de desviaciones en el grupo de pilas. IN_SYNC: no se detectaron desviaciones en el grupo de pilas.
StackGroupName	String	MyStackGroup	El nombre del grupo de pilas.
Tags	Array of Tags		Las etiquetas agregadas al grupo de pilas.
Key	String	usage1	La clave de la etiqueta agregada al grupo de pilas.
Value	String	test1	El valor de la etiqueta agregada al grupo de pilas.
ResourceGroupId	String	rg-acfmzawhxxcj****	El ID del resource group.
PermissionModel	String	SELF_MANAGED	El modelo de permisos. Valores válidos: SELF_MANAGED: modelo de permisos autogestionado. SERVICE_MANAGED: modelo de permisos gestionado 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.
Enabled	Boolean	true	Indica si el despliegue automático está habilitado. Valores válidos: true: el despliegue automático está habilitado. Si agrega un miembro a la carpeta a la que pertenece el grupo de pilas después de habilitar esta función, ROS agrega automáticamente las pilas del grupo a la región especificada de dicho miembro. Si elimina al miembro de la carpeta, ROS elimina automáticamente las pilas del grupo de la región indicada. false: el despliegue automático está deshabilitado. Al deshabilitarlo, las pilas permanecen sin cambios cuando modifica los miembros de la carpeta.
RetainStacksOnAccountRemoval	Boolean	true	Indica si las pilas dentro de un miembro se conservan cuando elimina dicho miembro de la carpeta. Valores válidos: true false Nota Este parámetro se devuelve únicamente si el parámetro Enabled se establece en true.
TotalCount	Integer	1	El número total de grupos de pilas.
RequestId	String	14A07460-EBE7-47CA-9757-12CC4761D47A	El ID de la solicitud.
PageSize	Integer	10	El número de entradas devueltas por página.
PageNumber	Integer	1	El número de la página devuelta.

Ejemplos

Solicitudes de ejemplo

http(s)://ros.aliyuncs.com/?Action=ListStackGroups
&RegionId=cn-hangzhou
&Status=ACTIVE
&<Common request parameters>

Respuestas de ejemplo correctas

Formato XML

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

<ListStackGroupsResponse>
    <StackGroups>
        <StackGroupId>fd0ddef9-9540-4b42-a464-94f77835****</StackGroupId>
        <Status>ACTIVE</Status>
        <DriftDetectionTime>2020-02-27T07:47:47</DriftDetectionTime>
        <Description>My Stack Group</Description>
        <StackGroupDriftStatus>IN_SYNC</StackGroupDriftStatus>
        <StackGroupName>MyStackGroup</StackGroupName>
        <Tags>
            <Key>usage1</Key>
            <Value>test1</Value>
        </Tags>
        <ResourceGroupId>rg-acfmzawhxxcj****</ResourceGroupId>
        <PermissionModel>SELF_MANAGED</PermissionModel>
        <AutoDeployment>
            <Enabled>true</Enabled>
            <RetainStacksOnAccountRemoval>true</RetainStacksOnAccountRemoval>
        </AutoDeployment>
    </StackGroups>
    <TotalCount>1</TotalCount>
    <RequestId>14A07460-EBE7-47CA-9757-12CC4761D47A</RequestId>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
</ListStackGroupsResponse>

Formato JSON

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

{
  "StackGroups" : {
    "StackGroupId" : "fd0ddef9-9540-4b42-a464-94f77835****",
    "Status" : "ACTIVE",
    "DriftDetectionTime" : "2020-02-27T07:47:47",
    "Description" : "My Stack Group",
    "StackGroupDriftStatus" : "IN_SYNC",
    "StackGroupName" : "MyStackGroup",
    "Tags" : {
      "Key" : "usage1",
      "Value" : "test1"
    },
    "ResourceGroupId" : "rg-acfmzawhxxcj****",
    "PermissionModel" : "SELF_MANAGED",
    "AutoDeployment" : {
      "Enabled" : true,
      "RetainStacksOnAccountRemoval" : true
    }
  },
  "TotalCount" : 1,
  "RequestId" : "14A07460-EBE7-47CA-9757-12CC4761D47A",
  "PageSize" : 10,
  "PageNumber" : 1
}

Códigos de error

Para consultar la lista de códigos de error, consulte Códigos de error del servicio.

Código de error	Mensaje de error	Código de estado HTTP	Descripción
InvalidParameter	The specified parameter {name} is invalid, {reason}.	400	El mensaje de error devuelto porque el parámetro especificado no es válido. name indica el nombre del parámetro. reason indica la causa del error.