Creación de una regla de grupo de seguridad

Función

Esta API se utiliza para crear una regla de grupo de seguridad.

URI

POST /v1/{project_id}/security-group-rules

Mensaje de solicitud

• Parámetro de solicitud

  Tabla 1 Parámetro de solicitud

  Nombre	Obligatorio	Tipo	Descripción
  security_group_rule	Sí	security_group_rule object	Especifica los objetos de regla del grupo de seguridad. Para obtener más información, véase Tabla 2.

  Tabla 2 Descripción del campo security_group_rule

  Nombre	Obligatorio	Tipo	Descripción
  security_group_id	Sí	String	Especifica el ID del grupo de seguridad.
  description	No	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.
  direction	Sí	String	El valor puede ser: egress ingress
  ethertype	No	String	Especifica la versión del protocolo IP. El valor puede ser IPv4 o IPv6. Si no establece este parámetro, se utiliza IPv4 de forma predeterminada.
  protocol	No	String	Especifica el tipo de protocolo. El valor puede ser tcp, udp, icmp o un número de protocolo IP (0 a 255). Si el parámetro se deja en blanco, se admiten todos los protocolos.
  port_range_min	No	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	No	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	No	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	No	String	Especifica el ID del grupo de seguridad del mismo nivel. El valor es exclusivo con el parámetro remote_ip_prefix.

• Ejemplo de la solicitud

  POST https://{Endpoint}/v1/{project_id}/security-group-rules
  
  {
      "security_group_rule": {
          "direction": "ingress", 
          "port_range_min": "80", 
          "ethertype": "IPv4", 
          "port_range_max": "80", 
          "protocol": "tcp", 
          "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5", 
          "security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a",
          
      }
  }

Mensaje de la respuesta

• Parámetro de respuesta

  Tabla 3 Parámetro de respuesta

  Nombre	Tipo	Descripción
  security_group_rule	security_group_rule object	Especifica los objetos de regla del grupo de seguridad. Para obtener más información, véase Tabla 4.

  Tabla 4 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_rule": {
          "direction": "ingress",
          "ethertype": "IPv4",
          "id": "2bc0accf-312e-429a-956e-e4407625eb62",
          "description": "",
          "port_range_max": 80,
          "port_range_min": 80,
          "protocol": "tcp",
          "remote_group_id": "85cc3048-abc3-43cc-89b3-377341426ac5",
          "remote_ip_prefix": null,
          "security_group_id": "a7734e61-b545-452d-a3cd-0189cbd9747a",
          "tenant_id": "e4f50856753b4dc6afee5fa6b9b6c550",
          "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.