Este documento descreve os métodos disponíveis para administrar o Big File. A API REST do Big File suporta solicitações JSON e XML codificadas por formulário e pode retornar respostas JSON ou XML.

Índice

Pré-requisitos

Antes de começar, valide os seguintes processos:

• Criando nova conta no BigFile
• Acessando o Big file

Etapa 1: Explicações

Uso

A maioria das APIs disponíveis requer autenticação, o que requer um token de API para uso. Você pode recuperar esse token através da seção Usuário do seu Big File veja o manual para acesso  API Big File.

Métodos de autenticação

O token de autenticação pode ser passado pelo access_key parâmetro dentro do corpo da solicitação da API REST ou pelo X-Access-Key cabeçalho. Como alternativa, você pode usar os parâmetros username e password para autenticação, mas não recomendamos esse método para outra coisa senão a possibilidade de recuperar uma chave de API.

Timeouts

Por padrão, todas as operações que não forem concluídas em cinco segundos retornarão uma mensagem informando que a ação pode levar algum tempo para ser concluída. Ao usar a API, isso pode fazer com que algumas ações, como adicionar unidades à política de armazenamento, sejam indesejáveis ​​assíncronas. Você pode especificar seu próprio tempo limite com o timeout parâmetro, em segundos, e um valor de tempo limite de -1 especifica um tempo limite infinito.

Etapa 2: Funções da API

1. Os requests da APi da Big file podem retornar os seguintes componentes:
   1. Contas
   2. Comercial
   3. Drives
   4. Controladores virtuais
   5. Grupos do balanceador de carga
   6. Políticas de armazenamento
2.  As informações de medição retornadas pela API estão sujeitas às seguintes restrições:
   1. Intervalo de 10 segundos - intervalo de 1 hora
   2. Intervalo de 1 minuto - intervalo de 1 dia
   3. Intervalo de 1 hora - intervalo de 30 dias

Valores fora do intervalo aceito serão retornados como 0.

Próximos passos: