ChangeAlertMatchingApplication

「UOMポータル」の「サービス設定」から「アラート通知/対応設定」 を実施するのと同様に、設定を行えます。

GetAlertMatchingInfo(アラート通知/対応設定設定内容取得)で取得した結果をもとに、変更したいレコード、または新規レコードを設定します。

なお、変更の場合は、変更の必要がないカラム(ApplicationList)もリクエストパラメータに指定してください。

HTTPメソッドAction名称
POSTChangeAlertMatchingApplicationアラート通知/対応設定設定更新
1: リクエストパラメータ
パラメータタイプ必須意味最大文字数リクエスト例備考
ServiceCodeStringサービスコード15uom12345678ご契約のサービスコードを指定してください
ApplicationMailAdressAddString設定時メール送付先500iij-taro@example.jp

登録済みの「お問い合わせ連絡先グループ」以外に設定時にメールを送付したい場合は、「設定時メール送付先」にアドレスを入力します

MasterIdString設定者マスターID

15

SA9876543マスターIDを指定してください
Localeint表示言語10

下記のみ利用可能です

0:日本語

ApplicationList Array設定リスト設定情報を格納したリストです
UpdateTypeint設定タイプ10

以下から指定してください

0:追加

1:更新

2:削除

3:何もしない

※ 選択がない場合は設定更新対象になりません

AlertMatchingMasterIdintアラート通知/対応マスタID9123

設定レコードごとに割り当てられたマスタIDを指定してください。新規の受理待ち、受理の場合は指定不要です

MonitoringFlgString監視連携11

以下から指定してください

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

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

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

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

OperationNodeNameString運用対象ノード名115uom12345678_testnode_001

更新できません。GetAlertMatchingInfo(アラート通知/対応設定設定内容取得)で取得した情報を使用してください

OperationNodeTitle

String

運用対象ノード名称

128testnode_001

更新できません。GetAlertMatchingInfo(アラート通知/対応設定設定内容取得)で取得した情報を使用してください

MonitoringIdString監視ID3012345

監視連携の種類によって、以下を指定してください

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

監視IDの変更不可

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

先頭に"API-"を付与してください

(例)API-12345

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

メール取り込み設定で設定済の監視IDを指定してください

MonitoringTitleString監視名称64F-PING

監視連携の種類によって、以下を指定してください

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

監視名称の変更不可

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

任意の文字列指定可

(例)F-PING

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

メール取り込み設定で設定済のフィルタリング名称を指定してください

FirstContactAddressGroupString初報対応連絡先グループ11GAL00000006
  • 指定しない場合

    null( 何も入力しない)

  • アラート受付連絡先を指定する場合

    GAL00000006

  • 個別連絡先を指定する場合
    GetAddressCustMaster(障害・通知連絡先設定マスタ情報取得)で取得した情報を使用してください

ContactMethodString連絡方法11

以下から指定してください

0:なし

1:メール連絡

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

StandardProcedureManualName※1String標準運用手順書名

150

DNS Server 起動(Win2003)GetProcedureManualInfo(標準・拡張運用手順書情報取得)で取得した情報を使用してください
StandardProcedureManualId※1String標準運用手順書ID60400-uom12345678-P4323

GetProcedureManualInfo(標準・拡張運用手順書情報取得)で取得した情報を使用してください

ExtendedProcedureManualName※1String拡張運用手順書名150個別手順書1GetProcedureManualInfo(標準・拡張運用手順書情報取得)で取得した情報を使用してください
ExtendedProcedureManualId※1String拡張運用手順書ID60400-uom12345678-P0005GetProcedureManualInfo(標準・拡張運用手順書情報取得)で取得した情報を使用してください
NotesString補足1000memo 

※1: この4つのカラムの指定がない場合は、手順書の更新を行いません。

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

以下が返却されます

0:成功

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

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

ReceptionNumberString受付番号

設定を受け付けた番号が返却されます

(例)AUOM1303-0828

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

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

パラメータエラー

200

UOM Parameter Error

