Introducción a la API Cloudability V3

Autenticación API

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

Interacciones 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 la respuesta

Todas las respuestas correctas tendrán el siguiente formato:

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

• result contendrá los resultados o la carga útil de la llamada.

• La información auxiliar (como desgloses de paginación y otros) existirá en el atributo meta, si es relevante.

• Los valores primitivos serán null si no hay ningún valor presente (es decir, números, cadenas).

• Los objetos y las matrices devolverán sus estados vacíos ( [] ) si no hay ningún valor presente.

• Las fechas se representan en la norma ISO 8601 y utilizan el formato AAAA-MM-DD.

Cabeceras

Solicitudes POST y PUT

Content-Type: application/json

Solicitudes GET (para todos los puntos finales)

Aceptar: application/json

Solicitudes GET (admitidas por algunos puntos finales)

Acepta: text/csv

Autorización (si se utilizan claves API Cloudability )

Autorización: Basic <cldy_token>

Paginación

No todos los puntos finales admiten la paginación. Los puntos finales que no admiten la paginación siempre devolverán todos los registros. Los puntos finales que admiten la paginación devolverán por defecto los 50 primeros registros coincidentes.

Al intentar la paginación, debe utilizar los parámetros limit y offset conjuntamente. Cuando utilice estos parámetros, el conjunto de resultados se restringirá al límite especificado a partir del valor de desplazamiento.

El valor por defecto para limit es 50 (devuelve 50 registros) y offset es 0 (inicio de los registros).

Ejemplo

El siguiente ejemplo muestra cómo utilizar los parámetros limit y offset con sort.

/views?limit=5&offset=20

Clasificación

Utilice el parámetro de consulta sort para ordenar los resultados. Para especificar el orden de clasificación, puede añadir - ( descendente) o + ( ascendente) antes del atributo.

Ejemplos

Ordena los resultados para el punto final de la cartera por el atributo final en orden descendente.

/portfolio/ec2?sort=-end

Ordena los resultados para el punto final de la cartera por el atributo final en orden ascendente.

/portfolio/ec2?sort=%2bend

(Asegúrese de codificar correctamente el símbolo +)

Filtrado

Cuando se utiliza el parámetro de consulta de filtro, se proporciona una dimensión sobre la que se desea filtrar, seguida de la expresión de filtro.

Las consultas filtradas restringen las filas que se incluyen en el resultado. Sólo se incluyen en el resultado las filas que cumplen las condiciones del filtro. Tenga en cuenta que las bibliotecas cliente codifican automáticamente en URL los operadores de filtro. Sin embargo, si realiza peticiones directamente al protocolo, debe codificar explícitamente en URL los siguientes operadores de filtro. Además, el filtrado se produce antes de agregar cualquier dimensión, de modo que las métricas devueltas representan el total sólo de los registros relevantes.

Sintaxis del filtro: nombre operador expresión

nombre: El nombre de la dimensión sobre la que filtrar.

operador: Especifica el tipo de coincidencia de filtro a utilizar. Puede utilizar los siguientes operadores:

== (igual)

!= (no es igual)

> (mayor que)

< (menos de)

>= (mayor o igual que)

<= (menor o igual que)

=@ (contiene)

!=@ (no contiene)

expresión: Indica los valores incluidos en los resultados.

Para aplicar varios filtros a una solicitud, delimite con comas en un parámetro de filtro.

Ejemplos

Comprueba si el estado está activo:

/portfolio/ec2?filter=state==active

Comprueba si el estado es de jubilado:

/portfolio/ec2?filter=state==retired

Compruebe si el final es inferior a 1541803776000:

/portfolio/ec2?filter=end<1541803776000

Comprueba si el final es mayor que 1541803776000:

/portfolio/ec2?filter=end>1541803776000

Aplica varios filtros:

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

Cloudability ejemplos de puntos finales

La documentación de cada punto final incluirá una serie de ejemplos que mostrarán cómo interactuar con la API. Los ejemplos utilizarán cURL para las interacciones HTTP y jq para analizar JSON. Ambas herramientas CLI son ampliamente utilizadas y pueden emplearse fácilmente para interactuar con una API RESTful.