Consulta de reglas de grupo de seguridad
Función
Esta API se utiliza para consultar reglas de grupo de seguridad.
URI
GET /v3/{project_id}/vpc/security-group-rules
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. |
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 |
Array of strings |
ID de la regla de grupo de seguridad. Se pueden especificar varios ID para el filtrado. |
security_group_id |
No |
Array of strings |
ID del grupo de seguridad al que pertenece la regla de grupo de seguridad. Se pueden especificar varios ID para el filtrado. |
protocol |
No |
Array of strings |
Protocolo especificado en la regla de grupo de seguridad. Se pueden especificar varios protocolos 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. |
remote_group_id |
No |
Array of strings |
ID del grupo de seguridad remoto. Se pueden especificar varios ID para el filtrado. |
direction |
No |
String |
Dirección de control de acceso especificada en la regla de grupo de seguridad. |
action |
No |
String |
Acción de la regla de grupo de seguridad. |
Parámetro de solicitud
No hay
Ejemplo de la solicitud
- Consultar reglas de grupo de seguridad.
"GET https://{Endpoint}/v3/{project_id}/vpc/security-group-rules"
Parámetro de respuesta
Cuando el código de estado es de 200, los parámetros de respuesta son los siguientes:
Parámetro |
Tipo |
Descripción |
---|---|---|
request_id |
String |
ID de solicitud |
security_group_rules |
Array of SecurityGroupRule objects |
Cuerpo de respuesta de las reglas del grupo de seguridad |
page_info |
PageInfo object |
Información de la paginación |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de regla de grupo de seguridad, que identifica de forma exclusiva la regla de grupo de seguridad El valor está en formato UUID con guiones (-). |
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 >). |
security_group_id |
String |
ID del grupo de seguridad al que pertenece la regla de grupo de seguridad. |
direction |
String |
Dirección de entrada o salida de una regla de grupo de seguridad. El valor puede ser:
|
protocol |
String |
Tipo de protocolo El valor puede ser icmp, tcp, udp, icmpv6 o un número IP.
Restricciones:
|
ethertype |
String |
Versión de IP El valor puede ser IPv4 o IPv6. Si no establece este parámetro, se utiliza IPv4 de forma predeterminada. |
multiport |
String |
Puerto o rango de puertos El valor puede ser un solo puerto (80), un rango de puertos (1-30), o puertos no consecutivos separados por comas (22,3389,80). |
action |
String |
Acción de la regla de grupo de seguridad.
El valor puede ser:
El valor predeterminado es deny. |
priority |
Integer |
Prioridad de la regla. El valor va de 1 a 100. El valor 1 indica la prioridad más alta. |
remote_group_id |
String |
ID del grupo de seguridad remoto, que permite o deniega el tráfico hacia y desde el grupo de seguridad. Intervalo de valores: ID de un grupo de seguridad existente El parámetro es exclusivo con los parámetros remote_ip_prefix y remote_address_group_id. |
remote_ip_prefix |
String |
Dirección IP remota.
El valor es una dirección IP o un bloque CIDR. El parámetro es exclusivo con los parámetros remote_group_id y remote_address_group_id. |
remote_address_group_id |
String |
ID del grupo de direcciones IP remotas. Intervalo de valores: ID de un grupo de direcciones IP existente El parámetro es exclusivo con los parámetros remote_ip_prefix y remote_group_id. |
created_at |
String |
Hora en la que se crea la regla de grupo de seguridad Tiempo de UTC en el formato de aaaa-MM-ddTHH:mmss |
updated_at |
String |
Hora en la que se actualiza la regla del grupo de seguridad Tiempo de UTC en el formato de aaaa-MM-ddTHH:mmss |
project_id |
String |
ID del proyecto al que pertenece la regla del grupo de seguridad. |
Ejemplo de la respuesta
Cuando el código de estado es de 200, los parámetros de respuesta son los siguientes:
{ "request_id": "80747d36e3376c0894ba8f9a9156355d", "security_group_rules": [ { "id": "f626eb24-d8bd-4d26-ae0b-c16bb65730cb", "project_id": "060576782980d5762f9ec014dd2f1148", "security_group_id": "0552091e-b83a-49dd-88a7-4a5c86fd9ec3", "remote_group_id": null, "direction": "ingress", "protocol": "tcp", "description": "security group rule description", "created_at": "2020-08-13T07:12:36Z", "updated_at": "2020-08-13T07:12:36Z", "ethertype": "IPv4", "remote_ip_prefix": "10.10.0.0/16", "multiport": "333", "remote_address_group_id": null, "action": "allow", "priority": 1 } ] }
Código de estado
Véase Códigos de estado.
Código de error
Véase Códigos de error.