Consulta de detalles acerca de todos los sistemas de archivos compartidos
Función
Esta API se utiliza para consultar los detalles sobre todos los sistemas de archivos compartidos.
URI
- GET /v2/{project_id}/shares/detail?all_tenants={all_tenants}&project_id={project_id}&status={status}&limit={limit}&offset={offset}&sort_key={sort_key}&sort_dir={sort_dir}&is_public={is_public}&name={name}
- 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 (query parameter)
Integer
(Sólo administradores) Especifica si se deben enumerar 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 (query parameter)
String
Especifica el ID del inquilino que crea el sistema de archivos compartido. Este parámetro se utiliza junto con all_tenants.
status
No (query parameter)
String
Filtra los sistemas de archivos compartidos por estado. Los valores posibles son creating, error, available, deleting, error_deleting, manage_starting, manage_error, unmanage_starting, unmanage_error, unmanaged, extending, extending_error, shrinking, shrinking_error, y shrinking_possible_data_loss_error.
limit
No (query parameter)
Integer
Especifica el número máximo de sistemas de archivos compartidos que se pueden devolver.
offset
No (query parameter)
Integer
Especifica el desfase para definir el punto inicial del listado del sistema de archivos compartido.
sort_key
No (query parameter)
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.
sort_dir
No (query parameter)
String
Especifica la dirección para ordenar los sistemas de archivos compartidos. Los valores posibles son asc (ascendente) y desc (descendente).
is_public
No (query parameter)
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 (query parameter)
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.
name
No (query parameter)
String
Especifica el campo utilizado para el filtrado difuso basado en el nombre de un sistema de archivos compartido. Este campo es compatible con API v2.36 y versiones posteriores.
Request Header
The operation message header is the same as that of a common request. For details, see Tabla 3.
Respuesta
- Descripción del parámetro
Parámetro
Tipo
Descripción
shares
Array of objects
Especifica la lista de los objetos share.
- Descripción del campo share
Parámetro
Tipo
Descripción
links
Array
Especifica los vínculos de los sistemas de archivos compartidos.
availability_zone
String
Especifica la zona de disponibilidad.
share_server_id
String
Especifica el ID para administrar los servicios compartidos.
share_network_id
String
Especifica el ID de la red compartida. Este parámetro está reservado porque actualmente no se admite la gestión de redes compartidas.
snapshot_id
String
Especifica el ID de la instantánea de origen que se utiliza para crear el sistema de archivos compartido. Este parámetro está reservado, ya que las instantáneas no son compatibles actualmente.
snapshot_support
Boolean
Especifica si se admiten instantáneas. Este parámetro está reservado, ya que las instantáneas no son compatibles actualmente. Este campo es compatible con API v2.2 y versiones posteriores.
id
String
Especifica el ID del sistema de archivos compartido.
size
Integer
Especifica el tamaño (GB) del sistema de archivos compartido.
consistency_group_id
String
Especifica el ID del grupo de consistencia. Este parámetro está reservado porque actualmente no se admiten grupos de consistencia. Este campo es compatible con las versiones de API de v2.31 a v2.42.
project_id
String
Especifica el ID del proyecto al que pertenece el sistema de archivos compartido.
metadata
Object
Establece uno o más pares de clave y valor de metadatos como un diccionario de cadenas. El valor de la clave share_use indica la capacidad utilizada del sistema de archivos, en bytes. La capacidad utilizada no se mostrará si se utiliza menos de 1 MB del sistema de archivos SFS orientado a la capacidad. El valor de clave de enterprise_project_id indica el ID del proyecto de empresa al que pertenece el sistema de archivos.
status
String
Especifica el estado del sistema de archivos compartido.
task_state
String
Especifica el estado de migración de datos. Este parámetro está reservado, ya que actualmente no se admite la migración de datos. Este campo es compatible con API v2.5 y versiones posteriores.
has_replicas
Boolean
Especifica si existen réplicas. Este parámetro está reservado, ya que actualmente no se admite la replicación. Este campo es compatible con las versiones de API de v2.11 a v2.42.
replication_type
String
Especifica el tipo de replicación. Este parámetro está reservado, ya que actualmente no se admite la replicación. Este campo es compatible con las versiones de API de v2.11 a v2.42.
description
String
Describe el sistema de archivos compartido.
host
String
Especifica el nombre del host.
name
String
Especifica el nombre del sistema de archivos compartido.
created_at
String
Especifica la marca de fecha y hora cuando se creó el sistema de archivos compartido.
share_proto
String
Especifica el protocolo para compartir sistemas de archivos.
share_type_name
String
Especifica el tipo de servicio de almacenamiento asignado para el sistema de archivos compartido, como el almacenamiento de alto rendimiento (compuesto por SSD) y el almacenamiento de gran capacidad (compuesto por discos SATA). Este campo es compatible con API v2.6 y versiones posteriores.
share_type
String
Especifica el ID del tipo de sistema de archivos.
volume_type
String
Especifica el tipo de volumen. La definición de este parámetro es la misma que la de share_type.
export_locations
Array
Muestra las ubicaciones de montaje. Actualmente, solo se admite una única ubicación de montaje. Este parámetro solo existe cuando X-Openstack-Manila-Api-Version especificado en el encabezado de solicitud es menor que 2.9.
export_location
String
Especifica la ubicación de montaje. Este parámetro solo existe cuando X-Openstack-Manila-Api-Version especificado en el encabezado de solicitud es menor que 2.9.
is_public
Boolean
Especifica el nivel de visibilidad del sistema de archivos compartido. Si se devuelve true, el sistema de archivos se puede ver públicamente. Si se devuelve false, el sistema de archivos se puede ver de forma privada. El valor predeterminado es false.
- Ejemplo de respuesta
{ "shares": [ { "links": [ { "href": "https://192.168.170.97:8796/v2/61b01a94b84448cfac2424e46553d7e7/shares/54d0bac6-45c8-471c-bf0d-16ffd81ef88a", "rel": "self" }, { "href": "https://192.168.170.97:8796/61b01a94b84448cfac2424e46553d7e7/shares/54d0bac6-45c8-471c-bf0d-16ffd81ef88a", "rel": "bookmark" } ], "export_location": "sfs.dong.com:/share-e1c2d35e", "availability_zone": "az1.dc1", "share_network_id": null, "snapshot_id": null, "id": "54d0bac6-45c8-471c-bf0d-16ffd81ef88a", "size": 1, "share_type": "default", "": null, "project_id": "da0f615c35eb4d72812d1547a77b5394", "metadata": { "share_used": "1048576000000", }, "status": "available", "description": "test description", "export_locations": ["sfs.dong.com:/share-e1c2d35e"], "host": "DJ01@9656beb1-7ce2-4c46-9911-ecd51ab632bf#9656beb1-7ce2-4c46-9911-ecd51ab632bf", "is_public": false, "name": "cl01", "created_at": "2017-07-07T03:15:06.858662", "share_proto": "NFS", "volume_type": "default" } ] }
Códigos de estado
- Normal
- 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.