Documentación de la API de informes

Resumen

El punto final del informe está destinado a sustituir muchas funciones que anteriormente estaban divididas en una variedad de API de contenedores y está destinado a proporcionar una visión más singular de los datos que alimentan la función de información de los contenedores.

Este endpoint permite el análisis de datos mediante la especificación de métricas específicas a agregar que pueden combinarse con grupos y filtros para recopilar costes.

Punto final

/v3/containers/report

Parámetros de consulta:

Cuerpo de la solicitud

El cuerpo de la solicitud de informe es un objeto json compuesto por los siguientes atributos clave:

Tipos de costes admitidos

Valores métricos admitidos

Campos que se pueden solicitar

Tipos de widgets compatibles

Valores de grupo, recuento y filtro admitidos

Grupos, Recuentos y Filtros comparten un conjunto superpuesto de datos accesibles, que pueden utilizarse de las siguientes maneras:

Grupos

Los grupos devuelven resultados agregados por valores únicos en ese campo.

Por ejemplo, la agrupación por clúster devolvería un conjunto de resultados aislados por clúster.

Cuenta

Los recuentos devuelven una sección de resultados que identifica el número de entradas únicas para ese aspecto.

Por ejemplo, un recuento de espacios de nombres devolvería el número total de espacios de nombres dentro de la selección.

Filtros

Los filtros permiten al usuario restringir el conjunto de resultados a sólo un subconjunto de ellos.

Por ejemplo, si se proporciona un filtro de tipo_carga_trabajo==implantación, sólo se obtendrán resultados de las cargas de trabajo identificadas como propiedad de una implantación.

Uso de filtros

Los filtros pueden configurarse suministrando los:

• Atributo filtrado

  • Cualquier valor indicado como filtrable en la lista anterior

• Operador

  • ==

    • Iguales (distingue mayúsculas de minúsculas)

  • []=

    • Uno de (distingue mayúsculas de minúsculas)

• Valor filtrado

  • Cualquier valor que el usuario quiera filtrar

Ejemplos:

• namespace==sistema-kube

  • Filtrará los resultados para mostrar sólo los datos de kube-system

• workload_type[]=cronjob,job

  • Filtrará los resultados para mostrar sólo datos de cronjobs o trabajos

Configuraciones de clasificación admitidas

Si no se establece, la función de ordenación ordena por defecto por la primera columna métrica especificada en orden descendente. Se configura para garantizar que la paginación sea siempre posible.

Los valores de ordenación deben pasarse en el orden en que el autor de la llamada desea que se produzcan, y pueden especificarse para cualquier valor métrico solicitado.

El ejemplo siguiente ordenaría las filas por eficiencia en orden descendente y, a continuación, por coste_total en orden descendente.

[
  {
    "sortMetric": "total_cost_efficiency",
    "sortOrder": "desc"
   },
   {
     "sortMetric": "total_cost",
     "sortOrder": "desc"
   }
 ]

Paginación

Si los datos anteriores para la paginación indican que otra página está disponible para su consumo, entonces el valor en "nextToken" puede ser pasado de nuevo a la api a través del parámetro "paginationToken".

Ejemplo de EE.UU. (punto final de la API): https://api.cloudability.com/v3/containers/report

Ejemplos de solicitudes

curl --location 'https://api.cloudability.com/v3/containers/report' \
--header 'apptio-opentoken: {token}' \
--header 'apptio-environmentid: {env_id}' \
--header 'Content-Type: application/json' \
--data '{
    "start": "2024-06-10",
    "end": "2024-06-10",
    "costType": "adjusted",
    "metrics": [
	"total_cost"
    ],
    "group": [
	"namespace"
    ],
    "count": [
	"workload_name"
    ],
	"filters": [
		"cluster==XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
	],
    "sort": [
	{
	     "sortMetric": "total_cost",
	     "sortOrder": "desc"
	}
    ],
    "widgetType": "top",
    "limit": 1
}'

Ejemplo de respuesta, incluyendo el token de paginación que puede ser devuelto a la API.

{
    "result": {
	"data": [
	   {
		"count": [
		    {
			"key": "workload_name",
			"value": "20"
		    }
		],
		"dimensions": {
		    "namespace": "my-namespace"
		},
		"metrics": {
		    "total_cost": {
			"unit": "currency",
			"values": [
				100.00
			]
		    }
		}
	    }
	 ],
	"pagination": {
	    "hasNext": true,
	    "nextToken": "veryLongPaginationToken"
	}
   }
}

Este cuerpo de respuesta se divide en la siguiente sección: