1.3. http://localhost:7080/rest/alert: Deal with Alert Definitions

メソッド

• GET /alert/definition

  description

  /alert/definitions へのリダイレクト

  このメソッドにはパラメーターはありません。

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

• GET /alert/definitions

  description

  すべてのアラート定義の一覧表示

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

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  FULL	クエリー	条件および通知も返されるか？	false	ブール値	all	false
  page	クエリー	ページ番号	false	整数	all
  ps	クエリー	ページサイズ	false	int	all	20
  resourceId	クエリー	絞り込むリソース ID	false	整数	all

  return type: AlertDefinitionRest(multi)

• GET /alert/definition/{id}

  description

  id 別に 1 つの AlertDefinition を取得します。
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  id	path	取得するアラート定義の ID	true	int	all
  FULL	クエリー	条件および通知も返されるか？	false	ブール値	all	true

  return type: AlertDefinitionRest

  エラーコード：

  code	reason
  404	渡された ID の定義はありません。

• post /alert/definitions

  description

  query param として渡される resource/group/resource タイプの AlertDefinition を作成します。いつでも 3 つのパラメーターの 1 つと 1 つのパラメーターのみを指定する必要があります。POST メソッドで条件と通知を確認し、それらのオプションも確認してください。
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  resourceId	クエリー	定義を割り当てるリソースの ID	false	整数	all
  groupId	クエリー	定義をアタッチするグループの ID	false	整数	all
  resourceTypeId	クエリー	定義を割り当てるリソースタイプの ID	false	整数	all
  	-body-	新規定義のデータ	true	AlertDefinitionRest	all

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

  エラーコード：

  code	reason
  406	指定の 'resourceId'、'groupId'、または 'resourceTypeId' の 1 つが全くありませんでした。
  406	渡された条件の検証に失敗する
  406	渡されたグループは、アラート定義を持たない混合グループです。
  404	既存のアラート通知送信者以外のリクエストがありました。
  404	リカバリーへの参照アラートが存在しません。

• put /alert/definition/{id}

  description

  アラート定義の更新（優先度、有効化、細分化、リカバリー）

  注記

  優先度は HIGH,LOW,MEDIUM である必要があります。指定しない場合は、LOW が想定されます。

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  id	path	更新するアラート定義の ID	true	int	all
  	-body-	更新のデータ	true	AlertDefinitionRest	all

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

  エラーコード：

  code	reason
  404	渡された ID を持つ AlertDefinition が存在しない場合

• DELETE /alert/definition/{id}

  description

  アラート定義の削除

  注記

  この操作はデフォルトでべき等で、204. 定義が存在するかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  id	path	削除する定義の ID	true	int	all
  Validate	クエリー	定義が存在するかどうかの検証	false	ブール値	all	false

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

  エラーコード：

  code	reason
  204	検証が設定されていないため、定義が削除されているか、または存在しない
  404	定義は存在せず、検証が設定された。

• delete /alert/condition/{cid}

  description

  アラート条件の削除

  注記

  この操作はデフォルトでべき等で、204. 条件が全く存在するかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  cid	path	削除する条件の ID	true	int	all
  Validate	クエリー	条件が存在するかどうかを検証します。	false	ブール値	all	false

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

  エラーコード：

  code	reason
  204	検証が設定されていない条件が削除されているか、または存在しない。
  404	条件は存在せず、検証済みに設定されました。

