DescribeSecurityGroups - Elastic Compute Service - Centro de documentación de Alibaba Cloud

Consulta la información básica de los security groups. Puede filtrar los resultados por región, ID del security group, tipo de security group y otros parámetros mediante una consulta de parámetros.

Descripción de la operación

Consulta paginada: Utilice MaxResults y NextToken para realizar consultas paginadas.
- Si no se devuelve NextToken, la página actual es la última.
- Para la primera página, configure solo MaxResults para limitar el número de entradas a devolver. El valor NextToken en la respuesta se utiliza para consultar las páginas siguientes.
- Para las páginas siguientes, configure NextToken con el valor NextToken devuelto en la respuesta anterior y configure MaxResults para limitar el número de entradas a devolver.
Cuando invoque una operación de API mediante Cloud Assistant CLI, especifique los parámetros de solicitud en el formato requerido. Para obtener más información, consulte Formato de parámetros de comandos de CLI.

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

ecs:DescribeSecurityGroups

get

SecurityGroup

acs:ecs:{#regionId}:{#accountId}:securitygroup/*

SecurityGroup

acs:ecs:{#regionId}:{#accountId}:securitygroup/{#securitygroupId}

ecs:tag
ecs:tag
ecs:tag
ecs:tag

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
RegionId	string	Sí	El ID de la región. Puede llamar a DescribeRegions para consultar la lista de regiones más reciente.	cn-hangzhou
SecurityGroupIds	string	No	Los ID de los security groups. Puede especificar hasta 100 ID de security groups. Separe varios ID con comas (,) en formato de matriz JSON.	["sg-bp67acfmxazb4p**", "sg-bp67acfmxazb4p", "sg-bp67acfmxazb4p**",....]
VpcId	string	No	El ID de la nube privada virtual (VPC) a la que pertenece el security group.	vpc-bp67acfmxazb4p****
SecurityGroupType	string	No	El tipo del security group. Valores válidos: normal: security group básico. enterprise: security group avanzado. Nota Si no especifica este parámetro, se consultan security groups de todos los tipos.	normal
NextToken	string	No	El token de paginación. Configure este parámetro con el valor NextToken devuelto en la solicitud anterior. No necesita configurar este parámetro para la primera solicitud.	e71d8a535bd9cc11
MaxResults	integer	No	El número máximo de entradas por página para la consulta paginada. Si configura este parámetro, se utiliza el método de paginación `MaxResults` y `NextToken`. Valor máximo: 100. Valor predeterminado: 10.	10
NetworkType	string	No	El tipo de red del security group. Valores válidos: vpc: VPC. classic: red clásica. La red clásica está obsoleta. Para obtener más información, consulte Aviso de descontinuación.	vpc
SecurityGroupName	string	No	El nombre del security group.	SGTestName
IsQueryEcsCount	boolean	No	Especifica si se debe consultar la información de capacidad del security group. Si configura este parámetro como True, los valores `EcsCount` y `AvailableInstanceAmount` en la respuesta son válidos. Nota Este parámetro está obsoleto.	null
ResourceGroupId	string	No	El ID del grupo de recursos al que pertenece el security group. Cuando utiliza este parámetro para filtrar recursos, el recuento de recursos no puede exceder 1,000. Puede invocar ListResourceGroups para consultar grupos de recursos. Nota No se admite el filtrado por el grupo de recursos predeterminado.	rg-bp67acfmxazb4p****
Tag	array<object>	No	Las etiquetas.
	object	No	Las etiquetas.
key	string	No	La clave de etiqueta del security group. Nota Para una mejor compatibilidad, utilice el parámetro Tag.N.Key.	testkey
Key	string	No	La clave de etiqueta del security group. Valores válidos de N: 1 a 20. Si utiliza una sola etiqueta para filtrar recursos, el recuento de recursos con la etiqueta especificada no puede exceder 1,000. Si utiliza varias etiquetas para filtrar recursos, el recuento de recursos que tienen todas las etiquetas especificadas adjuntas no puede exceder 1,000. Si el recuento de recursos supera 1,000, llame a ListTagResources para consultar los recursos.	TestKey
Value	string	No	El valor de etiqueta del security group. Valores válidos de N: 1 a 20.	TestValue
value	string	No	El valor de etiqueta del security group. Nota Para una mejor compatibilidad, utilice el parámetro Tag.N.Value.	testvalue
DryRun	boolean	No	Especifica si se debe realizar solo una ejecución de prueba (dry run). Valores válidos: true: realiza solo una ejecución de prueba. El sistema comprueba si la solicitud tiene problemas potenciales, incluidos pares de AccessKey no válidos, usuarios de Resource Access Management (RAM) no autorizados y valores de parámetros faltantes. Si la solicitud no pasa la ejecución de prueba, se devuelve un mensaje de error. Si la solicitud pasa la ejecución de prueba, se devuelve el código de error DryRunOperation. false: realiza una ejecución de prueba y envía la solicitud Normal. Si la solicitud pasa la ejecución de prueba, se devuelve un código de estado HTTP 2xx y se verifica la autorización. Valor predeterminado: false.	false
SecurityGroupId	string	No	El ID del security group.	sg-bp67acfmxazb4p****
FuzzyQuery	boolean	No	Nota Este parámetro está obsoleto.	null
PageNumber	integer	No	Nota Este parámetro se desactivará. Utilice NextToken y MaxResults para la paginación.	1
PageSize	integer	No	Nota Este parámetro se desactivará. Utilice NextToken y MaxResults para la paginación.	10
ServiceManaged	boolean	No	Especifica si el security group administrado está gestionado. Valores válidos: true: El security group administrado está gestionado. false: El security group administrado no está gestionado.	false

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
RegionId	string	El ID de región del security group.	cn-hangzhou
NextToken	string	El token de paginación devuelto en esta llamada. Si este valor está vacío cuando utiliza MaxResults y NextToken para la paginación, no hay más datos disponibles.	e71d8a535bd9cc11
SecurityGroups	object
SecurityGroup	array<object>	La colección de información del security group.
	array<object>	La información del security group.
SecurityGroupId	string	El ID del security group.	sg-bp67acfmxazb4p****
SecurityGroupName	string	El nombre del security group.	SGTestName
Description	string	La descripción del security group.	TestDescription
SecurityGroupType	string	El tipo del security group. Valores válidos: normal: security group básico. enterprise: security group avanzado.	normal
VpcId	string	El ID de la VPC a la que pertenece el security group.	vpc-bp67acfmxazb4p****
CreationTime	string	La hora en que se creó el security group. La hora sigue el estándar ISO 8601 en UTC. Formato: yyyy-MM-ddThh:mmZ.	2021-08-31T03:12:29Z
EcsCount	integer	El número de direcciones IP privadas en el security group. Para obtener más información, consulte Capacidad del security group. Este parámetro es válido solo cuando el parámetro de solicitud IsQueryEcsCount se establece en True. Nota Este parámetro está obsoleto. El valor devuelto es solo para referencia y puede no reflejar datos en tiempo real.	0
AvailableInstanceAmount	integer	El número de direcciones IP privadas que se pueden agregar al security group. Para obtener más información, consulte Capacidad del security group. Este parámetro es válido solo cuando el parámetro de solicitud IsQueryEcsCount se establece en True. Nota Este parámetro está obsoleto. El valor devuelto es solo para referencia y puede no reflejar datos en tiempo real.	0
ResourceGroupId	string	El ID del grupo de recursos al que pertenece el security group.	rg-bp67acfmxazb4p****
ServiceManaged	boolean	Indica si el security group es utilizado por un servicio en la nube o por un Operador de Red Virtual (VNO).	false
ServiceID	integer	El ID del VNO asociado con el security group.	12345678910
Tags	object
Tag	array<object>	La colección de etiquetas del security group.
	object	La etiqueta del security group.
TagValue	string	El valor de etiqueta del security group.	TestValue
TagKey	string	La clave de etiqueta del security group.	TestKey
RuleCount	integer	El número de reglas en el security group.	100
GroupToGroupRuleCount	integer	El número de reglas que autorizan el acceso desde otros security groups.	5
TotalCount	integer	El número total de security groups. Este parámetro no se devuelve cuando utiliza `MaxResults` y `NextToken` para la consulta de parámetros.	20
PageNumber	integer	El número de página actual. Nota Este parámetro se desactivará. Utilice NextToken y MaxResults para la paginación.	1
PageSize	integer	El número de entradas por página. Nota Este parámetro se desactivará. Utilice NextToken y MaxResults para la paginación.	10

Ejemplos

Respuesta exitosa

JSON Formato

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

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.	The PageNumber and PageSize parameters are no longer supported. Use the NextToken and MaxResults parameters instead.
400	InValidParameter.NextToken	The parameter NextToken is invalid.	The specified NextToken parameter is invalid.
400	MissingParameter.RegionId	The input parameter RegionId that is mandatory for processing this request is not supplied.	The RegionId parameter is required.
400	InvalidParameter.SecurityGroupType	The specified SecurityGroupType is not valid.	The specified SecurityGroupType parameter is invalid.
400	InvalidSecurityGroupId.Malformed	The specified parameter SecurityGroupId is not valid.	The specified SecurityGroupId parameter is invalid.
400	InvalidSecurityGroupName.Malformed	The specified parameter SecurityGroupName is not valid.	The specified SecurityGroupName parameter is not valid. This parameter is empty by default. If you specify a security group name, the name must be 2 to 128 characters in length and start with a letter. It can contain letters, digits, periods (.), underscores (_), and hyphens (-) and cannot start with http:// or https. The security group name is displayed in the ECS console.
500	InternalError	The request processing has failed due to some unknown 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.