Creación de un grupo de seguridad
Función
Esta API se utiliza para crear un grupo de seguridad.
URI
POST /v1/{project_id}/security-groups
Nombre |
Obligatorio |
Descripción |
---|---|---|
project_id |
Sí |
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. |
Mensaje de solicitud
- Parámetro de solicitud
Tabla 2 Parámetro de solicitud Nombre
Obligatorio
Tipo
Descripción
security_group
Sí
security_group object
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
Obligatorio
Tipo
Descripción
name
Sí
String
- Especifica el nombre del grupo de seguridad.
- El valor puede contener de 1 a 64 caracteres, incluidos letras, dígitos, guiones bajos (_), guiones (-) y puntos (.).
vpc_id
No
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 se recomienda usarlo.
enterprise_project_id
No
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: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.
- Ejemplo de la solicitud
POST https://{Endpoint}/v1/{project_id}/security-groups { "security_group": { "name": "qq", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" } }
Mensaje de la respuesta
- Parámetro de respuesta
Tabla 4 Parámetro de respuesta Nombre
Tipo
Descripción
security_group
security_group object
Especifica los objetos del grupo de seguridad. Para obtener más información, véase Tabla 5.
Tabla 5 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 se recomienda usarlo.
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: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.
Tabla 6 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_group": { "id": "16b6e77a-08fa-42c7-aa8b-106c048884e6", "name": "qq", "description": "", "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" }, { "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", "remote_address_group_id": null } ] } }
Código de estado
Véase Códigos de estado.
Código de error
Véase Códigos de error.