Construção de uma solicitação
Esta seção descreve a estrutura de uma solicitação de API REST.
URI da solicitação
O SFS usa URI para localizar sistemas de arquivos de uso geral específicos e seus parâmetros. Use URIs quando quiser operar recursos.
A seguir, é fornecido um formato de URI comum. Os parâmetros entre colchetes [ ] são opcionais.
protocol://[filesystem.]domain[:port]/[?param]
| Parâmetro | Descrição | Obrigatório |
|---|---|---|
| protocol | Protocolo usado para enviar solicitações, que pode ser HTTP ou HTTPS. HTTPS é um protocolo que garante acesso seguro aos recursos. O SFS é compatível com HTTP e HTTPS. | Sim |
| filesystem | Caminho de recurso de um sistema de arquivos de uso geral, identificando apenas um sistema de arquivos de uso geral no SFS | Não |
| domain | Nome de domínio ou endereço IP do servidor para armazenar recursos | Sim |
| port | Porta habilitada para protocolos usados para enviar solicitações. O valor varia com a implementação do servidor de software. Se nenhum número de porta for especificado, o protocolo usará a porta padrão. Cada protocolo de transmissão tem uma porta padrão. Por exemplo, o HTTP usa a porta 80 e o HTTPS usa a porta 443. No SFS, a porta HTTP padrão é 80 e a porta HTTPS padrão é 443. | Não |
| param | Um recurso específico contido por um sistema de arquivos de uso geral. O valor padrão desse parâmetro indica que o próprio sistema de arquivos é obtido. | Não |
Todas as solicitações de API, exceto aquelas para listar sistemas de arquivos, devem conter o nome do sistema de arquivos de uso geral. Para garantir o desempenho e a confiabilidade da resolução de DNS, o SFS exige que o nome do sistema de arquivos de uso geral preceda o domínio quando uma solicitação que transporta um nome de sistema de arquivos for construída para formar um nome de domínio de três níveis, também mencionado como nome de domínio de acesso de estilo de hospedagem virtual.
Método de solicitação
Os métodos HTTP, que também são chamados de operações ou ações, especificam o tipo de operações que você está solicitando.
| Método | Descrição |
|---|---|
| GET | Solicita ao servidor que retorne recursos específicos, por exemplo, para listar sistemas de arquivos de uso geral. |
| PUT | Solicita ao servidor que atualize recursos específicos, por exemplo, para criar sistemas de arquivos de uso geral. |
| POST | Solicita ao servidor que adicione recursos ou execute operações especiais. |
| DELETE | Solicita ao servidor que exclua recursos especificados, por exemplo, sistemas de arquivos de uso geral. |
| HEAD | O mesmo que GET, exceto que o servidor deve retornar apenas o cabeçalho da resposta. |
| OPTIONS | Solicita ao servidor que verifique se o usuário tem permissões para operar um recurso. |
Cabeçalhos de solicitação
Refere-se a campos de solicitação opcionais e adicionais, por exemplo, um campo exigido por um URI ou método HTTP específico. Tabela 3 descreve alguns campos comuns de cabeçalho de solicitação.
| Cabeçalho | Descrição | Obrigatório |
|---|---|---|
| Authorization | Informações de assinatura contidas em uma mensagem de solicitação Tipo: string Sem valor padrão. | Sim |
| Content-Length | O comprimento da mensagem (excluindo cabeçalhos) definido na RFC 2616 Tipo: string Sem valor padrão. Condição: necessário para solicitações PUT e aquelas solicitações que carregam conteúdo XML. | Necessário condicionalmente |
| Content-Type | O tipo de conteúdo do recurso solicitado, por exemplo, text/plain Tipo: string Sem valor padrão. | Não |
| Date | O horário em que uma solicitação é iniciada, por exemplo, Wed, 27 Jun 2018 13:39:15 +0000. Tipo: string Sem valor padrão. Condição: opcional para solicitações contendo cabeçalho x-obs-date, obrigatório para outras solicitações. | Necessário condicionalmente |
| Host | O endereço do host, por exemplo, filesystem.sfs3.region.myhuaweicloud.com. Tipo: string Sem valor padrão. | Sim |
(Opcional) Corpo da solicitação
Um corpo de solicitação geralmente é enviado em um formato estruturado (por exemplo, JSON ou XML). Corresponde a Content-Type no cabeçalho da solicitação e é usado para transferir conteúdo diferente do cabeçalho da solicitação. Se o corpo da solicitação contiver caracteres chineses, esses caracteres devem ser codificados em UTF-8.
O corpo da solicitação varia de acordo com as APIs. Algumas APIs não exigem o corpo da solicitação, como as APIs GET e DELETE.
Envio de uma solicitação
Existem dois métodos para iniciar solicitações com base nas mensagens de solicitação construídas:
- cURL
cURL é uma ferramenta de linha de comando usada para realizar operações de URL e transmitir informações. cURL atua como um cliente HTTP que pode enviar solicitações HTTP para o servidor e receber mensagens de resposta. cURL é aplicável à depuração de API. Para obter mais informações sobre cURL, visite https://curl.haxx.se/. cURL não pode calcular assinaturas. Quando cURL é usado, apenas recursos públicos anônimos do SFS podem ser acessados.
- Codificação
Você pode usar código para fazer chamadas de API e para montar, enviar e processar mensagens de solicitação. Ele pode ser implementado por codificação.