GetAlertMatchingInfo

「UOMポータル」の「サービス設定」で「アラート通知/対応設定」を実施するのと同様に、現在の設定情報を取得できます。

ChangeAlertMatchingApplication(アラート通知/対応設定設定更新)実行前に、更新可能な設定リストを確認するために利用します。

HTTPメソッドAction名称
POSTGetAlertMatchingInfoアラート通知/対応設定設定内容取得
1: リクエストパラメータ
パラメータタイプ必須意味最大文字数リクエスト例備考
ServiceCodeStringサービスコード15uom12345678ご契約のサービスコードを指定してください
MasterIdString設定者マスターID15SA9876543マスターIDを指定してください
Localeint表示言語10

下記のみ利用可能です

0:日本語

2: レスポンス
正常終了
フィールドタイプ意味備考
StatusCodeStringステータスコード成功時 200が返却されます
Result 結果 
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
ResultCodeString結果コード

以下が返却されます

0:成功

1:異常(入力チェックエラー)

2:異常(システムエラー)

WarningMessageList Array警告メッセージリスト警告メッセージを格納したリストです
WarningMessageCodeString警告メッセージコード警告メッセージのコードです
WarningMessageString警告メッセージ警告メッセージです
ApplicationList Array設定リスト設定情報を格納したリストです
AlertMatchingMasterIdintアラート通知/対応マスタID設定レコードごとに割り当てられたマスタIDです
ApplicationStateString設定状態

以下が返却されます

00:設定可能

10:受理待ち

20:受理

25:設定不可

ApplicationDetailsString設定内容

以下が返却されます

10:削除

空:その他

DeleteTargetString削除対象

以下が返却されます

00:新規

01:対象ノードが削除されている

※ メール取り込みオプション契約が削除/解約された場合は01が返却されます

MonitoringFlgString監視連携

以下が返却されます

0:監視コントロールパネルと連携していない

1:監視コントロールパネルと連携して情報を取得

2:SendAlert( インシデントAPI)利用用に登録

3:メール取り込み利用用に登録

OperationNodeNameString運用対象ノード名

先頭に”サービスコード_”を付与して返却されます

(例)uom12345678_testnode_001

OperationNodeTitleString運用対象ノード名称(例)testnode_001
MonitoringIdString監視ID

監視連携の種類によって、以下が返却されます

「1:監視コントロールパネルと連携して情報を取得」の場合

(例)12345

「2:SendAlert(インシデントAPI)利用用に登録」の場合

(例)API-12345

※ 先頭に”API-”を付与して返却されます

「3:メール取り込み利用用に登録」の場合

(例)MAIL-0001

※ メール取り込み設定で発行された監視IDが返却されます

MonitoringTitleString監視名称

(例)F-PING

※ 監視連携「2:SendAlert(インシデントAPI)利用用に登録」、及び監視連携「3:メール取り込み利用用に登録」の新規設定の場合、監視名称はnullで返却されます

FirstContactAddressGroupString初報対応連絡先グループ

以下が返却されます

  • 指定していない場合
    null
  • アラート受付連絡先を指定した場合
    GAL00000006
  • 個別連絡先を指定した場合
    GAL00000260

※ 対象のサービスコードで障害・通知連絡先設定済みの連絡先グループIDが返却されます

ContactMethodString連絡方法

以下が返却されます

0:なし

1:メール連絡

2:メール連絡+電話連絡

StandardProcedureManualNameString標準運用手順書名

(例)DNS Server 起動(Win2003)

※ 指定がない場合はnullが返却されます

StandardProcedureManualIdString標準運用手順書ID

(例)400-uom12345678-P4323

※ 指定がない場合はnullが返却されます

ExtendedProcedureManualNameString拡張運用手順書名

(例)個別手順書1

※ 指定がない場合はnullが返却されます

ExtendedProcedureManualIdString拡張運用手順書ID

(例)400-uom12345678-P0001

※ 指定がない場合はnullが返却されます

ApplicationTakeEffectDatetimeDateTime適用日時

形式:YYYY/MM/DD hh:mm:ss

(例)2014/04/23 10:00:00

NotesString補足(例)memo

異常終了
フィールドタイプ意味備考
Result 結果 
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
ErrorTypeStringエラータイプ異常終了となったエラータイプです
ErrorMessageStringエラーメッセージ異常終了となったエラーメッセージです

3: エラーメッセージ
エラーHTTP Status CodeErrorTypeErrorMessage説明備考

