Actualización de un ancho de banda

Función

Esta API se utiliza para actualizar información sobre un ancho de banda.

URI

PUT /v1/{project_id}/bandwidths/{bandwidth_id}

Mensaje de solicitud

• Parámetro de solicitud

  Tabla 2 Parámetro de cabecera de solicitud

  Parámetro	Obligatorio	Tipo	Descripción
  X-Auth-Token	Sí	String	Especifica el token de usuario. El token se puede obtener llamando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es el token de usuario.

  Tabla 3 Parámetro de solicitud

  Nombre	Obligatorio	Tipo	Descripción
  bandwidth	Sí	bandwidth object	Especifica los objetos de ancho de banda. Para más detalles, consulte Tabla 4.

  Tabla 4 Descripción del campo bandwidth

  Nombre	Obligatorio	Tipo	Descripción
  name	No	String	Especifica el nombre del ancho de banda. El valor puede contener de 1 a 64 caracteres, incluyendo letras, dígitos, guiones bajos (_), guiones (-) y puntos (.). Si el valor se deja en blanco, el nombre del ancho de banda no se cambia. Debe especificarse name o size del parámetro.
  size	No	Integer	Especifica el tamaño de ancho de banda en Mbit/s. El valor varía de 1 Mbit/s a 300 Mbit/s de forma predeterminada. (El rango específico puede variar dependiendo de la configuración en cada región. Puede ver el rango de ancho de banda disponible en la consola de gestión.) Si el parámetro no está incluido, el tamaño del ancho de banda no cambia. Debe especificarse name o size del parámetro. Si se especifica una fracción decimal (por ejemplo 10.2) o una string de caracteres (por ejemplo "10"), el valor especificado se convertirá automáticamente en un entero. El incremento mínimo para el ajuste de ancho de banda varía dependiendo del rango de ancho de banda. Dichos aspectos se detallan a continuación: El incremento mínimo es de 1 Mbit/s si el ancho de banda permitido oscila entre 0 Mbit/s y 300 Mbit/s (con 300 Mbit/s incluidos). El incremento mínimo es de 50 Mbit/s si el ancho de banda permitido oscila entre 300 Mbit/s y 1000 Mbit/s (con 1000 Mbit/s incluidos). El incremento mínimo es de 500 Mbit/s si el ancho de banda permitido es mayor que 1000 Mbit/s.
  charge_mode	No	String	Especifica si la facturación se basa en el tráfico, el ancho de banda o el ancho de banda percentil 95 (mejorado). Los valores posibles pueden ser bandwidth (facturado por ancho de banda), traffic (facturado por tráfico) o 95peak_plus (facturado por ancho de banda percentil 95 mejorado). Si el valor es una string de caracteres vacía o no se especifica ningún valor, se utiliza el valor bandwidth. Solo el ancho de banda compartido admite 95peak_plus (facturado por el ancho de banda mejorado del percentil 95). Si opta por ser facturado por el ancho de banda percentil 95 (mejorado), debe especificar el porcentaje de ancho de banda garantizado. El valor predeterminado es 20%.

• Ejemplo de la solicitud

  PUT https://{Endpoint}/v1/{project_id}/bandwidths/{bandwidth_id} 
  
  {
      "bandwidth":
          {"name": "bandwidth123",
           "size": 10
          }
  }

Mensaje de la respuesta

