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 nativa de OpenStack Neutron (V2.0)> 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 todos los grupos de seguridad accesibles para el tenant que envía la solicitud. Se puede devolver un máximo de 2000 registros para cada operación de consulta. Si el número de registros es superior a 2000, se devolverá el marcador de paginación. Para obtener más información, consulte la sección Paginación.

URI

GET /v2.0/security-groups

Ejemplo de consulta de grupos de seguridad por página

GET https://{Endpoint}/v2.0/security-groups?limit=2&marker=0431c9c5-1660-42e0-8a00-134bec7f03e2&page_reverse=False

Tabla 1 describe los parámetros.

**Tabla 1** Descripción del parámetro
Nombre	Obligatorio	Tipo	Descripción
id	No	String	Especifica que el ID se utiliza como condición de filtrado.
name	No	String	Especifica que el nombre se utiliza como condición de filtrado.
description	No	String	Especifica que la descripción se utiliza como condición de filtrado.
tenant_id	No	String	Especifica que el ID del proyecto se utiliza como la condición de filtrado.
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.

Mensaje de solicitud

No hay

Ejemplo de la solicitud

GET https://{Endpoint}/v2.0/security-groups?limit=1

Mensaje de la respuesta

**Tabla 2** Parámetro de respuesta
Parámetro	Tipo	Descripción
security_groups	Array of Security Group objects	Especifica la lista de grupos de seguridad. Para obtener más información, véase Tabla 3.
security_groups_links	Array of SecurityGroupsLink objects	Muestra la información de paginación acerca de los grupos de seguridad. Solo cuando se utiliza limit para filtrar y el número de recursos excede el valor de limit o 2000 (valor predeterminado de limit), se devolverá el valor next para rel y un enlace para href.

**Tabla 3** Objetos de **Security Group**
Atributo	Tipo	Descripción
id	String	Especifica el ID del grupo de seguridad. Este parámetro no es obligatorio cuando consulta los grupos de seguridad.
tenant_id	String	Especifica el ID del proyecto.
name	String	Especifica el nombre del grupo de seguridad.
description	String	Proporciona la información complementaria sobre el grupo de seguridad.
security_group_rules	Array of Security Group Rule objects	Especifica la lista de reglas del grupo de seguridad. Para obtener más información, véase Tabla 4.
project_id	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.
created_at	String	Especifica la hora (UTC) en la que se crea el grupo de seguridad. Formato: aaaa-MM-ddTHH:mm:ss
updated_at	String	Especifica la hora (UTC) cuando se actualiza el grupo de seguridad. Formato: aaaa-MM-ddTHH:mm:ss

**Tabla 4** Objetos de **Security Group Rule**
Atributo	Tipo	Descripción
id	String	Especifica el identificador de la regla del grupo de seguridad. Este parámetro no es obligatorio cuando consulta las reglas del grupo de seguridad.
description	String	Proporciona la información adicional acerca de la regla del grupo de seguridad.
security_group_id	String	Especifica el ID del grupo de seguridad perteneciente.
remote_group_id	String	Especifica el identificador del par del grupo de seguridad perteneciente.
direction	String	Especifica la dirección del tráfico para el que tiene efecto la regla de grupo de seguridad.
remote_ip_prefix	String	Especifica el segmento de dirección IP del mismo nivel.
protocol	String	Especifica el tipo de protocolo o el número de protocolo IP.
port_range_max	Integer	Especifica el número máximo de puerto. Cuando se utiliza ICMP, el valor es el código de ICMP.
port_range_min	Integer	Especifica el número de puerto mínimo. Si se utiliza el protocolo ICMP, este parámetro indica el tipo de ICMP. Cuando se utiliza el protocolo TCP o UDP, deben especificarse tanto port_range_max como port_range_min, y el valor port_range_max debe ser mayor que el valor port_range_min. Cuando se utiliza el protocolo ICMP, si especifica el código ICMP (port_range_max), también debe especificar el tipo de ICMP (port_range_min).
ethertype	String	Especifica el tipo de red. Se admiten IPv4 e IPv6.
tenant_id	String	Especifica el ID del proyecto.
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.
project_id	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.
created_at	String	Especifica la hora (UTC) en la que se crea la regla de grupo de seguridad. Formato: aaaa-MM-ddTHH:mm:ss
updated_at	String	Especifica la hora (UTC) en la que se actualiza la regla del grupo de seguridad. Formato: aaaa-MM-ddTHH:mm:ss

**Tabla 5** Objetos de **SecurityGroupsLink**
Parámetro	Tipo	Descripción
href	String	Especifica el enlace de API.
rel	String	Especifica la relación entre el enlace de API y la versión de API.

Ejemplo de la respuesta

{
    "security_groups": [
        {
            "id": "0431c9c5-1660-42e0-8a00-134bec7f03e2",
            "name": "sg-ad3f",
            "description": "",
            "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
            "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
            "security_group_rules": [
                {
                    "id": "d90e55ba-23bd-4d97-b722-8cb6fb485d69",
                    "direction": "ingress",
                    "protocol": null,
                    "ethertype": "IPv4",
                    "description": null,
                    "remote_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2",
                    "remote_ip_prefix": null,
                    "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
                    "port_range_max": null,
                    "port_range_min": null,
                    "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2",
                    "remote_address_group_id": "0150a3a7-82ca-4569-865c-04e46e5e9249" 
                },
                {
                    "id": "aecff4d4-9ce9-489c-86a3-803aedec65f7",
                    "direction": "egress",
                    "protocol": null,
                    "ethertype": "IPv4",
                    "description": null,
                    "remote_group_id": null,
                    "remote_ip_prefix": null,
                    "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c",
                    "port_range_max": null,
                    "port_range_min": null,
                    "security_group_id": "0431c9c5-1660-42e0-8a00-134bec7f03e2",
                    "remote_address_group_id": null
                }
            ],
            "created_at": "2018-09-12T08:24:14",
            "updated_at": "2018-09-12T08:24:14"
        }
    ],
    "security_groups_links": [
       {
            "rel": "next", 
            "href": "https://{Endpoint}/v2.0/security-groups?limit=1&marker=0431c9c5-1660-42e0-8a00-134bec7f03e2"
        }, 
       {    "rel": "previous", 
            "href": "https://{Endpoint}/v2.0/security-groups?limit=1&marker=0431c9c5-1660-42e0-8a00-134bec7f03e2&page_reverse=True"
        }
    ]
}