パラメータエラー

200UOM Parameter ErrorUOM parameter error occurred. ServiceCode is a required.サービスコードが不正SERVICE_CODE_REQUIRED_FIELD

パラメータエラー

200UOM Parameter ErrorUOM parameter error occurred. MasterID is a required.マスターIDが不正MASTER_ID_REQUIRED_FIELD

パラメータエラー

200UOM Parameter ErrorUOM parameter error occurred. There is no MasterID.マスターIDが登録されていない

MASTER_ID_NONE

パラメータエラー

200UOM Parameter ErrorUOM parameter error occurred. There is no UOM contract.UOMの契約が存在しないUOM_CONTRACT_NONE

パラメータエラー

200UOM Parameter ErrorUOM parameter error occurred. There is no monitoring contract.UOMの監視契約が存在しないMONITORING_CONTRACT_NONE

例外エラー

200UOM Exception ErrorUOM system exception error occurred.UOM-API設備のシステム障害SYSTEM_EXCEPTION_ERROR
Webシステムエラー200UOM WebSystem ErrorUOM Web System error occurred.その他のシステム障害 
4:警告メッセージ
警告対象HTTP Status CodeWarning Message CodeWarningMessage説明備考
契約区分の変更200CONTRACT_CHANGED_ADVANCEDSelecting Specific Procedure Document is denied, because Contract of Operation is changed.

契約区分が拡張→標準/標準プラスに変更されたので、個別手順書は指定できません

 
契約区分の変更200CONTRACT_CHANGED_STANDARD_PLUSSelecting Regular Procedure is denied, because Contract of Operation is changed.

契約区分が標準プラス→標準に変更されたので、定型手順書は指定できません

 
契約区分の変更200CONTRACT_CHANGED_MONITORINGContractId of Operation Target Node does not exist. Select only FirstContactAddressGroup when Alert Support Link Application.契約区分が標準・標準プラス・拡張のいずれかから未契約に変更されたので、初報連絡先のみ選択できます 
手順書削除200PROCEDURE_MANUAL_DELETESelected procedure document is deleted.指定されていた手順書が削除されています 
メール取り込みオプション解約200NO_MAIL_CONTRACT

Selecting Monitoring ID which was made at Mail Filtering Application is denied, because Contract of Email taking-in Option does not exist. Delete Alert Support Link Application.

メール取り込みオプション契約が解約されたため、監視連携:メールのレコードを削除してください

 
メール取り込み設定で発行された監視ID削除

200

MAIL_FILTERING_ID_DELETED

Selected Monitoring ID which was made at Mail Filtering Application is deleted. Select other MonitoringId which was made at Mail Filtering Application or delete Alert Support Link Application.

メール取り込み設定で発行された監視IDが削除されたので、新しい監視IDを指定するか、削除設定をしてください

 
連絡先削除

200

FIRST_REPORT_GROUP_DELETEFirstContactAddressGroup has been deleted.初報連絡先に設定していた連絡先が削除されました 
レコードが存在しない200NO_RECORDS_WARNNINGIf you are using the notification function of Monitoring Service, configure the monitoring information with Monitoring Control Panel before submitting the Operation Target Node Application. If you are using the API, submit the Operation Target Node Application.監視サービスで通知機能をご利用の場合は、監視コントロールパネルで監視情報を設定後、運用ノード設定を行ってください。APIをご利用の場合は、運用ノード設定を行ってください 
監視コントロールパネルでノード更新200CHANGE_NODE_NAME_BEFORE_APPLYThe OperationNodeName has been updated in the Monitoring Control Panel. Process the Operation Target Node Application first, and then resubmit the corresponding application.監視コントロールパネルで運用対象ノード名が更新されました。運用ノード設定後、再度設定を行ってください 
監視コントロールパネルでノード削除200DELETE_NODE_BEFORE_APPLYThe Monitoring Target Node has been deleted in the Monitoring Control Panel. Process the Operation Target Node Application first, and then resubmit the corresponding application.監視コントロールパネルで監視対象ノードが削除されています。運用ノード設定後、再度設定を行ってください 
監視ID削除200MONITORING_ID_DELETEMonitoringId has been removed. Please do the delete request.監視IDが削除されました。削除設定を行ってください 
拡張運用手順書の契約区分変更200CONTRACT_CHANGED_STANDARDYou cannot specify ExtendedProcedureManual since Advanced Operation is not set for the Contract Category.契約区分に拡張運用が設定されていないため、拡張運用手順書の指定はできません 
ノード名の更新200CHANGE_NODE_NAMEThe OperationNodeName has been updated in the Monitoring Control Panel. The corresponding application should be resubmitted.監視コントロールパネルで運用対象ノード名が更新されました。再度設定を行ってください 
5:制限

