Consulta de todos los sistemas de archivos compartidos

Función

Esta API se utiliza para enumerar la información básica de todos los sistemas de archivos compartidos.

URI

• GET /v2/{project_id}/shares?all_tenants={all_tenants}&status={status}&limit={limit}&offset={offset}&sort_key={sort_key}&sort_dir={sort_dir}&project_id={project_id}&is_public={is_public}
• Descripción del parámetro

  Parámetro	Obligatorio	Tipo	Descripción
  project_id	Sí	String	Especifica el ID de proyecto del operador. Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto.
  all_tenants	No (parámetro de consulta)	Boolean	Este parámetro sólo está disponible para usuarios con permisos de administrador. Especifica si se muestran los sistemas de archivos compartidos de todos los inquilinos. Para enumerar los sistemas de archivos compartidos de todos los inquilinos, configúrelo en 1. Para enumerar los sistemas de archivos compartidos solo del inquilino actual, configúrelo en 0.
  project_id	No (parámetro de consulta)	String	Este parámetro sólo está disponible para usuarios con permisos de administrador. Especifica el ID del proyecto al que pertenece el sistema de archivos compartido. Este parámetro necesita ser usado junto con all_tenants.
  status	No (parámetro de consulta)	String	Filtra los sistemas de archivos compartidos por estado. Los valores posibles son: creating: se está creando el sistema de archivos compartidos. error: no se puede crear el sistema de archivos compartido. available: el sistema de archivos compartido está disponible. deleting: se está eliminando el sistema de archivos compartido. error_deleting: El sistema de archivos compartido no se puede eliminar. extending: se está expandiendo el sistema de archivos compartidos. extending_error: no se puede expandir el sistema de archivos compartido. shrinking: el sistema de archivos compartido se está reduciendo. shrinking_error: el sistema de archivos compartido no se puede encoger. shrinking_possible_data_loss_error: El sistema de archivos compartido no puede ser reducido debido a la pérdida de datos. manage_starting: se inicia la gestión del sistema de archivos compartido. manage_error: no se puede administrar el sistema de archivos compartido. unmanage_starting: se inicia la cancelación de la gestión del sistema de archivos compartidos. unmanage_error: Error al cancelar la gestión del sistema de archivos compartido. unmanaged: no se administra el sistema de archivos compartido.
  limit	No (parámetro de consulta)	Integer	Especifica el número máximo de sistemas de archivos compartidos que se pueden devolver. Si no se especifica este parámetro, todos los sistemas de archivos compartidos se devuelven de forma predeterminada.
  offset	No (parámetro de consulta)	Integer	Especifica el desfase para definir el punto inicial del listado del sistema de archivos compartido. El valor debe ser superior o igual a 0.
  sort_key	No (parámetro de consulta)	String	Especifica la palabra clave para ordenar los sistemas de archivos compartidos consultados. Los valores posibles son id, status, size, host, share_proto, availability_zone_id, user_id, project_id, created_at, updated_at, display_name, name, share_type_id, share_network_id, y snapshot_id. De forma predeterminada, el valor se ordena por create_at.
  sort_dir	No (parámetro de consulta)	String	Especifica la dirección para ordenar los sistemas de archivos compartidos. Los valores posibles son asc (ascendente) y desc (descendente).
  is_public	No (parámetro de consulta)	String	Cuando este parámetro se establece en true, el inquilino actual puede consultar todos sus propios sistemas de archivos compartidos y los sistemas de archivos compartidos de otros inquilinos cuyo is_public se establece en true. Cuando este parámetro se establece en false, el inquilino actual solo puede consultar los sistemas de archivos compartidos que pertenecen al inquilino.
  enterprise_project_id	No (parámetro de consulta)	String	Especifica el proyecto de empresa al que están enlazados los sistemas de archivos compartidos. Para consultar el enlace de los sistemas de archivos compartidos del usuario actual a todos los proyectos de empresa, utilice el parámetro all_granted_eps.

Request Header

The operation message header is the same as that of a common request. For details, see Tabla 3.

Solicitud

• Descripción del parámetro

  Ninguno

Respuesta

• Descripción del parámetro

  Parámetro	Tipo	Descripción
  shares	Array of objects	Para obtener más información, consulte la descripción del campo share.

• Descripción del campo share

  Parámetro	Tipo	Descripción
  id	String	Especifica el ID del sistema de archivos compartido.
  links	Array of objects	Especifica la información del vínculo de solicitud del sistema de archivos compartido.
  name	String	Especifica el nombre del sistema de archivos compartido.

• Ejemplo de respuesta

  {
     
      "shares": [
      {
          "id": "1390cb29-539b-4926-8953-d8d6b106071a",
          "links": [
          {
              "href": "https://192.168.196.47:8796/v2/f24555bfcf3146ca936d21bcb548687e/shares/1390cb29-539b-4926-8953-d8d6b106071a",
              "rel": "self"
          },
          {
              "href": "https://192.168.196.47:8796/f24555bfcf3146ca936d21bcb548687e/shares/1390cb29-539b-4926-8953-d8d6b106071a",
              "rel": "bookmark"
          }
          ],
          "name": null
      }
  ]
  }

Códigos de estado

• Normal

  200

• Anormal

  Código de estado	Descripción
  400 Bad Request	Se produjo un error en el servidor al procesar la solicitud.
  401 Unauthorized	Debe introducir un nombre de usuario y la contraseña para acceder a la página solicitada.
  403 Forbidden	El acceso a la página solicitada está prohibido.
  404 Not Found	La página solicitada no se ha podido encontrar.
  405 Method Not Allowed	No se le permite utilizar el método especificado en la solicitud.
  406 Not Acceptable	El cliente no pudo aceptar la respuesta generada por el servidor.
  407 Proxy Authentication Required	Debe utilizar el servidor proxy para la autenticación. Entonces la solicitud puede ser procesada.
  408 Request Timeout	Se agotó el tiempo de espera de la solicitud.
  409 Conflict	La solicitud no se pudo procesar debido a un conflicto.
  500 Internal Server Error	Se produjo un error al completar la solicitud debido a un problema de servicio interno.
  501 Not Implemented	Error al completar la solicitud porque el servidor no admite la función solicitada.
  502 Bad Gateway	Error al completar la solicitud porque la solicitud no es válida.
  503 Service Unavailable	Se produjo un error al completar la solicitud porque el servicio no está disponible.
  504 Gateway Timeout	Se ha producido un error de tiempo de espera de la puerta de enlace.