Asignación de un EIP (anual/mensual)

Función

Esta API se utiliza para asignar un EIP anual/mensual.

URI

POST /v2.0/{project_id}/publicips

Parámetro 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
  publicip	Sí	publicip object	Especifica el objeto EIP. Para más detalles, consulte Tabla 4.
  bandwidth	Sí	bandwidth object	Especifica los objetos de ancho de banda. Para más detalles, consulte Tabla 5.
  extendParam	No	extendParam object	Especifica el parámetro extendido, que se utiliza para aplicar a los recursos en el modo de facturación anual/mensual. Para obtener más información, consulte la sección Tabla 6.
  enterprise_project_id	No	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 (-). Cuando asigne un EIP, asocie un ID de proyecto de empresa con el EIP. Si no se especifica este parámetro, el valor predeterminado es 0, que indica que se utiliza el proyecto de empresa predeterminado.

  Tabla 4 Descripción del campo publicip

  Nombre	Obligatorio	Tipo	Descripción
  type	Sí	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.
  ip_version	No	Integer	Especifica la versión de EIP. El valor puede ser 4 y 6, indicando la dirección IPv4 y la dirección IPv6, respectivamente. Restricciones: El valor configurado debe ser compatible con el sistema. Si este parámetro se deja en blanco o es una string vacía, la dirección IPv4 se crea de forma predeterminada.
  alias	No	String	Especifica el nombre de EIP. El valor puede contener de 1 a 64 caracteres, incluyendo letras, dígitos, guiones bajos (_), guiones (-) y puntos (.).
  port_id	No	String	Especifica el ID de puerto. El valor debe ser un ID de un puerto existente. Si el puerto no existe o se ha vinculado a un EIP, se muestra un mensaje de error.

  Tabla 5 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 (.). Restricciones: Este parámetro es obligatorio cuando share_type se establece en PER. Este parámetro se ignorará si el ancho de banda tiene un ID especificado.
  size	No	Integer	Especifica el tamaño del ancho de banda. El valor varía de 1 Mbit/s a 2000 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.) Este parámetro es obligatorio cuando share_type se establece en PER. Este parámetro se ignorará si el ancho de banda tiene un ID especificado. 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.
  id	No	String	Utilice el ancho de banda compartido existente para asignar una dirección IP. Especifica el ID del ancho de banda compartido. Restricciones: El valor debe ser el ID del ancho de banda cuyo share_type es WHOLE. No es necesario especificar este parámetro en el modo de pago anticipado. Este parámetro se ignorará si su valor se deja en blanco.
  share_type	Sí	String	Especifica el tipo de ancho de banda. Los valores posibles son los siguientes: PER: Ancho de banda dedicado WHOLE: Ancho de banda compartido Cuando se utiliza el ancho de banda existente para asignar una dirección IP, el valor de este parámetro depende del tipo de ancho de banda. El valor del parámetro solo puede ser PER en modo de pago anticipado.
  charge_mode	No	String	Especifica si el ancho de banda se factura por el tráfico o por el tamaño del ancho de banda. El valor puede ser bandwidth o traffic. El valor predeterminado es bandwidth. Si el valor es traffic, el ancho de banda se factura por el tráfico.

  Tabla 6 Descripción del campo extendParam

  Nombre	Obligatorio	Tipo	Descripción
  charge_mode	No	String	Especifica el modo de facturación. Los valores posibles son los siguientes: prePaid: pago por adelantado. El modo de facturación es anual/mensual. postPaid: pospago. El modo de facturación es pago por uso. El valor predeterminado es postPaid. En el modo de pospago, los parámetros de extendParam se ignorarán.
  period_type	No	String	Especifica la unidad de suscripción. Los valores posibles son los siguientes: month: indica que los recursos están suscritos por mes. year: indica que los recursos están suscritos por año. Restricciones: Si asigna un EIP que utiliza un ancho de banda compartido anual/mensual existente, (es decir, especifica el ID de ancho de banda compartido para asignar un EIP) Este parámetro es opcional. Este parámetro es obligatorio cuando el modo de facturación es prepago y el EIP no utiliza un ancho de banda compartido. Cuando se crea un EIP usando el ancho de banda compartido, el tiempo de caducidad del ancho de banda es el mismo que el del EIP.
  period_num	No	Integer	Especifica el período de suscripción. El rango de valores varía dependiendo de la estrategia de operación. Cuando period_type se establece en month, el valor del parámetro varía de 1 a 9. Cuando period_type se establece en year, el valor del parámetro debe establecerse en 1. Las restricciones para period_num son las mismas que para period_type.
  is_auto_renew	No	boolean	Especifica si se renovará la suscripción. Los valores posibles son los siguientes: El valor false indica que la renovación automática de la suscripción está activada. El valor true indica que la renovación automática de la suscripción está deshabilitada. El valor predeterminado es false. Restricciones: Una vez caducada la suscripción, el sistema renueva automáticamente la suscripción durante un mes por defecto (el período de renovación automática puede cambiar). Para obtener más información, póngase en contacto con el personal de servicio al cliente.
  is_auto_pay	No	boolean	Especifica si la comisión se deduce automáticamente del saldo de la cuenta del cliente después de enviar un pedido. El modo de pago no automático se utiliza por defecto. Los valores posibles son los siguientes: true: indica el pago automático. El sistema deducirá automáticamente las tarifas del saldo de la cuenta después de enviar un pedido. false: indica el pago no automático. Este es el valor predeterminado. Los clientes deben pagar manualmente. Restricciones: Si utiliza el modo de pago automático, solo podrá utilizar el saldo de su cuenta. Si desea utilizar un vale, no utilice el modo de pago automático y seleccione el vale para el pago en el Centro de facturación.

