Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda> Virtual Private Cloud> Referencia de la API> API> Grupo de seguridad> Consulta de grupos de seguridad

Actualización más reciente 2023-02-03 GMT+08:00

Ver PDF

Consulta de grupos de seguridad

Función

Esta API se utiliza para consultar grupos de seguridad mediante los criterios de búsqueda y para mostrar los grupos de seguridad en una lista.

URI

GET /v1/{project_id}/security-groups

Por ejemplo:

GET https://{Endpoint}/v1/{project_id}/security-groups?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85

Tabla 1 describe los parámetros.

**Tabla 1** Descripción del parámetro
Nombre	Obligatorio	Tipo	Descripción
project_id	Sí	String	Especifica el ID del proyecto. Para obtener más información sobre cómo obtener un ID de proyecto, consulte Obtención de un ID de proyecto.
marker	No	String	Especifica un ID de recurso para la consulta de paginación, que indica que la consulta comienza en el siguiente registro del ID de recurso especificado. Este parámetro puede funcionar junto con el parámetro limit. Si no se pasan los parámetros marker y limit, se devolverán los registros de recursos de la primera página. Si no se pasa el parámetro marker y el valor del parámetro limit se establece en 10 se devolverán los 10 primeros registros de recursos. Si el valor del parámetro marker se establece en el ID de recurso del 10º registro y el valor del parámetro limit se establece en 10, se devolverán los registros de recursos del 11º al 20º. Si el valor del parámetro marker se establece en el ID de recurso del 10º registro y no se pasa el parámetro limit, se devolverán los registros de recursos que comienzan desde el 11º registro (incluido el 11º).
limit	No	Integer	Especifica el número de registros que se devolverán en cada página. El valor es de 0 a intmax (2^31-1). limit se puede utilizar junto con marker. Para obtener más información, consulte la descripción de parámetros de marker.
vpc_id	No	String	Especifica que el ID de VPC se utiliza como condición de filtrado.
enterprise_project_id	No	String	Especifica el ID del proyecto de empresa. Este campo se puede utilizar para filtrar los grupos de seguridad de un proyecto de empresa. El valor es 0 o una string que contiene un máximo de 36 caracteres en formato UUID con guiones (-). El valor 0 indica el proyecto de empresa predeterminado. Para obtener los grupos de seguridad enlazados a todos los proyectos de empresa del usuario o para mostrar la lista de grupos de seguridad para las cuentas de miembros del proyecto de empresa, establezca all_granted_eps. NOTA: Para obtener más información acerca de los proyectos de empresa y cómo obtener los ID de proyecto de empresa, consulte la Guía del usuario de Enterprise Management.

Mensaje de solicitud

Parámetro de solicitud
No hay

Ejemplo de la solicitud

GET https://{Endpoint}/v1/{project_id}/security-groups

Mensaje de la respuesta

Parámetro de respuesta

**Tabla 2** Parámetro de respuesta
Nombre	Tipo	Descripción
security_groups	Array of security_group objects	Especifica los objetos del grupo de seguridad. Para obtener más información, véase Tabla 3.

**Tabla 3** Descripción de los campos de **security_group**
Nombre	Tipo	Descripción
name	String	Especifica el nombre del grupo de seguridad.
description	String	Proporciona la información complementaria sobre el grupo de seguridad.
id	String	Especifica el identificador del grupo de seguridad, que identifica de forma exclusiva al grupo de seguridad.
vpc_id	String	Especifica el ID de recurso de la VPC a la que pertenece el grupo de seguridad. NOTA: Este parámetro ha sido descartado. No lo use.
security_group_rules	Array of security_group_rule objects	Especifica las reglas de grupo de seguridad predeterminadas, que garantizan que los recursos del grupo de seguridad puedan comunicarse entre sí.
enterprise_project_id	String	Especifica el ID del proyecto de empresa. Al crear un grupo de seguridad, asocie el ID del proyecto de empresa con el grupo de seguridad. El valor es 0 o una string que contiene un máximo de 36 caracteres en formato UUID con guiones (-). El valor 0 indica el proyecto de empresa predeterminado. NOTA:

