threshold API
管理者はこのAPIで、Applications Managerのしきい値設定ができます。本APIでは、GETリクエストとPOSTリクエストをサポートしています。
リクエスト パラメーター
このAPIリクエストにかかわるパラメーターは、次の通りです。
| フィールド | 説明 |
|---|---|
| しきい値名 | しきい値の表示名です。表示名に特殊文字がある場合は、しきい値名をREST APIに渡すときに、「#」を%23に、「&」を%26に、「+」を%2Bに置き換えてください。 |
| criticalcondition、warningcondition、clearcondition、secondarycriticalthresholdcondition、secondarywarningthresholdcondition、secondaryclearthresholdcondition | 条件には次のものを設定できます。
|
| criticalconditionjoiner、warningconditionjoiner、clearconditionjoiner | 2つのしきい値条件を評価する際の結合条件です。次の値を指定できます。
|
| criticalvalue、warningvalue、clearvalue, secondarycriticalthresholdvalue、secondarywarningthresholdvalue、secondaryclearthresholdvalue | ステータス重大、警告、クリアを表す値です。 |
| criticalmessage、warningmessage、clearmessage | 重大、警告、クリア条件を通知する際のメッセージです。 |
| criticalpolls、warningpolls、clearpolls | 重要度重大、警告、クリアの際、連続ポーリングの最多回数を指定するのに使います。 |
| min_criticalpolls、min_warningpolls、min_clearpolls | 重要度重大、警告、クリアの際、連続ポーリングの最少回数を指定するのに使います。 |
| type | しきい値のデータタイプです。次の値を指定できます。
|
| thresholdType | 設定するしきい値のタイプです。次の値を指定できます。
|
| adaptiveHigherPercentage | 上限しきい値を比率（％）でチェックするかを決めます。次の値を指定できます。
|
| adaptiveBaseformulaType | 可変しきい値をセットする際の計算タイプを決めます。次の値を指定できます。
|
| adaptiveBaseWeek | 可変しきい値でベースラインを決定する基準週を設定します。値は、「Previous Week」か「week-month-year」形式で指定します。 |
| businessHourAssociatedToThreshold | しきい値で業務時間を有効にするか決めます。デフォルトは「enabled」です。 |
| businessType | しきい値を適用する業務時間タイプを決めます。次の値を指定できます。
|
| selectedBusinessHourID | 業務時間IDです。デフォルトの値は「0」となっています。 |
しきい値の作成
管理者は次のAPIで、しきい値作成ができます。
構文
XMLでレスポンスを受けるには
http://[APM Host]:[APM Port]/AppManager/xml/threshold?apikey=[API_KEY]&type=[TYPE]&thresholdname=[THRESHOLD_NAME]&thresholdType=[THRESHOLD_TYPE]&criticalcondition=[CRITICAL_CONDITION]&criticalvalue=[CRITICAL_VALUE]&criticalconditionjoiner=[CRITICAL_CONDITION_JOINER]&secondarycriticalthresholdcondition=[SECONDARY_CRITICAL_CONDITION]&secondarycriticalthresholdvalue=[SECONDARY_CRITICAL_VALUE]&criticalmessage=[CRITICAL_MESSAGE]&min_criticalpolls=[MIN_CRITICAL_POLLS]&criticalpolls=[MAX__CRITICAL_POLLS]&warningcondition=[WARNING_CONDITION]&warningvalue=[WARNING_VALUE]&warningconditionjoiner=[WARNING_CONDITION_JOINER]&secondarywarningthresholdcondition=[SECONDARY_WARNING_CONDITION]&secondarywarningthresholdvalue=[SECONDARY_WARNING_VALUE]&warningmessage=[WARNING_MESSAGE]&min_warningpolls=[MIN_WARNING_POLLS]&warningpolls=[MAX_WARNING_POLLS]&clearcondition=[CLEAR_CONDITION]&clearvalue=[CLEAR_VALUE]&clearconditionjoiner=[CLEAR_CONDITION_JOINER]&secondaryclearthresholdcondition=[SECONDARY_CLEAR_CONDITION]&secondaryclearthresholdvalue=[SECONDARY_CLEAR_VALUE]&clearmessage=[CLEAR_MESSAGE]&min_clearpolls=[MIN_CLEAR_POLLS]&clearpolls=[MAX_CLEAR_POLLS]&businessHourAssociatedToThreshold=[ASSOCIATE_BUSINESSS_HOUR]&businessType=[BUSINESS_HOUR_TYPE]&selectedBusinessHourID=[BUSINESS_HOUR_ID]
JSONでレスポンスを受けるには
http://[APM Host]:[APM Port]/AppManager/json/threshold?apikey=[API_KEY]&type=[TYPE]&thresholdname=[THRESHOLD_NAME]&thresholdType=[THRESHOLD_TYPE]&criticalcondition=[CRITICAL_CONDITION]&criticalvalue=[CRITICAL_VALUE]&criticalconditionjoiner=[CRITICAL_CONDITION_JOINER]&secondarycriticalthresholdcondition=[SECONDARY_CRITICAL_CONDITION]&secondarycriticalthresholdvalue=[SECONDARY_CRITICAL_VALUE]&criticalmessage=[CRITICAL_MESSAGE]&min_criticalpolls=[MIN_CRITICAL_POLLS]&criticalpolls=[MAX__CRITICAL_POLLS]&warningcondition=[WARNING_CONDITION]&warningvalue=[WARNING_VALUE]&warningconditionjoiner=[WARNING_CONDITION_JOINER]&secondarywarningthresholdcondition=[SECONDARY_WARNING_CONDITION]&secondarywarningthresholdvalue=[SECONDARY_WARNING_VALUE]&warningmessage=[WARNING_MESSAGE]&min_warningpolls=[MIN_WARNING_POLLS]&warningpolls=[MAX_WARNING_POLLS]&clearcondition=[CLEAR_CONDITION]&clearvalue=[CLEAR_VALUE]&clearconditionjoiner=[CLEAR_CONDITION_JOINER]&secondaryclearthresholdcondition=[SECONDARY_CLEAR_CONDITION]&secondaryclearthresholdvalue=[SECONDARY_CLEAR_VALUE]&clearmessage=[CLEAR_MESSAGE]&min_clearpolls=[MIN_CLEAR_POLLS]&clearpolls=[MAX_CLEAR_POLLS]&businessHourAssociatedToThreshold=[ASSOCIATE_BUSINESSS_HOUR]&businessType=[BUSINESS_HOUR_TYPE]&selectedBusinessHourID=[BUSINESS_HOUR_ID]
例
http://app-windows:59090/AppManager/xml/threshold?apikey=09eebdd6893db4d20e16b84dff6664f1&type=1&thresholdname=Sample Threshold&thresholdType=0&criticalcondition=GT&criticalvalue=10&criticalconditionjoiner=AND&secondarycriticalthresholdcondition=LT&secondarycriticalthresholdvalue=15&criticalmessage=criticalMessage&min_criticalpolls=2&criticalpolls=5&warningcondition=GT&warningvalue=5&warningconditionjoiner=AND&secondarywarningthresholdcondition=LT&secondarywarningthresholdvalue=10&warningmessage=warningMessage&min_warningpolls=2&warningpolls=5&clearcondition=GT&clearvalue=0&clearconditionjoiner=AND&secondaryclearthresholdcondition=LT&secondaryclearthresholdvalue=5&clearmessage=clearMessage&min_clearpolls=2&clearpolls=5&businessHourAssociatedToThreshold=enabled&businessType=1&selectedBusinessHourID=12345
可変しきい値の作成
管理者は次のAPIで、可変しきい値を作成できます。
構文
XMLでレスポンスを受けるには
http://[APM Host]:[APM Port]/AppManager/xml/threshold?apikey=[API_KEY]&type=[TYPE]&thresholdname=[THRESHOLD_NAME]&thresholdType=1&adaptiveBaseformulaType=[ADAPTIVE_BASE_FORMULA_TYPE]&adaptiveBaseWeek=[ADAPTIVE_Base Week ]&adaptiveHigherPercentage=[ADAPTIVE_Higher Percentage ]&criticalcondition=[CRITICAL_CONDITION]&criticalvalue=[CRITICAL_VALUE]&criticalconditionjoiner=[CRITICAL_CONDITION_JOINER]&secondarycriticalthresholdcondition=[SECONDARY_CRITICAL_CONDITION]&secondarycriticalthresholdvalue=[SECONDARY_CRITICAL_VALUE]&criticalmessage=[CRITICAL_MESSAGE]&min_criticalpolls=[MIN_CRITICAL_POLLS]&criticalpolls=[MAX_CRITICAL_POLLS]&warningcondition=[WARNING_CONDITION]&warningvalue=[WARNING_VALUE]&warningconditionjoiner=[WARNING_CONDITION_JOINER]&secondarywarningthresholdcondition=[SECONDARY_WARNING_CONDITION]&secondarywarningthresholdvalue=[SECONDARY_WARNING_VALUE]&warningmessage=[WARNING_MESSAGE]&min_warningpolls=[MIN_WARNING_POLLS]&warningpolls=[MAX_WARNING_POLLS]&clearcondition=[CLEAR_CONDITION]&clearvalue=[CLEAR_VALUE]&clearconditionjoiner=[CLEAR_CONDITION_JOINER]&secondaryclearthresholdcondition=[SECONDARY_CLEAR_CONDITION]&secondaryclearthresholdvalue=[SECONDARY_CLEAR_VALUE]&clearmessage=[CLEAR_MESSAGE]&min_clearpolls=[MIN_CLEAR_POLLS]&clearpolls=[MAX_CLEAR_POLLS]
JSONでレスポンスを受けるには
http://[APM Host]:[APM Port]/AppManager/json/threshold?apikey=[API_KEY]&type=[TYPE]&thresholdname=[THRESHOLD_NAME]&thresholdType=1&adaptiveBaseformulaType=[ADAPTIVE_BASE_FORMULA_TYPE]&adaptiveBaseWeek=[ADAPTIVE_Base Week ]&adaptiveHigherPercentage=[ADAPTIVE_Higher Percentage ]&criticalcondition=[CRITICAL_CONDITION]&criticalvalue=[CRITICAL_VALUE]&criticalconditionjoiner=[CRITICAL_CONDITION_JOINER]&secondarycriticalthresholdcondition=[SECONDARY_CRITICAL_CONDITION]&secondarycriticalthresholdvalue=[SECONDARY_CRITICAL_VALUE]&criticalmessage=[CRITICAL_MESSAGE]&min_criticalpolls=[MIN_CRITICAL_POLLS]&criticalpolls=[MAX__CRITICAL_POLLS]&warningcondition=[WARNING_CONDITION]&warningvalue=[WARNING_VALUE]&warningconditionjoiner=[WARNING_CONDITION_JOINER]&secondarywarningthresholdcondition=[SECONDARY_WARNING_CONDITION]&secondarywarningthresholdvalue=[SECONDARY_WARNING_VALUE]&warningmessage=[WARNING_MESSAGE]&min_warningpolls=[MIN_WARNING_POLLS]&warningpolls=[MAX_WARNING_POLLS]&clearcondition=[CLEAR_CONDITION]&clearvalue=[CLEAR_VALUE]&clearconditionjoiner=[CLEAR_CONDITION_JOINER]&secondaryclearthresholdcondition=[SECONDARY_CLEAR_CONDITION]&secondaryclearthresholdvalue=[SECONDARY_CLEAR_VALUE]&clearmessage=[CLEAR_MESSAGE]&min_clearpolls=[MIN_CLEAR_POLLS]&clearpolls=[MAX_CLEAR_POLLS]
例
http://app-windows:59090/AppManager/xml/threshold?apikey=09eebdd6893db4d20e16b84dff6664f1&type=1&thresholdname=Sample Adaptive Threshold&thresholdType=1&adaptiveBaseformulaType=0&adaptiveBaseWeek=Previous Week&adaptiveHigherPercentage=1&criticalcondition=GT&criticalvalue=10&criticalconditionjoiner=AND&secondarycriticalthresholdcondition=LT&secondarycriticalthresholdvalue=15&criticalmessage=criticalMessage&min_criticalpolls=2&criticalpolls=5&warningcondition=GT&warningvalue=5&warningconditionjoiner=AND&secondarywarningthresholdcondition=LT&secondarywarningthresholdvalue=10&warningmessage=warningMessage&min_warningpolls=2&warningpolls=5&clearcondition=GT&clearvalue=0&clearconditionjoiner=AND&secondaryclearthresholdcondition=LT&secondaryclearthresholdvalue=5&clearmessage=clearMessage&min_clearpolls=2&clearpolls=5
しきい値の更新
管理者は次のAPIで、しきい値を編集できます。
構文
XMLでレスポンスを受けるには
http://[APM Host]:[APM Port]/AppManager/xml/threshold?apikey=[API_KEY]&clearvalue=[CLEAR_VALUE]&criticalpolls=[CRITICAL_Polls ]&clearcondition=[CLEAR_CONDITION]&criticalmessage=updated message&clearmessage=&type=1&criticalcondition=GT&warningcondition=GT&warningmessage=&warningpolls=0&description=&newthresholdname=Sample Threshold&clearpolls=[ WARNING_POLLS]&thresholdid=[THRESHOLD_Id ] &warningvalue=[WARNING_VALUE]&criticalvalue=[CRITICAL_VALUE]&businessHourAssociatedToThreshold=[ASSOCIATE_BUSINESSS_HOUR]&businessType=[BUSINESS_HOUR_TYPE]&selectedBusinessHourID=[BUSINESS_HOUR_ID]
JSONでレスポンスを受けるには
http://[APM Host]:[APM Port]/AppManager/json/threshold?apikey=[API_KEY]&clearvalue=[CLEAR_VALUE]&criticalpolls=[CRITICAL_Polls ]&clearcondition=[CLEAR_CONDITION]&criticalmessage=updated message&clearmessage=&type=1&criticalcondition=GT&warningcondition=GT&warningmessage=&warningpolls=0&description=&newthresholdname=Sample Threshold&clearpolls=[ WARNING_POLLS]&thresholdid=[THRESHOLD_Id ] &warningvalue=[WARNING_VALUE]&criticalvalue=[CRITICAL_VALUE]&businessHourAssociatedToThreshold=[ASSOCIATE_BUSINESSS_HOUR]&businessType=[BUSINESS_HOUR_TYPE]&selectedBusinessHourID=[BUSINESS_HOUR_ID]
例
http://app-windows:59090/AppManager/xml/threshold?apikey=09eebdd6893db4d20e16b84dff6664f1&clearvalue=5&criticalpolls=0&clearcondition=GT&criticalmessage=updated message&clearmessage=&type=1&criticalcondition=GT&warningcondition=GT&warningmessage=&warningpolls=0&description=&newthresholdname=Sample Threshold&clearpolls=0&thresholdid=10001&warningvalue=5&criticalvalue=5&businessHourAssociatedToThreshold=enabled&businessType=1&selectedBusinessHourID=12345
しきい値の削除
管理者は次のAPIで、しきい値を削除できます。
構文
XMLでレスポンスを受けるには
http://[APM Host]:[APM Port]/AppManager/xml/threshold?apikey=[API_KEY]&thresholdid=[THRESHOLD_Id]&TO_DELETE=true
JSONでレスポンスを受けるには
http://[APM Host]:[APM Port]/AppManager/json/threshold?apikey=[API_KEY]&thresholdid=[THRESHOLD_Id]&TO_DELETE=true
例
http://app-windows:59090/AppManager/xml/threshold?apikey=09eebdd6893db4d20e16b84dff6664f1&thresholdid=10001,10003,10002,10000,&TO_DELETE=true
しきい値のリストアップ
管理者は次のAPIで、しきい値をリストアップできます。
構文
XMLでレスポンスを受けるには
http://[APM Host]:[APM Port]/AppManager/xml/threshold?apikey=[API_KEY]
JSONでレスポンスを受けるには
http://[APM Host]:[APM Port]/AppManager/json/threshold?apikey=[API_KEY]
例
http://app-windows:59090/AppManager/xml/threshold?apikey=09eebdd6893db4d20e16b84dff6664f1
サンプル レスポンス
<AppManager-response uri="/AppManager/xml/threshold"><result><response response-code="4000"><Threshold CLEARPOLLSTORETRY="Use global defaults" CLEARTHRESHOLDCONDITION="<=" CLEARTHRESHOLDMESSAGE="The Health of the response time is good" CLEARTHRESHOLDVALUE="1500" CRITICALPOLLSTORETRY="Use global defaults" CRITICALTHRESHOLDCONDITION=">" CRITICALTHRESHOLDMESSAGE="The Health of the response time is bad" CRITICALTHRESHOLDVALUE="2000" DESCRIPTION="This is a preconfigured Threshold for Response TIme" MINIMUMCLEARPOLLSTORETRY="Use global defaults" MINIMUMCRITICALPOLLSTORETRY="Use global defaults" MINIMUMWARNINGPOLLSTORETRY="Use global defaults" THRESHOLDID="3" THRESHOLDNAME="Response Time" WARNINGPOLLSTORETRY="Use global defaults" WARNINGTHRESHOLDCONDITION=">" WARNINGTHRESHOLDMESSAGE="The Health of Response ime has generated a warning" WARNINGTHRESHOLDVALUE="1500"/><Threshold CLEARPOLLSTORETRY="Use global defaults" CLEARTHRESHOLDCONDITION="<=" CLEARTHRESHOLDMESSAGE="The Connection Time is good" CLEARTHRESHOLDVALUE="1500" CRITICALPOLLSTORETRY="Use global defaults" CRITICALTHRESHOLDCONDITION=">" CRITICALTHRESHOLDMESSAGE="The Connection Time is high" CRITICALTHRESHOLDVALUE="2000" DESCRIPTION="This is a preconfigured Threshold for Connection Time" MINIMUMCLEARPOLLSTORETRY="Use global defaults" MINIMUMCRITICALPOLLSTORETRY="Use global defaults" MINIMUMWARNINGPOLLSTORETRY="Use global defaults" THRESHOLDID="4" THRESHOLDNAME="Connection Time" WARNINGPOLLSTORETRY="Use global defaults" WARNINGTHRESHOLDCONDITION=">" WARNINGTHRESHOLDMESSAGE="The Connection Time has generated a warning" WARNINGTHRESHOLDVALUE="1500"/><Threshold CLEARPOLLSTORETRY="Use global defaults" CLEARTHRESHOLDCONDITION="<=" CLEARTHRESHOLDMESSAGE="The Request per minute is good" CLEARTHRESHOLDVALUE="120" CRITICALPOLLSTORETRY="Use global defaults" CRITICALTHRESHOLDCONDITION=">" CRITICALTHRESHOLDMESSAGE="The Request per minute is high" CRITICALTHRESHOLDVALUE="240" DESCRIPTION="This is a preconfigured Threshold for Request per minute" MINIMUMCLEARPOLLSTORETRY="Use global defaults" MINIMUMCRITICALPOLLSTORETRY="Use global defaults" MINIMUMWARNINGPOLLSTORETRY="Use global defaults" THRESHOLDID="5" THRESHOLDNAME="Request per minute" WARNINGPOLLSTORETRY="Use global defaults" WARNINGTHRESHOLDCONDITION=">" WARNINGTHRESHOLDMESSAGE="The Request per minute has generated a warning" WARNINGTHRESHOLDVALUE="120"/></response></result></AppManager-response>