レポート API ドキュメント

要約

このレポート・エンドポイントは、これまで様々なコンテナAPIに分散していた多くの機能を置き換えるもので、コンテナ・インサイト機能を支えるデータのより単一的なビューを提供することを目的としている。

このエンドポイントでは、集計する特定の測定基準を指定することでデータを分析することができ、グループやフィルタと組み合わせてコストを収集することができます。

エンドポイント

/v3/containers/report

クエリーパラメーター

リクエスト・ボディ

レポート・リクエスト・ボディは、以下の主要属性で構成されるjsonオブジェクトです：

サポートされるコスト・タイプ

サポートされるメトリック値

リクエスト可能なフィールド

サポートされるウィジェットタイプ

サポートされるグループ、カウント、フィルター値

グループ、カウント、フィルターは、アクセス可能なデータの重複するセットを共有し、以下の方法で利用することができる：

グループ

グループは、そのフィールドのユニークな値によって集約された結果を返します。

たとえば、クラスターでグループ化すると、クラスターごとに分離された結果セットが返される。

カウント

Countsは、そのアスペクトの一意なエントリの数を特定する結果セクションを返す。

例えば、ネームスペースのカウントは、選択範囲内のネームスペースの総数を返します。

フィルター

フィルタを使用すると、ユーザーは結果のサブセットのみに結果セットを制限することができます。

たとえば、workload_type==deployment というフィルタを指定すると、デプロイメントが所有し ていると識別されたワークロードの結果のみが返される。

フィルターの使用

を指定することでフィルタを設定できる：

• フィルタリングされた属性

  • 上記のリストでフィルタリング可能な値として示されているすべての値

• オペレーター

  • ==

    • イコール（大文字と小文字を区別）

  • []=

    • のいずれか（大文字と小文字を区別する）

• フィルタリングされた値

  • ユーザーがフィルタリングしたい任意の値

例:

• 名前空間==kube-system

  • 結果を絞り込んで、kube-system のデータのみを表示します

• workload_type[]=cronjob,job

  • クーロンジョブまたはジョブのデータのみを表示するように結果を絞り込む

対応ソート構成

設定されていない場合、ソート機能のデフォルトは、最初に指定されたメトリック列で降順にソートされます。 これは、ページネーションが常に可能であることを保証するための設定である。

ソート値は、呼び出し元が希望する順序で渡されるべきであり、要求されたメトリック値に対して指定することができる。

以下の例では、行を効率の降順でソートし、次にtotal_costの降順でソートする。

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

ページネーション

上記のページネーション用データが、別のページが消費可能であることを示している場合、 "nextToken" の値は、 "paginationToken" パラメータを介して、apiに渡すことができる。

USの例（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"
	}
   }
}

このレスポンス本体は以下のセクションに分かれている：