**Tabla 4** Objetos **security_group_rule**
Nombre	Tipo	Descripción
id	String	Especifica el identificador de regla de grupo de seguridad, que identifica de forma exclusiva la regla de grupo de seguridad.
description	String	Proporciona la información adicional acerca de la regla del grupo de seguridad. El valor no puede contener más de 255 caracteres, incluidas letras y dígitos.
security_group_id	String	Especifica el identificador de regla de grupo de seguridad, que identifica de forma exclusiva la regla de grupo de seguridad.
direction	String	Especifica la dirección del control de acceso. Los valores posibles son los siguientes: egress ingress
ethertype	String	Especifica la versión del protocolo IP. El valor puede ser IPv4 o IPv6.
protocol	String	Especifica el tipo de protocolo. El valor puede ser icmp, tcp o udp. Si el parámetro se deja en blanco, se admiten todos los protocolos.
port_range_min	Integer	Especifica el número de puerto inicial. El valor varía de 1 a 65535. El valor no puede ser mayor que el valor port_range_max. Un valor vacío indica todos los puertos. Si el protocolo es el icmp, el rango de valores se muestra en el documento Tabla de relación de rangos de puertos ICMP.
port_range_max	Integer	Especifica el número de puerto final. El valor varía de 1 a 65535. Si el protocolo no es icmp, el valor no puede ser menor que el valor port_range_min. Un valor vacío indica todos los puertos. Si el protocolo es el icmp, el rango de valores se muestra en el documento Tabla de relación de rangos de puertos ICMP.
remote_ip_prefix	String	Especifica la dirección IP remota. Si la dirección de control de acceso se establece en egress, el parámetro especifica la dirección IP de origen. Si la dirección de control de acceso se establece en ingress, el parámetro especifica la dirección IP de destino. El valor puede estar en formato CIDR o direcciones IP. El parámetro es exclusivo con el parámetro remote_group_id.
remote_group_id	String	Especifica el ID del grupo de seguridad del mismo nivel. El valor es exclusivo con el parámetro remote_ip_prefix.
remote_address_group_id	String	Especifica el ID del grupo de direcciones IP remotas. El valor es exclusivo con los parámetros remote_ip_prefix y remote_group_id.
tenant_id	String	Especifica el identificador del proyecto al que pertenece la regla del grupo de seguridad.

Ejemplo de la respuesta

{
    "security_groups": [
        {
            "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", 
            "name": "qq", 
            "description": "qq", 
            "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", 
            "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2",
            "security_group_rules": [
                {
                    "direction": "egress", 
                    "ethertype": "IPv4", 
                    "id": "369e6499-b2cb-4126-972a-97e589692c62", 
                    "description": "",
                    "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6",
                    "remote_address_group_id": null
                }, 
                {
                    "direction": "ingress", 
                    "ethertype": "IPv4", 
                    "id": "0222556c-6556-40ad-8aac-9fd5d3c06171", 
                    "description": "",
                    "remote_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", 
                    "security_group_id": "16b6e77a-08fa-42c7-aa8b-106c048884e6"
                }
            ]
        }, 
        {
            "id": "9c0f56be-a9ac-438c-8c57-fce62de19419", 
            "name": "default", 
            "description": "qq", 
            "vpc_id": "13551d6b-755d-4757-b956-536f674975c0", 
            "enterprise_project_id": "0",
            "security_group_rules": [
                {
                    "direction": "egress", 
                    "ethertype": "IPv4", 
                    "id": "95479e0a-e312-4844-b53d-a5e4541b783f", 
                    "description": "",
                    "security_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419"
                }, 
                {
                    "direction": "ingress", 
                    "ethertype": "IPv4", 
                    "id": "0c4a2336-b036-4fa2-bc3c-1a291ed4c431",
                    "description": "", 
                    "remote_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419", 
                    "security_group_id": "9c0f56be-a9ac-438c-8c57-fce62de19419"
                }
            ]
        }
    ]
}