1.7. http://localhost:7080/rest/metric: Deal with metrics

メソッド

• GET /metric/data/{scheduleId}

  description

  スケジュールのバケット化されたメトリクス値を取得します。

  gzip ed Content-Encoding の返信をサポートします。

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  scheduleId	path	クエリーする値のスケジュール	true	int	all
  startTime	クエリー	エポックから開始時間。	false	long	all	終了時間 - 8h
  endTime	クエリー	エポックからの経過時間。	false	long	all	now
  dataPoints	クエリー	バケットの数	false	int	all	60
  hideEmpty	クエリー	NaN のみの行の非表示	false	ブール値	all	false

  return type: javax.ws.rs.core.Response

  エラーコード：

  code	reason
  404	渡された ID のスケジュールがない

• GET /metric/data/group/{groupId}/{definitionId}

  description

  グループのメトリクス定義のバケット化されたメトリクス値を取得します。

  gzip ed Content-Encoding の返信をサポートします。

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  groupId	path	問い合わせるグループの ID	true	int	all
  definitionId	path	取得するメトリクス定義の ID	true	int	all
  startTime	クエリー	エポックから開始時間。	false	long	all	終了時間 - 8h
  endTime	クエリー	エポックからの経過時間。	false	long	all	now
  dataPoints	クエリー	バケットの数	false	int	all	60
  hideEmpty	クエリー	NaN のみの行の非表示	false	ブール値	all	false

  return type: javax.ws.rs.core.Response

• GET /metric/data

  description

  渡されたスケジュールのバケット化されたメトリックデータ（60 ポイント）を返します。

  gzip ed Content-Encoding の返信をサポートします。

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  SID	クエリー	スケジュール ID のコンマ区切りリスト	true	string	all
  startTime	クエリー	エポックからの経過時間(ms)。デフォルトは -8h です。	false	long	all
  endTime	クエリー	エポックからの経過時間（ミリ秒単位）。デフォルトは現在の状態です。	false	long	all
  dataPoints	クエリー	バケットの数	false	int	all	60
  hideEmpty	クエリー	空のデータポイントを非表示にする必要があります。	false	ブール値	all	false

  return type: javax.ws.rs.core.Response

  エラーコード：

  code	reason
  404	渡された ID のスケジュールがない
  406	No schedules requesteds（要求されるスケジュールなし）
  406	スケジュール ID が数値ではない

• GET /metric/schedule/{id}

  description

  渡された ID のメトリクススケジュールを取得します。
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  id	path	スケジュール ID	true	int	all

  return type: javax.ws.rs.core.Response

  エラーコード：

  code	reason
  404	渡された ID のスケジュールがない

• GET /metric/data/resource/{resourceId}

  description

  リソースの高/低/平均/データ集計の一覧の取得

  gzip ed Content-Encoding の返信をサポートします。

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  resourceId	path	問い合わせるリソースの ID	true	int	all
  startTime	クエリー	エポックから開始時間。	false	long	all	終了時間 - 8h
  endTime	クエリー	エポックからの経過時間。	false	long	all	now
  includeDataPoints	クエリー	include data point	false	ブール値	all	false
  dataPoints	クエリー	バケットの数（データポイントが含まれている場合）	false	int	all	60
  hideEmpty	クエリー	NaN のみの行の非表示	false	ブール値	all	false

  return type: List<MetricAggregate>

  エラーコード：

  code	reason
  404	渡された ID のリソースが存在しない場合

• GET /metric/data/group/{groupId}

  description

  グループの高/低/平均/データアグリゲートの一覧の取得

  gzip ed Content-Encoding の返信をサポートします。

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  groupId	path	問い合わせるグループの ID	true	int	all
  startTime	クエリー	エポックから開始時間。	false	long	all	終了時間 - 8h
  endTime	クエリー	エポックからの経過時間。	false	long	all	now

  return type: List<MetricDefinitionAggregate>

  エラーコード：

  code	reason
  404	渡された ID のグループはありません。

• put /metric/schedule/{id}

  description

  スケジュールの更新（有効、間隔）
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  id	path	更新するスケジュールの ID	true	int	all
  	-body-	新しいスケジュールデータ	true	MetricSchedule	all

  return type: MetricSchedule

  エラーコード：

  code	reason
  404	渡された ID のスケジュールがない

• GET /metric/definition/{id}

  description

  定義を取得します。
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  id	path	取得する定義の ID	true	int	all

  return type: MetricSchedule

  エラーコード：

  code	reason
  404	指定の id の定義はありません。

• put /metric/definition/{id}

  description

  定義を更新します（デフォルトの間隔）。

  注記

  この操作は内部的に完了するのに時間がかかる可能性があるため、この呼び出しによってのみトリガーされます。戻りコード 200 は、操作が正常に送信されたことを示します。

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  id	path	更新する定義の ID	true	int	all
  	-body-	新規定義データ	true	MetricSchedule	all
  updateExisting	クエリー	この定義の既存のスケジュールも更新する	false	ブール値	all	false

  return type: MetricSchedule

  エラーコード：

  code	reason
  404	指定の id の定義はありません。

• GET /metric/data/{scheduleId}/raw

  description

  単一スケジュールの raw メトリクスを公開します。これは生データのみを公開できます。つまり、開始日が 7 日以上かかる場合があります。

  gzip ed Content-Encoding の返信をサポートします。

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  scheduleId	path	NONE	true	int	all
  startTime	クエリー	エポックからの開始日	false	long	all	now - 8h
  endTime	クエリー	エポックからの経過時間	false	long	all	now
  duration	クエリー	TimeSpan（ミリ秒単位）	false	long	all	8h = 28800000ms

  戻りタイプ： javax.ws.rs.core.StreamingOutput

  エラーコード：

  code	reason
  404	渡された ID のスケジュールがない

• GET /metric/data/{scheduleId}/callTime

  description

  特定の scheduleId の callTime データを公開します。
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  scheduleId	path	NONE	true	int	all
  startTime	クエリー	エポックからの開始日	false	long	all	now - 8h
  endTime	クエリー	エポックからの経過時間	false	long	all	now
  aggregate	クエリー	true は callDestination で集約された callTimes を返します。	false	ブール値	all	true

  戻りタイプ： javax.ws.rs.core.StreamingOutput

  エラーコード：

  code	reason
  404	渡された ID のスケジュールがない

• PUT /metric/data/{scheduleId}/callTime

  description

  callTime メトリクスのサーバーへの送信
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  scheduleId	path	スケジュールの ID	true	int	all
  	-body-	追加する呼び出し時間値の一覧。	true	List<CallTimeValueRest>	-all-	-none-

  return type: javax.ws.rs.core.Response

  エラーコード：

  code	reason
  404	渡された ID のスケジュールがない
  406	beginTime is older than 7 days（beginTime が 7 日より古い）
  406	callDestination が null である
  406	期間が負の値である

• PUT /metric/data/{scheduleId}/raw/{timeStamp}

  description

  1 つの（数値）メトリックをサーバーに送信
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  scheduleId	path	スケジュールの ID	true	int	all
  timeStamp	path	メトリックのタイムスタンプ	true	long	all
  	-body-	データ値	true	DoubleValue	all

  return type: javax.ws.rs.core.Response

  エラーコード：

  code	reason
  404	渡された ID のスケジュールがない
  406	タイムスタンプが 7 日よりも古い

• PUT /metric/data/{scheduleId}/trait/{timeStamp}

  description

  渡されたスケジュール ID の新しい特性値の送信
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  scheduleId	path	スケジュールの ID	true	int	all
  timeStamp	path	メトリックのタイムスタンプ	true	long	all
  	-body-	データ値	true	StringValue	all

  return type: javax.ws.rs.core.Response

  エラーコード：

  code	reason
  404	渡された ID のスケジュールがない
  406	タイムスタンプが 7 日よりも古い

• GET /metric/data/{scheduleId}/trait

  description

  渡されたスケジュール ID で特性の現在の値を取得します。
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  scheduleId	path	スケジュールの ID	true	int	all

  戻りタイプ : StringValue

  エラーコード：

  code	reason
  404	渡された ID のスケジュールがない

• Post /metric/data/raw

  description

  サーバーに一連の（数値）メトリック値を送信
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  	-body-	スケジュール ID が設定されている数値データポイント値のコレクション。	true	Collection<NumericDataPoint>	-all-	-none-

  戻りタイプ： 応答なし

  エラーコード：

  code	reason
  201	一部の送信済みデータポイントに存在しない scheduleId があり、API は拒否された値をクライアントに戻します。有効な値が許可されます。
  403	送信されたすべてのデータポイントに存在しない scheduleId があり、API は拒否された値をクライアントに返します。

• POST /metric/data/raw/{resourceId}

  description

  1 つのリソースの一連の（数値）メトリック値をサーバーに送信する
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  resourceId	path	NONE		int	-all-	-none-
  	-body-	メトリック定義の名前が設定された数値データポイント値のコレクション。	true	Collection<NumericDataPoint>	-all-	-none-

  戻りタイプ： 応答なし

  エラーコード：

  code	reason
  403	受信したデータポイントからのメトリックが指定のリソースに存在しない

• GET /metric/data/{scheduleId}/baseline

  description

  スケジュールの現在のベースラインを取得します。
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  scheduleId	path	スケジュールの ID	true	int	all

  戻りタイプ： ベース ライン

  エラーコード：

  code	reason
  404	渡された ID のスケジュールがない

• PUT /metric/data/{scheduleId}/baseline

  description

  スケジュールの新しいベースラインの設定
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  scheduleId	path	スケジュールの ID	true	int	all
  	-body-	ベースラインの値。	true	ベースライン	-all-	-none-

  return type: javax.ws.rs.core.Response

  エラーコード：

  code	reason
  404	渡された ID のスケジュールがない
  406	ベースラインデータが正しくない