DescribeSecurityGroups - - Centro de documentación de Alibaba Cloud

Consulta la información básica de los security groups que ha creado, como sus ID, descripciones, tipos y tipos de red.

Notas de uso

Tenga en cuenta los siguientes puntos:

La información básica de los security groups incluye sus ID y descripciones. La respuesta devuelve los security groups ordenados por ID en sentido descendente.
Se recomienda usar los parámetros MaxResults y NextToken para consultas paginadas. Use MaxResults para especificar el número máximo de entradas que se devolverán en cada solicitud. El valor devuelto de NextToken es un token de paginación que puede usarse en la siguiente solicitud para recuperar una nueva página de resultados. Al realizar la siguiente solicitud, establezca NextToken con el valor obtenido en la llamada anterior y use MaxResults para indicar el número máximo de entradas a devolver. Si el valor devuelto de NextToken está vacío, la página actual es la última y no hay más resultados pendientes.
Cuando use Alibaba Cloud CLI para invocar una operación de API, debe especificar los valores de los parámetros de solicitud según el formato requerido para cada tipo de dato. Para obtener más información, consulte Parameter format overview.

Depuración

OpenAPI Explorer calcula automáticamente el valor de la firma. Por comodidad, le recomendamos invocar esta operación desde OpenAPI Explorer. Esta herramienta genera dinámicamente 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í	DescribeSecurityGroups	La operación que desea ejecutar. Establezca el valor en DescribeSecurityGroups.
RegionId	String	Sí	cn-hangzhou	El ID de región del security group. Puede invocar la operación DescribeRegions para consultar la lista de regiones más reciente.
SecurityGroupIds	String	No	["sg-bp67acfmxazb4p**", "sg-bp67acfmxazb4p", "sg-bp67acfmxazb4p**",....]	Los ID de los security groups. El valor es un arreglo JSON que contiene hasta 100 ID de security groups. Separe los ID con comas (,).
VpcId	String	No	vpc-bp67acfmxazb4p****	El ID de la Virtual Private Cloud (VPC) a la que pertenece el security group.
SecurityGroupType	String	No	normal	El tipo de security group. Valores válidos: normal: security group básico enterprise: security group avanzado Nota Si no especifica este parámetro, se consultan tanto los security groups básicos como los avanzados.
NextToken	String	No	e71d8a535bd9cc11	Token de paginación que se usa en la siguiente solicitud para recuperar una nueva página de resultados. No es necesario especificar este parámetro en la primera solicitud. Debe indicar el token obtenido en la consulta anterior como valor de NextToken.
MaxResults	Integer	No	10	Número máximo de entradas por página. Si especifica MaxResults, se usan `MaxResults` y `NextToken` para realizar una consulta paginada. Valores válidos: 1 a 100. Valor predeterminado: 10.
NetworkType	String	No	vpc	Tipo de red del security group. Valores válidos: vpc classic
SecurityGroupName	String	No	SGTestName	Nombre del security group.
IsQueryEcsCount	Boolean	No	null	Indica si se debe consultar la capacidad del security group. Si establece este parámetro en True, los valores `EcsCount` y `AvailableInstanceAmount` en la respuesta serán válidos. Nota Este parámetro ya no se usa.
ResourceGroupId	String	No	rg-bp67acfmxazb4p****	ID del resource group al que pertenece el security group. Si se especifica este parámetro para consultar recursos, la respuesta puede mostrar hasta 1,000 recursos pertenecientes al resource group indicado. Puede invocar la operación ListResourceGroups para obtener la lista más reciente de resource groups. Nota Los recursos del resource group predeterminado se muestran en la respuesta independientemente de cómo se configure este parámetro.
Tag.N.key	String	No	testkey	Clave de la etiqueta N del security group. Nota Este parámetro se eliminará en el futuro. Se recomienda usar el parámetro Tag.N.Key para garantizar la compatibilidad futura.
Tag.N.Key	String	No	TestKey	Clave de la etiqueta N del security group. Valores válidos de N: 1 a 20. Si se especifica una sola etiqueta para consultar recursos, se devuelven hasta 1,000 recursos que tienen asignada dicha etiqueta. Si se especifican varias etiquetas, se devuelven hasta 1,000 recursos que contienen todas las etiquetas indicadas. Para consultar más de 1,000 recursos con las etiquetas especificadas, invoque la operación ListTagResources.
Tag.N.Value	String	No	TestValue	Valor de la etiqueta. Valores válidos de N: 1 a 20.
Tag.N.value	String	No	testvalue	Valor de la etiqueta N del security group. Nota Este parámetro quedará obsoleto en el futuro. Se recomienda usar el parámetro Tag.N.Value para garantizar la compatibilidad futura.
DryRun	Boolean	No	false	Indica si se debe ejecutar solo una prueba sin realizar la solicitud real. Valores válidos: true: ejecuta únicamente la prueba. El sistema comprueba el par de AccessKey, los permisos del usuario de Resource Access Management (RAM) y los parámetros obligatorios. Si la prueba falla, se devuelve un mensaje de error. De lo contrario, se devuelve el código de error DryRunOperation. false: ejecuta la prueba y posteriormente la solicitud real. Si la prueba se supera correctamente, se devuelve un código de estado HTTP 2xx y se ejecuta la operación. Valor predeterminado: false.
SecurityGroupId	String	No	sg-bp67acfmxazb4p****	ID del security group.
FuzzyQuery	Boolean	No	null	Nota Este parámetro ya no se usa.
PageNumber	Integer	No	1	Número de página. Las páginas comienzan en la 1. Valor predeterminado: 1. Nota Este parámetro se eliminará en el futuro. Se recomienda usar los parámetros NextToken y MaxResults para consultas paginadas.
PageSize	Integer	No	10	Número de entradas por página. Valores válidos: 1 a 50. Valor predeterminado: 10. Nota Este parámetro se eliminará en el futuro. Se recomienda usar los parámetros NextToken y MaxResults para consultas paginadas.
ServiceManaged	Boolean	No	false	Indica si se deben consultar los security groups administrados. Valores válidos: true false

