Consulta de discos EVS

Función

Esta API se utiliza para consultar discos EVS.

URI

• Formato URI

  GET /v2/{project_id}/volumes

• 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
  name	String	No	Especifica el nombre del disco.
  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 discos 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/volumes?limit=50: Consulta los discos 1-50. GET /v2/xxx/volumes?offset=50&limit=50: Consulta los discos 51-100.
  sort_key	String	No	Especifica la palabra clave en función de la cual se ordenan los resultados devueltos. El valor puede ser id, status, size, o created_at, y el valor predeterminado es created_at.
  sort_dir	String	No	Especifica el orden de clasificación del resultado. El valor predeterminado es desc. desc: indica el orden descendente. asc: indica el orden ascendente.
  offset	Integer	No	Especifica el desfase. Todos los discos después de este desplazamiento serán consultados. El valor debe ser un entero mayor que 0 pero menor que el número de discos.
  status	String	No	Especifica el estado del disco. Para más detalles, consulte Estado de disco EVS.
  metadata	String	No	Especifica los metadatos del disco.
  availability_zone	String	No	Especifica la AZ.

Solicitud

En el ejemplo siguiente se muestra cómo consultar los discos en el estado available.

• Solicitud de ejemplo

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

Respuesta

• Descripción del parámetro

  Parámetro	Tipo	Descripción
  volumes	list	Especifica la lista de discos consultados. Para obtener más información, consulte Parámetros en el campo volumes.
  volumes_links	list	Especifica el marcador de posición de la consulta en la lista de discos. Si solo se devuelven algunos discos en esta consulta, se devolverá la URL del último disco consultado. Puede utilizar esta dirección URL para continuar consultando los discos restantes en la siguiente 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 volumes

  Parámetro	Tipo	Descripción
  id	String	Especifica el ID de disco.
  links	list<map<String, String>>	Especifica el URI del disco. Para obtener más información, consulte Parámetros en el campo de Enlaces.
  name	String	Especifica el nombre del disco.

• Parámetros en el campo links

  Parámetro	Tipo	Descripción
  href	String	Especifica el enlace de acceso directo correspondiente.
  rel	String	Especifica el nombre del marcador de enlace de acceso directo.

• 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

  {
      "volumes": [
          {
              "id": "6b604cef-9bd8-4f5a-ae56-45839e6e1f0a", 
              "links": [
                  {
                      "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a", 
                      "rel": "self"
                  }, 
                  {
                      "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a", 
                      "rel": "bookmark"
                  }
              ], 
              "name": "zjb_u25_test"
          }, 
          {
              "id": "2bce4552-9a7d-48fa-8484-abbbf64b206e", 
              "links": [
                  {
                      "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e", 
                      "rel": "self"
                  }, 
                  {
                      "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e", 
                      "rel": "bookmark"
                  }
              ], 
              "name": "zjb_u25_test"
          }, 
          {
              "id": "3f1b98ec-a8b5-4e92-a727-88def62d5ad3", 
              "links": [
                  {
                      "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3", 
                      "rel": "self"
                  }, 
                  {
                      "href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3", 
                      "rel": "bookmark"
                  }
              ], 
              "name": "zjb_u25_test"
          }
      ], 
      "volumes_links": [
          {
              "href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes?limit=3&marker=3f1b98ec-a8b5-4e92-a727-88def62d5ad3", 
              "rel": "next"
          }
      ]
  }

  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:

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

Códigos de estado

• Normal

  200

Códigos de error

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