Consulta de un grupo de seguridad
Función
Esta API se utiliza para consultar detalles sobre un grupo de seguridad.
URI
GET /v3/{project_id}/vpc/security-groups/{security_group_id}
Parámetro |
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. |
security_group_id |
Sí |
String |
ID del grupo de seguridad. |
Parámetro de solicitud
No hay
Ejemplo de la solicitud
- Consultar los detalles acerca de un grupo de seguridad.
"GET https://{Endpoint}/v3/{project_id}/vpc/security-groups/1d8b19c7-7c56-48f7-a99b-4b40eb390967"
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 |
SecurityGroupInfo object |
Cuerpo de respuesta para consultar detalles sobre un grupo de seguridad |
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. |
security_group_rules |
Array of SecurityGroupRule objects |
Reglas de grupos de seguridad |
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 adicional acerca de la regla del 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. Si el parámetro se deja en blanco, se admiten todos los protocolos. Cuando el protocolo es de icmpv6, la versión de IP debe ser de IPv6. Cuando el protocolo es de icmp, la versión de IP debe ser de IPv4. |
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. |
Cuando el código de estado es de 401, los parámetros de respuesta son los siguientes:
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:
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 404, los parámetros de respuesta son los siguientes:
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:
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:
{ "security_group": { "id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", "name": "security_group_1", "project_id": "060576782980d5762f9ec014dd2f1148", "description": "security group description", "enterprise_project_id": "0", "security_group_rules": [ { "id": "f11a3824-ac19-4fad-b4f1-c5f4a6dd0a80", "project_id": "060576782980d5762f9ec014dd2f1148", "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", "direction": "ingress", "protocol": null, "description": "", "created_at": "2020-07-09T05:56:27Z", "updated_at": "2020-07-09T05:56:27Z", "ethertype": "IPv6", "remote_ip_prefix": null, "multiport": null, "remote_address_group_id": null, "action": "allow", "priority": 100 }, { "id": "3d6480e8-9ea4-46dc-bb1b-8db190cd5677", "project_id": "060576782980d5762f9ec014dd2f1148", "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", "remote_group_id": null, "direction": "egress", "protocol": null, "description": "", "created_at": "2020-07-09T05:56:27Z", "updated_at": "2020-07-09T05:56:27Z", "ethertype": "IPv6", "remote_ip_prefix": null, "multiport": null, "remote_address_group_id": null, "action": "allow", "priority": 100 }, { "id": "9581f18c-1fdd-43da-ace9-7758a56ef28a", "project_id": "060576782980d5762f9ec014dd2f1148", "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", "remote_group_id": null, "direction": "egress", "protocol": null, "description": "", "created_at": "2020-07-09T05:56:27Z", "updated_at": "2020-07-09T05:56:27Z", "ethertype": "IPv4", "remote_ip_prefix": null, "multiport": null, "remote_address_group_id": null, "action": "allow", "priority": 100 }, { "id": "a3ba270e-e58b-432d-a912-aeb7eace9fb8", "project_id": "060576782980d5762f9ec014dd2f1148", "security_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", "remote_group_id": "69c999ad-d9ef-4d79-94fd-35e6ceb75325", "direction": "ingress", "protocol": null, "description": "", "created_at": "2020-07-09T05:56:27Z", "updated_at": "2020-07-09T05:56:27Z", "ethertype": "IPv4", "remote_ip_prefix": null, "multiport": null, "remote_address_group_id": null, "action": "allow", "priority": 100 } ], "created_at": "2020-07-09T05:56:27Z", "updated_at": "2020-07-09T05:56:27Z" }, "request_id": "a8cf4f79ca3c22ca685e7e8872e8c20b" }
Código de estado
Véase Códigos de estado.
Código de error
Véase Códigos de error.