Modificación de un sistema de archivos compartido
Función
Esta API se utiliza para modificar el nombre y la descripción de un sistema de archivos compartido.
URI
- PUT /v2/{project_id}/shares/{share_id}
- Descripción del parámetro
Parámetro
Obligatorio
Tipo
Descripción
share_id
Sí
String
Especifica el ID del sistema de archivos compartido.
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.
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
Parámetro
Obligatorio
Tipo
Descripción
share
Sí
Object
Especifica los objetos de share.
- Descripción del campo share
Parámetro
Obligatorio
Tipo
Descripción
display_name
No
String
Especifica el nuevo nombre del sistema de archivos compartido. El valor consta de 0 a 255 caracteres.
display_description
No
String
Describe el sistema de archivos compartido. El valor contiene de 0 a 255 caracteres.
is_public
No
Boolean
(Soportado por API v2.8 y versiones posteriores.) Especifica si un sistema de archivos se puede ver públicamente. Si se establece en true, el sistema de archivos se puede ver públicamente. Si se establece en false, el sistema de archivos se puede ver de forma privada. El valor predeterminado es false.
- Solicitud de ejemplo
{ "share": { "display_name": "testshare", "display_description": "test" } }
Respuesta
- Descripción del parámetro
Parámetro
Tipo
Descripción
share
Object
Especifica los objetos de 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.
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
(Soportado por las versiones de API de v2.31 a v2.42) Especifica el ID de un grupo de consistencia. Este parámetro está reservado porque actualmente no se admiten grupos de consistencia.
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_used indica la capacidad utilizada del sistema de archivos, en bytes. El valor de la clave 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.
has_replicas
Boolean
(Soportado por las versiones de API de v2.11 a v2.42) Especifica si existe alguna replicación. Este parámetro está reservado, ya que actualmente no se admite la replicación.
replication_type
String
(Soportado por las versiones de API de v2.11 a v2.42) Especifica el tipo de replicación. Este parámetro está reservado, ya que actualmente no se admite la replicación.
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.
access_rules_status
String
(Soportado por las versiones de API de v2.10 a v2.27.) Especifica el estado de configuración de la regla de acceso. Los valores posibles son active (efectivos), error (fallo en la configuración) y syncing (configuración en curso).
share_proto
String
Especifica el protocolo para compartir sistemas 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.
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).
share_type
String
Especifica el ID del tipo de sistema de archivos.
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.8.
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.8.
is_public
Boolean
(Soportado por las versiones de API de v2.8 a v2.42). Especifica si un sistema de archivos se puede ver públicamente. Si se establece en true, el sistema de archivos se puede ver públicamente. Si se establece en false, el sistema de archivos se puede ver de forma privada. El valor predeterminado es false.
source_share_group_snapshot_member_id
String
(Soportado por API v2.31 y versiones posteriores.) Especifica el ID de un origen de instantáneas de consistencia. Actualmente, no se admite el grupo de consistencia. Este campo está reservado.
revert_to_snapshot_support
Boolean
(Soportado por API v2.27 y versiones posteriores.) Especifica si se admite la reversión a instantáneas. Actualmente, la instantánea no es compatible. Este campo está reservado.
create_share_from_snapshot_support
Boolean
(Soportado por API v2.24 y versiones posteriores.) Especifica si se admite la creación de sistemas de archivos a partir de instantáneas. Actualmente, la instantánea no es compatible. Este campo está reservado.
mount_snapshot_support
Boolean
(Soportado por API v2.32 y versiones posteriores.) Especifica si se admite el montaje de instantáneas. Actualmente, la instantánea no es compatible. Este campo está reservado.
user_id
String
(Soportado por API v2.16 y versiones posteriores.) Especifica el ID de usuario.
- Ejemplo de respuesta
{ "share": { "status": "available", "share_type_name": "sla", "description": "test", "links": [ { "href": "https://192.168.196.47:8796/v2/07412155bf474db9a2f697fd978593d7/shares/f26d867f-9876-433d-8db2-25d210f29309", "rel": "self" }, { "href": "https://192.168.196.47:8796/07412155bf474db9a2f697fd978593d7/shares/f26d867f-9876-433d-8db2-25d210f29309", "rel": "bookmark" } ], "availability_zone": "az1.dc1", "share_network_id": null, "share_server_id": null, "share_group_id": null, "host": "DJ38@a4588256-3880-4136-b3c9-4c3aade8a84b#a4588256-3880-4136-b3c9-4c3aade8a84b", "revert_to_snapshot_support": null, "access_rules_status": "active", "snapshot_id": null, "create_share_from_snapshot_support": null, "is_public": true, "task_state": null, "snapshot_support": true, "id": "f26d867f-9876-433d-8db2-25d210f29309", "size": 1, "source_share_group_snapshot_member_id": null, "user_id": "daa3f8f8d7254465841da769298a76f6", "name": "manila share", "share_type": "8ae4e74e-83f4-4980-8ab8-e637f9294e0b", "has_replicas": false, "replication_type": null, "created_at": "2018-12-25T08:45:22.525899", "share_proto": "NFS", "volume_type": "sla", "mount_snapshot_support": null, "project_id": "07412155bf474db9a2f697fd978593d7", "metadata": { "share_key": "test", "share_used": "1", } } }
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.