Actualización de una instantánea de EVS

Función

Esta API se utiliza para actualizar una instantánea de EVS.

URI

• Formato URI

  PUT /v2/{project_id}/snapshots/{snapshot_id}

• Descripción del parámetro

  Parámetro	Obligatorio	Descripción
  project_id	Sí	Especifica el 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.
  snapshot_id	Sí	Especifica el ID de la instantánea.

Solicitud

• Descripción del parámetro

  Parámetro	Tipo	Obligatorio	Descripción
  snapshot	Object	Sí	Especifica la información de la instantánea que se va a actualizar. Para obtener más información, consulte Parámetros en el campo de instantánea.

• Parámetros en el campo de snapshot

  Parámetro	Tipo	Obligatorio	Descripción
  name	String	No	Especifica el nombre de la instantánea. NOTA: Al crear una copia de respaldo para un disco, se creará una instantánea y se nombrará con el prefijo autobk_snapshot_. La consola EVS ha impuesto restricciones de operación en las instantáneas con el prefijo autobk_snapshot_. Por lo tanto, se recomienda no utilizar autobk_snapshot_ como prefijo de nombre para las instantáneas creadas. De lo contrario, las instantáneas no se pueden utilizar normalmente.
  description	String	No	Especifica la descripción de la instantánea.

• Solicitud de ejemplo

  {
      "snapshot": {
          "name": "snap-001", 
          "description": "Daily backup"
      }
  }

Respuesta

• Descripción del parámetro

  Parámetro	Tipo	Descripción
  snapshot	Object	Especifica la información de la instantánea. Para obtener más información, consulte Parámetros en el campo de instantánea.
  error	Object	Especifica el mensaje de error devuelto cuando se produce un error. Para obtener más información, consulte Parámetros en el campo de error.

• Parámetros en el campo de snapshot

  Parámetro	Tipo	Descripción
  id	String	Especifica el ID de la instantánea.
  status	String	Especifica el estado de la instantánea. Para más detalles, consulte Estado de instantánea de EVS.
  name	String	Especifica el nombre de la instantánea.
  description	String	Especifica la descripción de la instantánea.
  created_at	String	Especifica la hora a la que se creó la instantánea.
  metadata	Object	Especifica los metadatos de la instantánea.
  volume_id	String	Especifica el ID del disco de origen de la instantánea.
  size	Integer	Especifica el tamaño de la instantánea, en GB.
  updated_at	String	Especifica la hora a la que se actualizó la instantánea.
  os-extended-snapshot-attributes:progress	String	Campo Reservado
  os-extended-snapshot-attributes:project_id	String	Campo Reservado

• Parámetros en el campo de error

  Parámetro	Tipo	Descripción
  message	String	Especifica el mensaje de error devuelto cuando se produce un error.
  code	String	Especifica el código de error devuelto cuando se produce un error. Para obtener más información sobre el código de error, consulte Códigos de error.

• Ejemplo de respuesta

  {
      "snapshot": {
          "status": "available", 
          "description": "Daily backup", 
          "created_at": "2013-02-25T03:56:53.081642", 
          "metadata": { }, 
          "volume_id": "5aa119a8-d25b-45a7-8d1b-88e127885635", 
          "size": 1, 
          "id": "f9faf7df-fdc1-4093-9ef3-5cba06eef995", 
          "name": "snap-001", 
          "updated_at": "2013-02-25T03:56:53.081642"
      }
  }

  o

  {
      "error": {
          "message": "XXXX", 
          "code": "XXX"
      }
  }

  En el ejemplo anterior, error indica un error general, por ejemplo, badRequest o itemNotFound. Un ejemplo es el siguiente:

  {
      "itemNotFound": {
          "message": "XXXX", 
          "code": "XXX"
      }
  }

Códigos de estado

• Normal

  200

Códigos de error

Para más detalles, consulte Códigos de error.