• Parámetro de respuesta

  Tabla 5 Parámetro de respuesta

  Nombre	Tipo	Descripción
  bandwidth	bandwidth object	Especifica los objetos de ancho de banda. Para más detalles, consulte Tabla 6.

  Tabla 6 Descripción del campo bandwidth

  Nombre	Tipo	Descripción
  name	String	Especifica el nombre del ancho de banda. El valor puede contener de 1 a 64 caracteres, incluyendo letras, dígitos, guiones bajos (_), guiones (-) y puntos (.).
  size	Integer	Especifica el tamaño de ancho de banda en Mbit/s. El valor varía de 1 Mbit/s a 300 Mbit/s de forma predeterminada. (El rango específico puede variar dependiendo de la configuración en cada región. Puede ver el rango de ancho de banda de cada región en la consola de gestión.)
  id	String	Especifica el identificador de ancho de banda, que identifica de forma exclusiva el ancho de banda.
  share_type	String	Especifica si el ancho de banda es compartido o dedicado. Los valores posibles son los siguientes: PER: Ancho de banda dedicado WHOLE: Ancho de banda compartido
  publicip_info	Array of publicip_info objects	Especifica la información sobre el EIP que utiliza el ancho de banda. Para más detalles, consulte Tabla 7. El ancho de banda, cuyo tipo es WHOLE, puede ser utilizado por múltiples EIPs (hasta 20 EIPs por defecto). El ancho de banda, cuyo tipo es PER, puede ser utilizado por un solo EIP.
  tenant_id	String	Especifica el ID del proyecto.
  bandwidth_type	String	Especifica el tipo de ancho de banda. El valor puede ser bgp, sbgp o share. share: Ancho de banda compartido. bgp: BGP dinámico sbgp: BGP estático
  charge_mode	String	Especifica si el ancho de banda se factura por el tráfico o por el tamaño del ancho de banda. Los valores posibles pueden ser bandwidth (facturado por ancho de banda) y traffic (facturado por tráfico). Si el valor es una string de caracteres vacía o no se especifica ningún valor, se utiliza el valor bandwidth.
  billing_info	String	Especifica la información de la lista. Si se especifica billing_info, el ancho de banda está en modo de facturación anual/mensual.
  enterprise_project_id	String	Especifica el ID del 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 el ancho de banda enlazado a todos los proyectos de empresa del usuario, establezca all_granted_eps. Al crear un ancho de banda, asocie el ID del proyecto de empresa con el ancho de banda.
  status	String	Especifica el estado del ancho de banda. Los valores posibles son los siguientes: FREEZED (Congelado) NORMAL (Normal)
  created_at	String	Especifica la hora (UTC) en la que se crea el ancho de banda. Formato: yyyy-MM-ddTHH:mm:ss
  updated_at	String	Especifica la hora (UTC) cuando se actualiza el ancho de banda. Formato: yyyy-MM-ddTHH:mm:ss
  enable_bandwidth_rules	boolean	Especifica si se activa QoS. El valor puede ser true o false.
  rule_quota	integer	Especifica el número máximo de reglas de agrupación admitidas por el ancho de banda.
  bandwidth_rules	Array of bandwidth_rules objects	Especifica las reglas de ancho de banda.
  public_border_group	String	Especifica si se encuentra en una ubicación central o en una ubicación de borde. Valores: Centro Nombre del sitio perimetral Este recurso solo puede asociarse con un EIP de la misma región.

  Tabla 7 Objetos publicip_info

  Nombre	Tipo	Descripción
  publicip_id	String	Especifica el ID de EIP que utiliza el ancho de banda.
  publicip_address	String	Especifica el EIP obtenido si sólo están disponibles los EIP IPv4.
  publicipv6_address	String	Especifica el EIP obtenido si los EIP IPv6 están disponibles. Este parámetro no existe si solo están disponibles EIP IPv4.
  ip_version	Integer	Especifica la versión de la dirección IP. Los valores posibles son los siguientes: 4: IPv4 6: IPv6
  publicip_type	String	Especifica el tipo de EIP. El valor puede ser 5_bgp (BGP dinámico) o 5_sbgp (BGP estático). CN South-Guangzhou: 5_bgp y 5_sbgp CN East-Shanghai1: 5_bgp y 5_sbgp CN East-Shanghai2: 5_bgp y 5_sbgp CN North-Beijing1: 5_bgp y 5_sbgp CN-Hong Kong: 5_bgp AP-Bangkok: 5_bgp AP-Singapore: 5_bgp AF-Johannesburg: 5_bgp CN Southwest-Guiyang1: 5_sbgp CN North-Beijing4: 5_bgp y 5_sbgp LA-Santiago: 5_bgp LA-Sao Paulo1: 5_bgp LA-Mexico City1: 5_bgp LA-Buenos Aires1: 5_bgp LA-Lima1: 5_bgp LA-Santiago2: 5_bgp Restricciones: El valor configurado debe ser compatible con el sistema. publicip_id es un puerto IPv4. Si no se especifica publicip_type, el valor predeterminado es 5_bgp.

  Tabla 8 Objeto bandwidth_rules

  Nombre	Tipo	Descripción
  id	string	Especifica el ID de regla de ancho de banda.
  name	string	Especifica el nombre de la regla de ancho de banda.
  admin_state_up	boolean	Especifica el estado de configuración. El valor False indica que la configuración no tiene efecto.
  egress_size	integer	Especifica el ancho de banda de salida máximo en Mbit/s. El intervalo de valores varía de 0 a n, donde n indica el tamaño de ancho de banda compartido. Si el valor se establece en 0, se utilizará el ancho de banda máximo, es decir, el tamaño de ancho de banda compartido.
  egress_guarented_size	integer	Especifica el ancho de banda de salida garantizado en Mbit/s. El valor varía de 0 a x, donde x indica el ancho de banda restante.
  publicip_info	Array of publicip_info objects	Especifica el EIP asociado al ancho de banda. El ancho de banda, cuyo tipo se establece en WHOLE, puede ser utilizado por múltiples EIP. El ancho de banda, cuyo tipo se establece en PER, sólo puede ser utilizado por un EIP.

• Ejemplo de la respuesta

  {
      "bandwidth": {
          "id": "3fa5b383-5a73-4dcb-a314-c6128546d855",
          "name": "bandwidth123",
          "size": 10,
          "share_type": "PER",
          "publicip_info": [
              {
                  "publicip_id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
                  "publicip_address": "161.xx.xx.9",
                  "publicip_type": "5_bgp",
                  "ip_version": 4            
              }
          ],
          "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
          "bandwidth_type": "bgp",
          "charge_mode": "bandwidth",
          "status": "NORMAL",
          "enable_bandwidth_rules": false,
          "rule_quota": 0,
          "bandwidth_rules": [],
      }
  }

Código de estado

Consulte Códigos de estado