Consulta de instantáneas de EVS

Función

Esta API se utiliza para consultar las instantáneas de EVS.

URI

• Formato URI

  GET /v2/{project_id}/snapshots

• 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.

• Parámetros de filtro de solicitud

  Parámetro	Tipo	Obligatorio	Descripción
  marker	String	No
  offset	Integer	No	Especifica el desfase. NOTA: Este parámetro se utiliza cuando las instantáneas se consultan por página y se utiliza junto con el parámetro limit. Por ejemplo, hay un total de 30 instantáneas. Si establece el offset en 11 y el limit en 10, la instantánea consultada comienza a partir de la duodécima instantánea y, como máximo, se pueden consultar 10 instantáneas a la vez.
  limit	Integer	No	Especifica el número máximo de resultados de consulta que se pueden devolver. Si el inquilino tiene más de 50 instantáneas en total, se recomienda utilizar este parámetro y establecer su valor en 50 para mejorar la eficiencia de la consulta. Los ejemplos se proporcionan como sigue: GET /v2/xxx/snapshots?limit=50: Consulta las instantáneas 1–50. GET /v2/xxx/snapshots?offset=50&limit=50: Consulta las 51–100 instantáneas.
  name	String	No	Especifica el nombre de la instantánea. Este parámetro no admite búsqueda difusa.
  status	String	No	Especifica el estado de la instantánea. Para más detalles, consulte Estado de instantánea de EVS.
  volume_id	String	No	Especifica el ID del disco de origen de la instantánea.

Solicitud

En el ejemplo siguiente se muestra cómo consultar las instantáneas en el estado available.

• Solicitud de ejemplo

  GET https://{endpoint}/v2/{project_id}/snapshots?status=available

Respuesta

• Descripción del parámetro

  Parámetro	Tipo	Descripción
  snapshots	Object	Especifica la información de la instantánea. Para obtener más información, consulte Parámetros en el campo de instantáneas.
  snapshots_links	list<map<String,String>>	Especifica el marcador de posición de la consulta en la lista de instantáneas. Este parámetro está en el mismo nivel que parámetro snapshots en el cuerpo de la respuesta. Este parámetro se devuelve solo cuando se especifica parámetro limit en la solicitud, y este parámetro indica que solo se devuelven algunas instantáneas en esta consulta.
  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 snapshots

  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. Si metadata contienen el campo __system__enableActive, la instantánea se crea automáticamente durante la copia de respaldo de un servidor.
  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.

• 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

  {
      "snapshots": [
          {
              "created_at": "2016-02-16T16:54:14.981520", 
              "description": null, 
              "id": "b836dc3d-4e10-4ea4-a34c-8f6b0460a583", 
              "metadata": { }, 
              "name": "test01", 
              "size": 1, 
              "status": "available", 
              "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209", 
              "updated_at": null
          }, 
          {
              "created_at": "2016-02-16T16:54:19.475397", 
              "description": null, 
              "id": "83be494d-329e-4a78-8ac5-9af900f48b95", 
              "metadata": { }, 
              "name": "test02", 
              "size": 1, 
              "status": "available", 
              "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209", 
              "updated_at": null
          }, 
          {
              "created_at": "2016-02-16T16:54:24.367414", 
              "description": null, 
              "id": "dd360f46-7593-4d35-8f2c-5566fd0bd79e", 
              "metadata": { }, 
              "name": "test03", 
              "size": 1, 
              "status": "available", 
              "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209", 
              "updated_at": null
          }, 
          {
              "created_at": "2016-02-16T16:54:29.766740", 
              "description": null, 
              "id": "4c29796a-8cf4-4482-9afc-e66da9a81240", 
              "metadata": { }, 
              "name": "test04", 
              "size": 1, 
              "status": "available", 
              "volume_id": "ba5730ea-8621-4ae8-b702-ff0ffc12c209", 
              "updated_at": null
          }
      ], 
      "snapshots_links": null
  }

  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.