• POST /alert/definition/{id}/conditions

  description

  新しいアラート条件の既存のアラート定義への追加

  注記

  各条件はカテゴリーに分類されます。使用できるカテゴリーは AVAILABILITY、AVAIL_DURATION、BASELINE(m)、CHANGE(m)、CONTROL、DRIFT、EVENT、RANGE(m)、RESOURCE_CONFIG、THRESHOLD(m)、TRAIT(m).Categories with metricsDefinition であり、メトリクス定義から取得する必要があるため、名前はありません。パラメーターはカテゴリーによって異なります。

  • Availability: name は AVAIL_GOES_DOWN、AVAIL_GOES_DISABLED、AVAIL_GOES_UNKNOWN、AVAIL_GOES_NOT_UP、および AVAIL_GOES_UP のいずれかです。
  • Avail_DURATION: name は AVAIL_DURATION_DOWN およびAVAIL_DURATION_NOT_UP のいずれかです。オプションは秒単位で時間を指定します。
  • ベースライン - オプションは 'min','mean', max' の 1 つで、しきい値はパーセンテージ(0.01=1%)を示し、conarator は '< ','=' および '> ' になります。
  • control: オプションを指定すると、Operation ステータス（FAILURE、SUCCESS、INPROGRESS、──CELED）、name は操作の名前（display-name ではありません）を示します。
  • event: name は重大度(DEBUG,INFO,WARN,ERROR,FATAL)です。オプションは、照合するオプションの RegEx です。
  • drift: name はオプションで、drift-definitions と一致します。オプションはオプションで、ディレクトリーに一致します。
  • 範囲： しきい値は下限を持ち、高い境界である Comparator は '< ','<=','>=' または '> '> '> ' になります。
  • resource_CONFIG: 追加のパラメーターは必要ありません。
  • しきい値： コンタレーターは '< ','=','> '; しきい値を比較する値です。
  • trait: オプションは、照合するオプションの RegEx です。

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  id	path	アラート定義の ID	true	int	all
  	-body-	追加する条件	true	AlertConditionRest	all

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

  エラーコード：

  code	reason
  404	渡された ID を持つ AlertDefinition が存在しない場合
  406	渡された条件の検証に失敗しました。より詳細なメッセージが提供されます。

• put /alert/condition/{cid}

  description

  アラート定義の既存の条件を更新します。更新によって条件の ID が変更されることに注意してください。
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  cid	path	更新する条件の ID	true	int	all
  	-body-	更新された条件	true	AlertConditionRest	all

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

  エラーコード：

  code	reason
  404	渡された ID の条件が存在しません。
  406	渡されたカテゴリーまたは条件 Operator が無効でした。

• GET /alert/condition/{cid}

  description

  条件 id でアラート定義の条件を取得します。
  パラメーター：

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

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

  エラーコード：

  code	reason
  404	渡された ID の条件がない

• GET /alert/notification/{nid}

  description

  ID で通知定義を返します。
  パラメーター：

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

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

  エラーコード：

  code	reason
  404	渡された ID の通知が見つからない

• delete /alert/notification/{nid}

  description

  通知定義の削除

  注記

  この操作はデフォルトでべき等で、204.の通知が全く存在するかどうかを確認する場合は、「validate」クエリーパラメーターを渡す必要があります。

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  nid	path	削除する通知定義の ID	true	int	all
  Validate	クエリー	通知が存在するかどうかを検証します。	false	ブール値	all	false

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

  エラーコード：

  code	reason
  204	検証が設定されていない通知は削除されているか、または存在しませんでした。
  404	通知は存在せず、検証用として設定されました。

• put /alert/notification/{nid}

  description

  通知定義の更新
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  nid	path	更新する通知定義の ID	true	int	all
  	-body-	使用する通知定義が更新されました。	true	AlertNotificationRest	all

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

  エラーコード：

  code	reason
  404	渡された ID の通知がない

• POST /alert/definition/{id}/notifications

  description

  新しい通知定義のアラート定義の追加
  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  id	path	通知定義を取得する必要のあるアラート定義の ID	true	int	all
  	-body-	追加する通知の定義	true	AlertNotificationRest	all

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

  エラーコード：

  code	reason
  404	Requested alert notification sender does not exist（要求されるアラート通知送信者が存在しない）
  404	渡された ID が含まれるアラート定義はありません。

• GET /alert/senders

  description

  簡単な説明を含むアラート通知送信者の一覧を返します。一覧には設定定義が含まれません。

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

  このメソッドにはパラメーターはありません。

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

• GET /alert/sender/{name}

  description

  名前でアラート通知送信者を返します。これには、予想される設定に関する情報が含まれます。

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

  パラメーター：

  Name	P.Type	description	必須	type	許可される値	デフォルト値
  Name	path	取得する送信元の名前	true	string	all

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

  エラーコード：

  code	reason
  404	渡された名前を持つ送信者はありません。