なし

6:サンプル(REST形式)
config.rb
##
## 個別設定
##

# API のキー設定
IIJAPI_ACCESS_KEY = "1234567890ABCDEFGHIJ"
IIJAPI_SECRET_KEY = "1234567890ABCDEFGHIJabcdefghijklmnopqr+1"

##
## API の基本設定
##

# API の ENDPOINT 設定
IIJAPI_ENDPOINT = https://uom.api.iij.jp
IIJAPI_SSL_NO_VERIFY = true

# API バージョンの設定
APIVERSION = "20150912"

# Content-Type の設定
CONTENTTYPEVALUE = "application/json; charset=utf-8"

# アラート通知/対応設定設定内容取得
# 以下の内容は、適宜修正してください。
ACTION = "GetAlertMatchingInfo"
PARAMS = '{
	"ServiceCode" : "uom12345678",
	"MasterId" : "SA9876543",
	"Locale" : "0"
}'
レスポンス(XML)
正常終了
<methodResponse xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">
	<params>
		<param>
			<value>
				<struct>
					<member>
						<name>StatusCode</name>
						<value>200</value>
					</member>
					<member>
					<name>Result</name>
						<value>
							<struct>
								<member>
									<name>RequestId</name>
									<value>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</value>
								</member>
								<member>
									<name>ResultCode</name>
									<value>0</value>
								</member>
								<member>
									<name>WarningMessageList</name>
									<value>
										<array>
											<data>
												<value>
													<struct>
														<member>
															<name>WarningMessageCode</name>
															<value>WARNING</value>
														</member>
														<member>
															<name>WarningMessage</name>
															<value>This is the warning message for the test.</value>
														</member>
													</struct>
												</value>
												<value>
													<struct>
														<member>
															<name>WarningMessageCode</name>
															<value>WARNING</value>
														</member>
														<member>
															<name>WarningMessage</name>
															<value>This is the warning message for the test.</value>
														</member>
													</struct>
												</value>
											</data>
										</array>
									</value>
								</member>
								<member>
									<name>ApplicationList</name>
									<value>
										<array>
											<data>
												<value>
													<struct>
														<member>
															<name>AlertMatchingMasterId</name>
															<value>123</value>
														</member>
														<member>
															<name>ApplicationState</name>
															<value>00</value>
														</member>
														<member>
															<name>ApplicationDetails</name>
															<value></value>
														</member>
														<member>
															<name>DeleteTarget</name>
															<value>00</value>
														</member>
														<member>
															<name>MonitoringFlg</name>
															<value>1</value>
														</member>
														<member>
															<name>OperationNodeName</name>
															<value>uom12345678_testnode_001</value>
														</member>
														<member>
															<name>OperationNodeTitle</name>
															<value>testnode_001</value>
														</member>
														<member>
															<name>MonitoringId</name>
															<value>12345</value>
														</member>
														<member>
															<name>MonitoringTitle</name>
															<value>F-PING</value>
														</member>
														<member>
															<name>FirstContactAddressGroup</name>
															<value>GAL00000006</value>
														</member>
														<member>
															<name>ContactMethod</name>
															<value>1</value>
														</member>
														<member>
															<name>StandardProcedureManualName</name>
															<value>DNS Server 起動(Win2003) </value>
														</member>
														<member>
															<name>StandardProcedureManualId</name>
															<value>400-uom12345678-P4323</value>
														</member>
														<member>
															<name>ExtendedProcedureManualName</name>
															<value></value>
														</member>
														<member>
															<name>ExtendedProcedureManualId</name>
															<value></value>
														</member>
														<member>
															<name>ApplicationTakeEffectDatetime</name>
															<value>2014/04/23 10:00:00</value>
														</member>
														<member>
															<name>Notes</name>
															<value>memo</value>
														</member>
													</struct>
												</value>
												<value>
													<struct>
														<member>
															<name>AlertMatchingMasterId</name>
															<value>456</value>
														</member>
														<member>
															<name>ApplicationState</name>
															<value>00</value>
														</member>
														<member>
															<name>ApplicationDetails</name>
															<value></value>
														</member>
														<member>
															<name>DeleteTarget</name>
															<value>00</value>
														</member>
														<member>
															<name>MonitoringFlg</name>
															<value>1</value>
														</member>
														<member>
															<name>OperationNodeName</name>
															<value>uom12345678_testnode_002</value>
														</member>
														<member>
															<name>OperationNodeTitle</name>
															<value>testnode_002</value>
														</member>
														<member>
															<name>MonitoringId</name>
															<value>98765</value>
														</member>
														<member>
															<name>MonitoringTitle</name>
															<value>CPU</value>
														</member>
														<member>
															<name>FirstContactAddressGroup</name>
															<value>GAL00000006</value>
														</member>
														<member>
															<name>ContactMethod</name>
															<value>1</value>
														</member>
														<member>
															<name>StandardProcedureManualName</name>
															<value>DNS Server 起動(Win2003) </value>
														</member>
														<member>
															<name>StandardProcedureManualId</name>
															<value>400-uom12345678-P4323</value>
														</member>
														<member>
															<name>ExtendedProcedureManualName</name>
															<value></value>
														</member>
														<member>
															<name>ExtendedProcedureManualId</name>
															<value></value>
														</member>
														<member>
															<name>ApplicationTakeEffectDatetime</name>
															<value>2014/04/23 10:00:00</value>
														</member>
														<member>
															<name>Notes</name>
															<value>memo</value>
														</member>
													</struct>
												</value>
											</data>
										</array>
									</value>
								</member>
							</struct>
						</value>
					</member>
				</struct>
			</value>
		</param>
	</params>