• Ejemplo de solicitud 1

  Asigne un EIP que utilice un nuevo ancho de banda dedicado anual/mensual. El tamaño del ancho de banda es de 1 Mbit/s y la duración requerida es de 1 mes. El sistema no renueva automáticamente la suscripción y deduce la tarifa después de enviar un pedido.

  POST https://{Endpoint}/v2.0/{project_id}/publicips
  
  {
      "publicip": {
          "type": "5_bgp",
      },
      "bandwidth": {
          "name": "bw_666",
          "size": 1,
          "share_type": "PER",
          "charge_mode": "bandwidth"
      },
      "extendParam": {
          "charge_mode": "prePaid",
          "period_type": "month",
          "period_num": 1,
          "is_auto_renew": "false",
          "is_auto_pay": "false"
      }
  }

• Ejemplo de solicitud 2

  Asigne un EIP que utilice un ancho de banda de pago por uso. Deje el parámetro extendParam en blanco.

  POST https://{Endpoint}/v2.0/{project_id}/publicips
  
  {
      "publicip": {
          "type": "5_bgp",
      },
      "bandwidth": {
          "name": "bw_666",
          "size": 1,
          "share_type": "PER",
          "charge_mode": "bandwidth"
      }
  }

Mensaje de la respuesta

• Parámetro de respuesta

  Nombre	Tipo	Descripción
  publicip	publicip object	Especifica el objeto EIP. (Este parámetro se devuelve en el escenario de pago por uso.)
  order_id	String	Especifica el ID de pedido. (Este parámetro se devuelve en el escenario anual/mensual.)
  publicip_id	String	Especifica el ID de EIP. Este parámetro entra en vigor 1 minuto más tarde en el escenario anual/mensual.

  Tabla 7 Descripción del campo publicip

  Nombre	Tipo	Descripción
  id	String	Especifica el identificador único de un EIP.
  status	String	Especifica el estado de EIP. Los valores posibles son los siguientes: FREEZED (Congelado) BIND_ERROR (Error de enlace) BINDING (Encuadernación) PENDING_DELETE (Liberación) PENDING_CREATE (Asignación) PENDING_UPDATE (Actualización) NOTIFYING (Asignación) NOTIFY_DELETE (Liberación) DOWN (sin consolidar) ACTIVE (Enlazado) ELB (Unido a un balanceador de carga) ERROR (Excepciones)
  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.
  public_ip_address	String	Especifica el EIP obtenido si sólo están disponibles los EIP IPv4.Specifies the IPv4 address corresponding to the IPv6 address if IPv6 EIPs are available.
  public_ipv6_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. El valor puede ser 4 o 6. 4: dirección IPv4 6: Dirección IPv6
  tenant_id	String	Especifica el ID del proyecto.
  create_time	String	Especifica la hora (UTC) cuando se asigna el EIP.
  bandwidth_size	Integer	Especifica el tamaño del ancho de banda.
  alias	String	Especifica el nombre de EIP.
  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 (-). Al asignar un EIP, debe asociar un ID de proyecto de empresa con el EIP. Si no se especifica este parámetro, el valor predeterminado es 0, que indica que se utiliza el proyecto de empresa predeterminado.

• Ejemplo de respuesta 1
  Anual/Mensual

  {
      "order_id": "CS1802081410IMDRN",
      "publicip_id": "4eaf3b63-48ca-4410-ab85-bdfddf4b35fd"
  }

• Ejemplo de respuesta 2
  Pago por uso

  {
    "publicip": {
      "id": "4eaf3b63-48ca-4410-ab85-bdfddf4b35fd",
      "status": "PENDING_CREATE",
      "type": "5_bgp",
      "public_ip_address": "10.xx.xx.238",
      "tenant_id": "26ae5181a416420998eb2093aaed84d9",
      "create_time": "2019-03-27 13:11:58",
      "bandwidth_size": 0,
      "enterprise_project_id": "0",
      "ip_version": 4
    }
  }

Código de estado.

Consulte Códigos de estado