UOM parameter error occurred. Input 500 characters or less in ApplicationMailAdressAdd field.設定時メール送付先の最大文字数超過APPLICATION_EMAIL_CHARACTER_OVER
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Enter the Email Address in the proper email address format.設定時メール送付先のメールアドレス形式が不正NOT_EMAIL_ADDRESS_FORMAT
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. AlertMatchingMasterId is a required.アラート通知/対応マスタIDが不正ALERT_MASTER_ID_REQUIRED_FIELD
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Input 30 characters or less in MonitoringId's field.監視ID最大文字数超過MONITORING_ID_CHARACTER_OVER
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Some characters contained in the Monitoring ID are not allowed to enter. The available characters are half-width alpha numeric, hyphen (-), underscore (_) and dot (.).監視ID情報が不正NOT_SPECIFY_CHARACTER_MONITORING_ID
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. The specified MonitoringId is duplicated. Specify  the other one which is not duplicated.監視ID入力値重複MONITORING_ID_OVER_LAPPING
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Input 64 characters or less in MonitoringTitle's field.監視名称最大文字数超過MONITORING_TITLE_CHARACTER_OVER
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. MonitoringTitle is a required.監視名称変更不可MONITORING_TITLE_REQUIRED_FIELD
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Input 1000 characters or less in Notes field.最大文字数超過NOTES_CHARACTER_OVER
パラメータエラー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 Parameter ErrorUOM parameter error occurred. UpdateType is a required.設定状態情報が不正UPDATE_TYPE_REQUIRED_FIELD
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. UpdateType must be Update, Delete, or Nochange.設定タイプ不正UPDATE_TYPE_WRONG_FORMAT
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. You can not specify a new.設定タイプ指定数値不正UPDATE_TYPE_NEW_SPECIFIED
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. You can't submit when monitoring cooperation is on.監視連携変更不可UPDATE_TYPE_DOUBLE_SPECIFIED
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. The Details have not been updated.設定更新対象のレコードがないDETAILS_NOT_UPDATE
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. The records are old. Update to the latest records.設定更新対象レコードが削除・受理・受理待ちのため更新不可APPLICATION_REGISTER_CHECK
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. The number of ContactMethod is over the limit.連絡方法利用上限超過TEL_MAIL_LIMIT_OVER
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Input 100 items or less for updating and deleting.設定更新指定可能件数超過APPLICATION_MORE_UPDATABLE
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Specified parameters there is a problem, you can not apply.設定内容不正により設定不可APPLICATION_PARAMETER_ERROR
パラメータエラー200UOM Parameter ErrorMonitoringID which is linked to selected MasterID can't be changed.指定されたレコードの監視IDの更新不可MONITORING_ID_SPECIFIED_UPDATA
パラメータエラー200UOM Parameter ErrorThere isn't a record of selected MasterID and MonitoringId.指定されたマスタIDと監視IDの組み合わせが不正の為、削除不可MASTER_ID_MONITORING_ID_SET_NG
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Selected ProcedureManualId does not exist.指定された手順書IDが存在しないNO_EXIST_MANUAL_ID
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Wrong FirstContactAddressGroup is selected. Select Alert receiving group or Specific contact group.アラート受付連絡先以外の固定連絡先グループは指定不可SPECIFY_FIRST_REPORT_GROUP
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Selected FirstContactAddressGroup does not exist.指定された初報連絡先グループが存在しないNOT_EXIST_ADDRESS_GROUP
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Select 1: Mail, if FirstContactAddressGroup is Alert receiving group.指定された初報連絡先がアラート受付連絡先の時、連絡方法に1:メール以外は指定不可CONTACT_METHOD_ONLY_MAIL
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. ContactMethod must be one of the following patterns: 1) Email, 2) Email+Automatic Telephone, 3) Email+SNS or 4) Email+Automatic Telephone+SNS.指定された初報連絡先が個別連絡先の時、連絡方法に0:ハイフンは指定不可NOT_SPECIFY_CONTACT_METHOD
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. You cannot assign more than one procedure document to one MonitoringId.一つの監視IDに標準運用手順書と拡張運用手順書を同時に指定不可SPECIFY_ONLY_ONE_MANUAL
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Selecting Specific Manual is denied, because ContractId of Operation Target Node is Standard.対象レコードの契約区分が標準の時に拡張運用手順書は指定不可CANT_SPECIFY_SPECIFIC_MANUAL_STANDARD
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Selecting General Manual is denied, because ContractId of Operation Target Node is Standard.対象レコードの契約区分が標準の時に標準運用手順書に定型手順書を指定不可CANT_SPECIFY_GENERAL_MANUAL_STANDARD
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Selecting Specific Manual is denied, because ContractId of Operation Target Node is Standard Plus.対象レコードの契約区分が標準プラスの時に拡張運用手順書を指定不可CANT_SPECIFY_SPECIFIC_MANUAL_STANDARD_PLUS
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Selecting Manual is denied, because ContractId of Operation Target Node is Monitoring.対象レコードの契約区分が未契約(監視連携:監視)の時に手順書の指定不可CANT_SPECIFY_MANUAL_MONITORING
パラメータエラー200UOM Parameter Error

UOM parameter error occurred. You cannot select it since the account information which is set for the procedure document is not registered in the target node.

対象レコードのノードのアカウント情報が登録されていない場合、定型手順書の指定不可CANT_SPECIFY_ACCOUNT_INFO
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. FirstContactAddressGroup is not specified. Select it.
  • 初報連絡先を指定せずに連絡方法の指定不可
  • 初報連絡先を指定せずに手順書の指定不可
FIRST_REPORT_GROUP_REQUIRED_FIELD
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. It is denied, because Specific Procedure is selected as StandardProcedureManual.標準運用手順書に個別手順書を指定不可CANT_SPECIFY_SPECIFIC_MANUAL
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. It is denied, because Standard Procedure Document is selected as ExtendedProcedureManual.拡張運用手順書に標準手順書を指定不可CANT_SPECIFY_GENERAL_MANUAL
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Selected Monitoring ID which will be made at Mail Filtering Application does not exist.監視連携:メールのレコードに対して、メール取り込み設定で発行されていない監視IDは指定不可NO_EXIST_MAIL_FILTERING_ID
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Monitoring ID which was made at Mail Filtering Application can be selected only when Monitoring Link is "Mail".監視連携:メール以外のレコードに対してメール取り込み設定で発行された監視IDは指定不可CANT_SPECIFY_MAIL_FILTERING_ID
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Selecting same Monitoring ID, which was made at Mail Filtering Application, several times to node, which MonitoringFlg is Mail, is denied.監視連携:メールの同一ノードに対して重複する監視IDは指定不可SAME_MAIL_FILTERING_ID
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Wrong MonitoringFlg is selected.

監視連携を指定する値が不正

※ 以下を許容します

1: 監視コントロールパネル

2:API

3:メール

MONITORING_FLAG_WRONG_VALUE
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Only Specific Manual can be selected when MonitoringFlg is Mail.監視連携:メールのレコードに対して、個別手順書以外指定不可CANT_SPECIFY_OTHER_MANUAL
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Select MonitoringId which was made at Mail Filtering Application.監視連携:メールのレコードが複数存在する場合、監視IDにハイフンを指定不可MAIL_FILTERING_ID_REQUIRED_FIELD
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Delete Operation Target Node Application before delete Alert Support Link Application.対象ノードに紐付くすべてのレコード削除不可NOT_DELETE_LAST_ALERT_APPLICATION
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. You can not update operation target OperationNodeName.運用対象ノード名の更新不可MONITORING_COOPERATION_SPECIFIED_UPDATA
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. MonitoringId is required.監視IDに指定されている値が不正API_MONITORING_ID_REQUIRED_FIELD
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. You have to delete the node at Monitoring Control Panel, to delete MonitoringId which MonitoringFlg is On.監視連携:有のレコードを削除するには、監視コントロールパネルでノードを削除する必要があるMONITORING_COOPERATION_DELETE
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred.Filtering criteria have not been entered. Pick one that begins with "MAIL-".監視IDにハイフンを指定できるのは、「監視連携:メール」のレコードが1件の場合のみですCANT_SPECIFY_MONITORING_ID_HYPHEN
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred.In the case of a OperationNodeName having been changed, submit all the relating Update Applications at the same time.監視コントロールパネルのノード名更新、運用ノード設定後、アラート通知/対応設定を行う必要があるレコードが複数存在しますが、全件同時に設定されていませんUPDATE_APPLICATION_AT_ONCE
例外エラー200UOM Exception ErrorUOM system exception error occurred.UOM-API設備のシステム障害SYSTEM_EXCEPTION_ERROR
Webシステムエラー200UOM WebSystem ErrorUOM 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 = "ChangeAlertMatchingApplication"
PARAMS = '{
	"ServiceCode" : "uom12345678",
	"MasterId" : "SA9876543",
	"ApplicationMailAdressAdd" : "iij-taro@example.jp",
	"Locale" : "0",
	"ApplicationList" : [
		{ "UpdateType" : "1",
		"AlertMatchingMasterId" : "123",
		"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,
		"Notes" : "memo" }
	]
}'
レスポンス(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>ReceptionNumber</name>
									<value>AUOM1303-0828</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.Specified parameters there is a problem, you can not apply.</value>
					</member>
				</struct>
			</value>
		</param>
	</params>
</methodResponse>
レスポンス(JSON)
正常終了
{
	"ChangeAlertMatchingApplicationResponse": {
		"StatusCode":"200",
		"Result":{
			"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
			"ReceptionNumber":"AUOM1303-0828",
			"ResultCode":"0"
		}
	}
}
異常終了
{
	"ErrorResponse": {
		"Result":{
			"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
			"ErrorType":"UOMParameterError",
			"ErrorMessage":"UOM parameter error occurred.Specified parameters there is a problem, you can not apply."
		}
	}
}