Parámetros de respuesta

Parámetro	Tipo	Ejemplo	Descripción
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E	ID de la solicitud.
RegionId	String	cn-hangzhou	ID de región del security group.
NextToken	String	e71d8a535bd9cc11	Token de paginación. Puede usarse en la siguiente solicitud para recuperar una nueva página de resultados. Si el valor devuelto de este parámetro está vacío cuando se especifican MaxResults y NextToken en una consulta paginada, significa que no quedan más resultados por devolver.
SecurityGroups	Array of SecurityGroup		Detalles de los security groups.
SecurityGroup
SecurityGroupId	String	sg-bp67acfmxazb4p****	ID del security group.
SecurityGroupName	String	SGTestName	Nombre del security group.
Description	String	TestDescription	Descripción del security group.
SecurityGroupType	String	normal	Tipo de security group. Valores válidos: normal: security group básico enterprise: security group avanzado
VpcId	String	vpc-bp67acfmxazb4p****	ID de la VPC a la que pertenece el security group.
CreationTime	String	2021-08-31T03:12:29Z	Hora de creación del security group. La hora sigue el estándar ISO 8601 con el formato yyyy-MM-ddThh:mmZ y se muestra en UTC.
EcsCount	Integer	0	Número de direcciones IP privadas contenidas en el security group. Para obtener más información, consulte la sección "Capacidad de security group" en Basic security groups and advanced security groups. Si establece IsQueryEcsCount en True, el valor del parámetro en la respuesta será válido. Nota Este parámetro ya no se usa. La cantidad devuelta es solo orientativa; la cantidad real podría diferir.
AvailableInstanceAmount	Integer	0	Número de direcciones IP privadas que pueden agregarse al security group. Para obtener más información, consulte la sección "Capacidad de security group" en Basic security groups and advanced security groups. Si establece IsQueryEcsCount en True, el valor del parámetro en la respuesta será válido. Nota Este parámetro ya no se usa. La cantidad devuelta es solo orientativa; la cantidad real podría diferir.
ResourceGroupId	String	rg-bp67acfmxazb4p****	ID del resource group al que pertenece el security group.
ServiceManaged	Boolean	false	Indica si el usuario del security group es un servicio de Alibaba Cloud o un distribuidor.
ServiceID	Long	12345678910	ID del distribuidor al que pertenece el security group.
Tags	Array of Tag		Etiquetas del security group.
Tag
TagValue	String	TestValue	Valor de la etiqueta.
TagKey	String	TestKey	Clave de la etiqueta.
TotalCount	Integer	20	Número total de security groups. Si se especifican `MaxResults` y `NextToken` en la solicitud, no se devuelve el valor de este parámetro.
PageNumber	Integer	1	Número de página. Nota Este parámetro se eliminará en el futuro. Se recomienda usar los parámetros NextToken y MaxResults para consultas paginadas.
PageSize	Integer	10	Número de entradas por página. Nota Este parámetro se eliminará en el futuro. Se recomienda usar los parámetros NextToken y MaxResults para consultas paginadas.