</methodResponse>

異常終了
<methodResponse xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">
	<params>
		<param>
			<value>
				<struct>
					<member>
						<name>StatusCode</name>
						<value>400</value>
					</member>
					<member>
						<name>RequestId</name>
						<value>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</value>
					</member>
					<member>
						<name>ErrorType</name>
						<value>UOMParameterError</value>
					</member>
					<member>
						<name>ErrorMessage</name>
						<value>UOM parameter error occurred. Service code is a required field.</value>
					</member>
				</struct>
			</value>
		</param>
	</params>
</methodResponse>
レスポンス(JSON)
正常終了
{
	"GetAlertMatchingInfoResponse": {
		"StatusCode":"200",
		"Result":{
			"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
			"ResultCode":"0",
			"WarningMessageList":[
				{ "WarningMessageCode":"WARNING",
				"WarningMessage":"This is the warning message for the test."},
				{ "WarningMessageCode":"WARNING",
				"WarningMessage":"This is the warning message for the test."}
			],
			"ApplicationList":[
				{ "AlertMatchingMasterId":"123",
				"ApplicationState":"00",
				"ApplicationDetails":"",
				"DeleteTarget":"00",
				"MonitoringFlg":"1",
				"OperationNodeName":"uom12345678_testnode_001",
				"OperationNodeTitle":"testnode_001",
				"MonitoringId":"12345",
				"MonitoringTitle":"F-PING",
				"FirstContactAddressGroup":"GAL00000006",
				"ContactMethod":"1",
				"StandardProcedureManualName":"DNS Server 起動(Win2003) ",
				"StandardProcedureManualId":"400-uom12345678-P4323",
				"ExtendedProcedureManualName":null,
				"ExtendedProcedureManualId":null,
				"ApplicationTakeEffectDatetime":"2014/04/23 10:00:00",
				"Notes":"memo" },
    			{ "AlertMatchingMasterId":"456",
				"ApplicationState":"",
				"ApplicationDetails":"00",
				"DeleteTarget":"00",
				"MonitoringFlg":"1",
				"OperationNodeName":"uom12345678_testnode_002",
				"OperationNodeTitle":"testnode_002",
				"MonitoringId":"98765",
				"MonitoringTitle":"CPU",
				"FirstContactAddressGroup":"GAL00000006",
				"ContactMethod":"1",
				"StandardProcedureManualName":"DNS Server 起動(Win2003) ",
				"StandardProcedureManualId":"400-uom12345678-P4323",
				"ExtendedProcedureManualName":null,
				"ExtendedProcedureManualId":null,
				"ApplicationTakeEffectDatetime":"2014/04/23 10:00:00",
				"Notes":"memo" }
			]
		}
	}
}
異常終了
{
	"ErrorResponse": {
		"Result":{
			"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
			"ErrorType":"UOMParameterError",
			"ErrorMessage":"UOM parameter error occurred. Service code is a required field."
		}
	}
}