보고서 API 문서

요약

이 보고서 엔드포인트는 이전에 다양한 컨테이너 API에 분산되어 있던 많은 기능을 대체하기 위한 것으로, 컨테이너 인사이트 기능을 지원하는 데이터에 대한 보다 단일화된 보기를 제공하기 위한 것입니다.

이 엔드포인트를 사용하면 집계할 특정 메트릭의 사양별로 데이터를 분석할 수 있으며, 이를 그룹 및 필터와 결합하여 비용을 수집할 수 있습니다.

엔드포인트

/v3/containers/report

쿼리 매개변수:

요청 본문

보고서 요청 본문은 다음과 같은 주요 속성으로 구성된 json 객체입니다:

지원되는 비용 유형

지원되는 메트릭 값

요청 가능 필드

지원되는 위젯 유형

지원되는 그룹, 개수 및 필터 값

그룹, 카운트 및 필터는 다음과 같은 방법으로 활용할 수 있는 중복되는 액세스 가능한 데이터 집합을 공유합니다:

그룹

그룹은 해당 필드의 고유 값으로 집계된 결과를 반환합니다.

예를 들어 클러스터별로 그룹화하면 클러스터별로 격리된 결과 집합이 반환됩니다.

카운트

카운트는 해당 측면의 고유 항목 수를 식별하는 결과 섹션을 반환합니다.

예를 들어 네임스페이스 개수는 선택 영역 내의 총 네임스페이스 수를 반환합니다.

필터

필터를 사용하면 결과 집합을 결과의 하위 집합으로만 제한할 수 있습니다.

예를 들어, 작업 부하 유형==배포의 필터를 제공하면 배포가 소유한 것으로 식별된 작업 부하에 대한 결과만 반환합니다.

필터 사용

필터는 다음을 제공하여 구성할 수 있습니다:

• 필터링된 속성

  • 위 목록에서 필터링 가능한 것으로 표시된 모든 값

• 연산자

  • ==

    • 같음(대소문자 구분)

  • []=

    • 다음 중 하나(대소문자 구분)

• 필터링된 값

  • 사용자가 필터링하고자 하는 모든 값

예:

• 네임스페이스==kube-system

  • 결과를 필터링하여 큐브 시스템에 대한 데이터만 표시합니다

• 워크로드 유형[]=크론잡,잡

  • 결과를 필터링하여 크론잡 또는 작업에 대한 데이터만 표시합니다

지원되는 정렬 구성

설정하지 않으면 정렬 기능은 기본적으로 첫 번째로 지정된 메트릭 열을 기준으로 내림차순으로 정렬합니다. 페이지 매김이 항상 가능하도록 설정되어 있습니다.

정렬 값은 호출자가 원하는 순서대로 전달되어야 하며, 요청된 모든 메트릭 값에 대해 지정할 수 있습니다.

아래 예는 효율을 기준으로 내림차순으로 행을 정렬한 다음, 총비용을 기준으로 내림차순으로 정렬합니다.

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

페이지 매김

위의 페이지 매김 데이터에서 다른 페이지를 사용할 수 있음을 나타내는 경우 "paginationToken" 매개 변수를 통해 "nextToken" 의 값을 다시 API로 전달할 수 있습니다.

미국 예시(API 엔드포인트): https://api.cloudability.com/v3/containers/report

요청 예시

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
}'

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"
	}
   }
}

이 응답 본문은 다음 섹션으로 나뉩니다: