GetAlertMatchingMaster

「UOMポータル」の「サービス設定」から「アラート通知/対応設定参照」を確認するのと同様に、現在の登録情報を取得（参照）できます。

HTTPメソッド	Action	名称
POST	GetAlertMatchingMaster	アラート通知/対応設定マスタ情報取得

1：リクエストパラメータ

パラメータ

タイプ

必須

意味

最大文字数

リクエスト例

備考

ServiceCode

String

○

サービスコード

15

uom12345678

ご契約のサービスコードを指定してください

MasterId

String

○

設定者マスターID

15

SA9876543

マスターIDを指定してください

Locale

int

○

表示言語

1

0

下記のみ利用可能です

0：日本語

2：レスポンス

正常終了

フィールド			タイプ	意味	備考
StatusCode			String	ステータスコード	成功時 200が返却されます
Result			−	結果
	RequestId		String	リクエストID	APIリクエストごとに割り当てられる一意なIDです
	ResultCode		String	結果コード	以下が返却されます 0：成功 1：異常（入力チェックエラー） 2：異常（システムエラー）
	ApplicationList		Array	設定リスト	設定情報を格納したリストです
		AlertMatchingMasterId	int	アラート通知/対応マスタID	設定レコードごとに割り当てられたマスタIDです。新規の受理待ちや受理等、マスタIDが発行されていないレコードは取得しません
		OperationNodeName	String	運用対象ノード名	（例）uom12345678_testnode_001
		OperationNodeTitle	String	運用対象ノード名称	（例）testnode_001
		MonitoringId	String	監視ID	監視連携の種類によって、以下が返却されます「1：監視コントロールパネルと連携して情報を取得」の場合（例）12345 「2：SendAlert（インシデントAPI）利用用に登録」の場合先頭に”API-”を付与して返却されます（例）API-12345 「3：メール取り込み利用用に登録」の場合メール取り込み設定で発行された監視IDが返却されます（例）MAIL-0001
		MonitoringTitle	String	監視名称	（例）F-PING
		FirstContactAddressGroup	String	発生時初報連絡先グループ	以下が返却されます指定していない場合 null アラート受付連絡先を指定した場合 GAL00000006 個別連絡先を指定した場合 GAL00000260 ※ 対象のサービスコードで障害・通知連絡先設定済みの連絡先グループIDが返却されます
		ContactMethod	String	発生時連絡方法	以下が返却されます 0：なし 1：メール連絡 2：メール連絡+電話連絡 3：メール連絡+SNS連絡 4：メール連絡+電話連絡+SNS連絡
		FirstContactAddressGroupWarning	String	警告時初報連絡先グループ	以下が返却されます指定していない場合 null アラート受付連絡先を指定した場合 GAL00000006 個別連絡先を指定した場合 GAL00000260 ※ 対象のサービスコードで障害・通知連絡先設定済みの連絡先グループIDが返却されます
		ContactMethodWarning	String	警告時連絡方法	以下が返却されます 0：なし 1：メール連絡 2：メール連絡+電話連絡 3：メール連絡+SNS連絡 4：メール連絡+電話連絡+SNS連絡
		FirstContactAddressGroupRecovery	String	復旧時初報連絡先グループ	以下が返却されます指定していない場合 null アラート受付連絡先を指定した場合 GAL00000006 個別連絡先を指定した場合 GAL00000260 ※ 対象のサービスコードで障害・通知連絡先設定済みの連絡先グループIDが返却されます
		ContactMethodRecovery	String	復旧時連絡方法	以下が返却されます 0：なし 1：メール連絡 2：メール連絡+電話連絡 3：メール連絡+SNS連絡 4：メール連絡+電話連絡+SNS連絡
		StandardProcedureManualName	String	標準運用手順書名	（例）DNS Server 起動（Win2003） ※ 指定がない場合はnullが返却されます
		StandardProcedureManualId	String	標準運用手順書ID	（例）400-uom12345678-P4323 ※ 指定がない場合はnullが返却されます
		ExtendedProcedureManualName	String	拡張運用手順書名	（例）個別手順書１ ※ 指定がない場合はnullが返却されます
		ExtendedProcedureManualId	String	拡張運用手順書ID	（例）400-uom12345678-P0001 ※ 指定がない場合はnullが返却されます
		ApplicationTakeEffectDatetime	DateTime	適用日時	形式：YYYY/MM/DD hh:mm:ss （例）2014/04/23 10:00:00
		Notes	String	補足	（例）memo

異常終了

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

3：エラーメッセージ

エラー	HTTP Status Code	ErrorType	ErrorMessage	説明	備考
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. ServiceCode is a required.	サービスコードが不正	SERVICE_CODE_REQUIRED_FIELD
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. MasterID is a required.	マスターIDが不正	MASTER_ID_REQUIRED_FIELD
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. There is no MasterID.	マスターIDが登録されていない	MASTER_ID_NONE
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. There is no UOM contract.	UOMの契約が存在しない	UOM_CONTRACT_NONE
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. There is no monitoring contract.	UOMの監視契約が存在しない	MONITORING_CONTRACT_NONE
例外エラー	200	UOM Exception Error	UOM system exception error occurred.	UOM-API設備のシステム障害	SYSTEM_EXCEPTION_ERROR
Webシステムエラー	200	UOM WebSystem Error	UOM Web System error occurred.	その他のシステム障害

4：警告メッセージ

なし

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 = "GetAlertMatchingMaster"
PARAMS = '{
	"ServiceCode" : "uom12345678",
	"MasterId" : "SA9876543",
	"Locale" : "0"
}'

レスポンス（XML）

正常終了
<?xml version="1.0" encoding="UTF-8"?>
<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>ApplicationList</name>
									<value>
										<array>
											<data>
												<value>
													<struct>
														<member>
															<name>AlertMatchingMasterId</name>
															<value>123</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>FirstContactAddressGroupWarning</name>
															<value>GAL00000006</value>
														</member>
														<member>
															<name>ContactMethodWarning</name>
															<value>1</value>
														</member>
														<member>
															<name>FirstContactAddressGroupRecovery</name>
															<value>GAL00000006</value>
														</member>
														<member>
															<name>ContactMethodRecovery</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>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>FirstContactAddressGroupWarning</name>
															<value>GAL00000006</value>
														</member>
														<member>
															<name>ContactMethodWarning</name>
															<value>1</value>
														</member>
														<member>
															<name>FirstContactAddressGroupRecovery</name>
															<value>GAL00000006</value>
														</member>
														<member>
															<name>ContactMethodRecovery</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>

異常終了
<?xml version="1.0" encoding="UTF-8"?>
<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）

正常終了
{
	"GetAlertMatchingMasterResponse": {
		"StatusCode":"200",
		"Result":{
			"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
			"ResultCode":"0",
			"ApplicationList":[
				{ "AlertMatchingMasterId":"123",
				"OperationNodeName":"uom12345678_testnode_001",
				"OperationNodeTitle":"testnode_001",
				"MonitoringId":"12345",
				"MonitoringTitle":"F-PING",
				"FirstContactAddressGroup":"GAL00000006",
				"ContactMethod":"1",
				"FirstContactAddressGroupWarning":"GAL00000006",
				"ContactMethodWarning":"1",
				"FirstContactAddressGroupRecovery":"GAL00000006",
				"ContactMethodRecovery":"1",
				"StandardProcedureManualName":"DNS Server 起動(Win2003) ",
				"StandardProcedureManualId":"400-uom12345678-P4323",
				"ExtendedProcedureManualName":null,
				"ExtendedProcedureManualId":null,
				"ApplicationTakeEffectDatetime":"2014/04/23 10:00:00",
				"Notes":"memo" },
				{ "AlertMatchingMasterId":"456",
				"OperationNodeName":"uom12345678_testnode_002",
				"OperationNodeTitle":"testnode_002",
				"MonitoringId":"98765",
				"MonitoringTitle":"CPU",
				"FirstContactAddressGroup":"GAL00000006",
				"ContactMethod":"1",
				"FirstContactAddressGroupWarning":"GAL00000006",
				"ContactMethodWarning":"1",
				"FirstContactAddressGroupRecovery":"GAL00000006",
				"ContactMethodRecovery":"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."
		}
	}
}

公開
マニュアル一覧へ

ご契約者向け
マニュアル一覧へ

GetAlertMatchingMaster

1：リクエストパラメータ

2：レスポンス

正常終了

異常終了

3：エラーメッセージ

4：警告メッセージ

5：制限

6：サンプル（REST形式）

config.rb

レスポンス（XML）

レスポンス（JSON）

GetAlertMatchingMaster

1： リクエストパラメータ

2： レスポンス

正常終了

異常終了

3： エラーメッセージ

4：警告メッセージ

5：制限

6：サンプル（REST形式）

config.rb

レスポンス（XML）

レスポンス（JSON）

1：リクエストパラメータ

2：レスポンス

3：エラーメッセージ