Primeiros passos com a API Cloudability V3

Autenticação de API

curl https://api.cloudability.com/v3/budgets -u 'Your_API_Key:'

Interações de API

curl https://api.cloudability.com/v3/budgets -u 'Your_API_Key:'

curl https://api.cloudability.com/v3/budgets -H "apptio-opentoken: [apptio opentoken]" -H "apptio-environmentid: [apptio Access Administration environment id]"

Formato de resposta

Todas as respostas bem-sucedidas estarão no seguinte formato:

{
    result: {} or [],
    meta: {},
}

• result conterá os resultados ou a carga útil da chamada.

• Informações auxiliares (como detalhamento de paginação e outras) existirão no atributo meta, se relevantes.

• Os valores primitivos serão nulos se nenhum valor estiver presente (ou seja, números, cadeias de caracteres).

• Objetos e matrizes retornarão seus estados vazios ( [] ) se nenhum valor estiver presente.

• As datas são representadas no padrão ISO 8601 e usam o formato AAAA-MM-DD.

Cabeçalhos

Solicitações POST e PUT

Content-Type: application/json

Solicitações GET (para todos os pontos de extremidade)

Aceitar: application/json

Solicitações GET (suportadas por alguns pontos de extremidade)

Aceitar: text/csv

Autorização (se estiver usando chaves de API Cloudability )

Autorização: Basic <cldy_token>

Paginação

Nem todos os pontos de extremidade suportam paginação. Os pontos de extremidade que não suportam paginação sempre retornarão todos os registros. Os pontos de extremidade que suportam paginação retornarão os primeiros 50 registros correspondentes por padrão.

Ao tentar a paginação, você deve usar os parâmetros de limite e deslocamento juntos. Quando você usar esses parâmetros, o conjunto de resultados será restrito ao limite especificado a partir do valor de deslocamento.

O valor padrão para o limite é 50 (retorna 50 registros) e o deslocamento é 0 (início dos registros).

Exemplo

O exemplo a seguir mostra como usar os parâmetros de limite e deslocamento com o sort.

/views?limit=5&offset=20

Classificação

Use o parâmetro de consulta sort para classificar seus resultados. Para especificar a ordem de classificação, você pode adicionar - ( decrescente) ou + ( crescente) antes do atributo.

Exemplos

Classifique os resultados do ponto final do portfólio pelo atributo final em ordem decrescente.

/portfolio/ec2?sort=-end

Classifique os resultados do ponto final do portfólio pelo atributo final em ordem crescente.

/portfolio/ec2?sort=%2bend

(Certifique-se de codificar corretamente o símbolo +)

Filtragem

Ao usar o parâmetro de consulta filter, você fornece uma dimensão que deseja filtrar, seguida da expressão de filtro.

As consultas filtradas restringem as linhas que são incluídas no resultado. Somente as linhas que atendem às condições do filtro são incluídas no resultado. Observe que as bibliotecas do cliente codificam automaticamente os operadores de filtro em URL. No entanto, se você fizer solicitações diretamente ao protocolo, deverá codificar explicitamente os seguintes operadores de filtro no site URL. Além disso, a filtragem ocorre antes que qualquer dimensão seja agregada, de modo que as métricas retornadas representem o total apenas dos registros relevantes.

Sintaxe do filtro: expressão do operador de nome

name: O nome da dimensão na qual o filtro será aplicado.

operador: Especifica o tipo de correspondência de filtro a ser usado. Você pode usar os seguintes operadores:

== (igual)

!= (não é igual)

> (maior que)

< (menos que)

>= (maior que ou igual a)

<= (menor que ou igual a)

=@ (contém)

!=@ (não contém)

expressão: Declara os valores incluídos nos resultados.

Para aplicar vários filtros a uma solicitação, delimite-os com vírgulas em um parâmetro de filtro.

Exemplos

Verificar se o estado está ativo:

/portfolio/ec2?filter=state==active

Verifique se o estado está aposentado:

/portfolio/ec2?filter=state==retired

Verifique se o final é menor que 1541803776000:

/portfolio/ec2?filter=end<1541803776000

Verifique se o final é maior que 1541803776000:

/portfolio/ec2?filter=end>1541803776000

Aplique vários filtros:

/portfolio/ec2?filter=state==active,end>1541803776000

Cloudability exemplos de pontos finais

A documentação de cada ponto final incluirá vários exemplos que mostrarão como interagir com a API. Os exemplos usarão cURL para interações HTTP e jq para analisar JSON. Essas duas ferramentas de CLI são amplamente usadas e podem ser facilmente empregadas para interagir com uma API RESTful.