Construcción de una solicitud
Esta sección describe la estructura de una solicitud de API de REST.
URI de solicitud
SFS utiliza URI para localizar sistemas de archivos de uso general específicos y sus parámetros. Utilice URI cuando desee utilizar recursos.
A continuación se proporciona un formato de URI común. Los parámetros entre corchetes [ ] son opcionales.
protocol://[filesystem.]domain[:port]/[?param]
| Parámetro | Descripción | Obligatorio |
|---|---|---|
| protocol | Protocolo utilizado para enviar solicitudes, que pueden ser HTTP o HTTPS. HTTPS es un protocolo que garantiza un acceso seguro a los recursos. SFS soporta HTTP y HTTPS. | Sí |
| filesystem | Ruta de recursos de un sistema de archivos de uso general, que identifica solo un sistema de archivos de uso general en SFS | No |
| domain | Nombre de dominio o dirección IP del servidor para almacenar recursos | Sí |
| port | Puerto habilitado para los protocolos utilizados para enviar solicitudes. El valor varía con el despliegue del servidor de software. Si no se especifica ningún número de puerto, el protocolo utiliza el puerto predeterminado. Cada protocolo de transmisión tiene un puerto predeterminado. Por ejemplo, HTTP utiliza el puerto 80 y HTTPS utiliza el puerto 443. En SFS, el puerto HTTP predeterminado es 80 y el puerto HTTPS predeterminado es 443. | No |
| param | Un recurso específico contenido por un sistema de archivos de uso general. El valor predeterminado de este parámetro indica que se obtiene el sistema de archivos en sí. | No |
Todas las solicitudes de API, excepto las de listado de sistemas de archivos, deben contener el nombre del sistema de archivos de uso general. Para garantizar el rendimiento y la confiabilidad de la resolución de DNS, SFS requiere que el nombre del sistema de archivos de uso general preceda al dominio cuando se construye una solicitud que lleva un nombre de sistema de archivos para formar un nombre de dominio de tres niveles, también mencionado como nombre de dominio de acceso en estilo de alojamiento virtual.
Métodos de solicitud
Los métodos HTTP, que también se denominan operaciones o acciones, especifican el tipo de operaciones que está solicitando.
| Método | Descripción |
|---|---|
| GET | Solicita al servidor que devuelva recursos específicos, por ejemplo, para listar sistemas de archivos de uso general. |
| PUT | Solicita al servidor que actualice recursos específicos, por ejemplo, para crear sistemas de archivos de uso general. |
| POST | Solicita a un servidor que agregue recursos o realice operaciones especiales. |
| DELETE | Solicita al servidor que elimine recursos específicos, por ejemplo, para eliminar sistemas de archivos de uso general. |
| HEAD | Igual que GET, excepto que el servidor debe devolver solo el encabezado de respuesta. |
| OPTIONS | Solicita al servidor que verifique si el usuario tiene los permisos para operar un recurso. |
Encabezados de solicitud
Hace referencia a campos de solicitud opcionales y adicionales, por ejemplo, un campo requerido por un método URI o HTTP específico. Tabla 3 describe algunos campos de encabezado de solicitud comunes.
| Encabezado | Descripción | Obligatorio |
|---|---|---|
| Authorization | Información de firma contenida en un mensaje de solicitud Tipo: string Sin valor predeterminado. | Sí |
| Content-Length | La longitud del mensaje (sin incluir encabezados) definida en RFC 2616 Tipo: string Sin valor predeterminado. Condición: requerido para las solicitudes PUT y aquellas que cargan contenido XML. | Requerido condicionalmente |
| Content-Type | El tipo de contenido del recurso solicitado, por ejemplo, text/plain Tipo: string Sin valor predeterminado. | No |
| Date | Fecha y hora en la que se inicia una solicitud, por ejemplo, Wed, 27 Jun 2018 13:39:15 +0000. Tipo: string Sin valor predeterminado. Condición: opcional para solicitudes que contienen el encabezado x-obs-date, requerido para otras solicitudes. | Requerido condicionalmente |
| Host | La dirección del host, por ejemplo, filesystem.sfs3.region.myhuaweicloud.com. Tipo: string Sin valor predeterminado. | Sí |
(Opcional) Cuerpo de la solicitud
Un cuerpo de solicitud se envía generalmente en un formato estructurado (por ejemplo, JSON o XML). Corresponde a Content-Type en el encabezado de solicitud y se usa para transferir contenido distinto al encabezado de solicitud. Si el cuerpo de la solicitud contiene caracteres chinos, estos caracteres deben estar codificados en UTF-8.
El cuerpo de la solicitud varía según las API. Algunas API no requieren el cuerpo de la solicitud, como las API de GET y DELETE.
Envío de una solicitud
Existen dos métodos para iniciar solicitudes en función de los mensajes de solicitud construidos:
- cURL
cURL es una herramienta de línea de comandos utilizada para realizar operaciones de URL y transmitir información. cURL actúa como un cliente HTTP que puede enviar solicitudes HTTP al servidor y recibir mensajes de respuesta. cURL es aplicable a la depuración de API. Para obtener más información sobre cURL, visite https://curl.haxx.se/. cURL no puede calcular firmas. Cuando se utiliza cURL, solo se puede acceder a los recursos SFS públicos anónimos.
- Codificación
Puede usar código para invocar la API y para ensamblar, enviar y procesar mensajes de solicitud. Se puede implementar mediante codificación.