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 V3> 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 de un tenant.

Restricciones

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 consulta. Si el número de registros es superior a 2000, se devolverá el marcador de paginación.

URI

GET /v3/{project_id}/vpc/security-groups

**Tabla 1** Descripción del parámetro
Nombre	Obligatorio	Tipo	Descripción
project_id	Sí	String	ID del proyecto. Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto.

**Tabla 2** Parámetros de consulta
Parámetro	Obligatorio	Tipo	Descripción
limit	No	Integer	Número de registros mostrados en cada página. Rango de valores: 0 a 2000
marker	No	String	Iniciar ID de recurso de consulta de paginación. Si el parámetro se deja en blanco, solo se consultan los recursos de la primera página.
id	No	String	ID del grupo de seguridad. Este campo se puede utilizar para filtrar con precisión los grupos de seguridad. Se pueden especificar varios ID para el filtrado.
name	No	Array of strings	Nombre del grupo de seguridad. Este campo se puede utilizar para filtrar con precisión los grupos de seguridad. Se pueden especificar varios nombres para el filtrado.
description	No	Array of strings	Proporciona la información complementaria sobre el grupo de seguridad. Este campo se puede utilizar para filtrar con precisión los grupos de seguridad. Se pueden especificar varias descripciones para el filtrado.
enterprise_project_id	No	String	ID de 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, establezca all_granted_eps.

Parámetro de solicitud

No hay

Ejemplo de la solicitud

Consultar grupos de seguridad.

"GET https://{Endpoint}/v3/{project_id}/vpc/security-groups"

Parámetro de respuesta

Cuando el código de estado es de 200, los parámetros de respuesta son los siguientes:

**Tabla 3** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
security_groups	Array of SecurityGroup objects	Cuerpo de respuesta de los grupos de seguridad
request_id	String	ID de solicitud
page_info	PageInfo object	Pagination information

**Tabla 4** SecurityGroup
Parámetro	Tipo	Descripción
id	String	ID del grupo de seguridad, que identifica de forma exclusiva al grupo de seguridad El valor está en formato UUID con guiones (-).
name	String	Nombre del grupo de seguridad El valor puede contener de 1 a 64 caracteres, incluidos letras, dígitos, guiones bajos (_), guiones (-) y puntos (.).
description	String	Proporciona la información complementaria sobre el grupo de seguridad. El valor no puede contener más de 255 caracteres y no puede contener corchetes angulares (< o >).
project_id	String	ID del proyecto al que pertenece el grupo de seguridad
created_at	String	Hora en la que se crea el grupo de seguridad Tiempo de UTC en el formato de aaaa-MM-ddTHH:mmss
updated_at	String	Hora en la que se actualiza el grupo de seguridad Tiempo de UTC en el formato de aaaa-MM-ddTHH:mmss
enterprise_project_id	String	ID del proyecto de empresa al que pertenece 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.

**Tabla 5** page_info
Parámetro	Tipo	Descripción
previous_marker	String	Primer registro en la página actual
cuenta_corriente	Integer	Número total de registros en la página actual
next_marker	String	Último registro en la página actual. Este parámetro no existe si la página es la última.

Cuando el código de estado es de 400, los parámetros de respuesta son los siguientes:

**Tabla 6** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
request_id	String	ID de solicitud
error_msg	String	Mensaje de error
error_code	String	Código de error

Cuando el código de estado es de 401, los parámetros de respuesta son los siguientes:

**Tabla 7** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
request_id	String	ID de solicitud
error_msg	String	Mensaje de error
error_code	String	Código de error

Cuando el código de estado es de 403, los parámetros de respuesta son los siguientes:

**Tabla 8** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
request_id	String	ID de solicitud
error_msg	String	Mensaje de error
error_code	String	Código de error

Cuando el código de estado es de 500, los parámetros de respuesta son los siguientes:

**Tabla 9** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
request_id	String	ID de solicitud
error_msg	String	Mensaje de error
error_code	String	Código de error

Ejemplo de la respuesta

Cuando el código de estado es de 200, los parámetros de respuesta son los siguientes:

Aceptar

{
    "request_id": "d31cb32ca06f3c1a294fa24e6cbc5a56", 
    "security_groups": [
        {
            "id": "0552091e-b83a-49dd-88a7-4a5c86fd9ec3", 
            "name": "Sys-FullAccess--", 
            "project_id": "060576782980d5762f9ec014dd2f1148", 
            "description": "~!@#¥", 
            "enterprise_project_id": "0", 
            "created_at": "2019-10-16T11:11:14Z", 
            "updated_at": "2020-03-25T10:53:46Z"
        }, 
        {
            "id": "0b8cb773-197c-4c91-94f1-e051f0563e5a", 
            "name": "test-sg", 
            "project_id": "060576782980d5762f9ec014dd2f1148", 
            ""description": "The security group is for general-purpose web servers and includes default rules that allow all inbound ICMP traffic and allow inbound traffic on ports 22, 3389, 80, and 443. This security group is suitable for ECSs that require remote login, public network ping, and website services.",
            "enterprise_project_id": "0", 
            "created_at": "2019-12-03T09:02:11Z", 
            "updated_at": "2019-12-03T09:02:11Z"
        }
    ], 
    "page_info": {
        "previous_marker": "0552091e-b83a-49dd-88a7-4a5c86fd9ec3", 
        "current_count": 2
    }
}