Ejemplos

Solicitudes de ejemplo

http(s)://ecs.aliyuncs.com/?Action=DescribeSecurityGroups
&RegionId=cn-hangzhou
&MaxResults=10
&<Common request parameters>

Respuestas exitosas de ejemplo

Formato XML

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

<DescribeSecurityGroupsResponse>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
    <TotalCount>20</TotalCount>
    <RegionId>cn-hangzhou</RegionId>
    <SecurityGroups>
        <CreationTime>2021-08-31T03:12:29Z</CreationTime>
        <VpcId>vpc-bp67acfmxazb4p****</VpcId>
        <ServiceManaged>false</ServiceManaged>
        <Description>TestDescription</Description>
        <SecurityGroupId>sg-bp67acfmxazb4p****</SecurityGroupId>
        <ResourceGroupId>rg-bp67acfmxazb4p****</ResourceGroupId>
        <SecurityGroupName>SGTestName</SecurityGroupName>
        <EcsCount>0</EcsCount>
        <ServiceID>12345678910</ServiceID>
        <SecurityGroupType>normal</SecurityGroupType>
        <AvailableInstanceAmount>0</AvailableInstanceAmount>
        <Tags>
            <TagValue>TestValue</TagValue>
            <TagKey>TestKey</TagKey>
        </Tags>
    </SecurityGroups>
    <NextToken>e71d8a535bd9cc11</NextToken>
</DescribeSecurityGroupsResponse>

Formato JSON

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

{
  "PageSize" : 10,
  "PageNumber" : 1,
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "TotalCount" : 20,
  "RegionId" : "cn-hangzhou",
  "SecurityGroups" : [ {
    "CreationTime" : "2021-08-31T03:12:29Z",
    "VpcId" : "vpc-bp67acfmxazb4p****",
    "ServiceManaged" : false,
    "Description" : "TestDescription",
    "SecurityGroupId" : "sg-bp67acfmxazb4p****",
    "ResourceGroupId" : "rg-bp67acfmxazb4p****",
    "SecurityGroupName" : "SGTestName",
    "EcsCount" : 0,
    "ServiceID" : 12345678910,
    "SecurityGroupType" : "normal",
    "AvailableInstanceAmount" : 0,
    "Tags" : [ {
      "TagValue" : "TestValue",
      "TagKey" : "TestKey"
    } ]
  } ],
  "NextToken" : "e71d8a535bd9cc11"
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	NotSupported.PageNumberAndPageSize	The parameters PageNumber and PageSize are currently not supported, please use NextToken and MaxResults instead.	Los parámetros PageNumber y PageSize no son compatibles actualmente. Use NextToken y MaxResults en su lugar.
400	InValidParameter.NextToken	The parameter NextToken is invalid.	El valor de NextToken no es válido.
400	MissingParameter.RegionId	The input parameter RegionId that is mandatory for processing this request is not supplied.	El parámetro RegionId es obligatorio.
400	InvalidParameter.SecurityGroupType	The specified SecurityGroupType is not valid.	El valor de SecurityGroupType no es válido.
500	InternalError	The request processing has failed due to some unknown error.	Ocurrió un error interno. Inténtelo de nuevo más tarde.

Para obtener una lista de códigos de error, consulte Códigos de error del servicio.