公開
マニュアル一覧へ

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

IIJ統合運用管理サービス API Reference

ChangeOperationNodeApplication

「UOMポータル」の「サービス設定」から「運用ノード設定」 を実施するのと同様に、設定を行えます。

GetOperationNodeInfo（運用ノード設定設定内容取得）で取得した結果をもとに、変更したいレコード、または新規レコードを設定します。

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

HTTPメソッドAction名称
POSTChangeOperationNodeApplication運用ノード設定設定更新
1： リクエストパラメータ
パラメータタイプ必須意味最大文字数リクエスト例備考
ServiceCodeString○サービスコード15uom12345678ご契約のサービスコードを指定してください
IsSendMailString−設定時メール送付有無1 1

登録済みの「お問い合わせ連絡先グループ」以外への設定時メール送付有無を指定してください

  • 1：設定時メールを送信

  • 0：設定時メールを送信しない

ApplicationMailAdressAddString○設定時メール送付先500iij-taro@example.jp
  • 登録済みの「お問い合わせ連絡先グループ」以外に設定時のメールを送付したい場合は、「設定時メール送付先」にアドレスを入力します
  • IsSendMail（設定時メール送付有無）の指定をせずにApplicationMailAdressAdd（設定時メール送付先）を指定した場合は、設定時メールが送付されます
MasterIdString○設定者マスターID15SA9876543マスターIDを指定してください
Localeint○表示言語10

下記のみ利用可能です

0：日本語

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

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

  • 0：追加
  • 1：更新
  • 2：削除
  • 3：何もしない

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

OperationNodeMasterIdint○運用ノードマスタID9123

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

MonitoringFlgString○監視連携10

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

  • 0：監視コントロールパネルと連携していない
  • 1：監視コントロールパネルと連携して情報を取得
  • 2：SendAlert （インシデントAPI）利用用に登録
OperationNodeNameString○運用対象ノード名115uom12345678_testnode_001先頭に”サービスコード_”を付与してください
OperationNodeTitleString○運用対象ノード名称

128

testnode_001ノード名称を指定してください
CategoryIdString○種別200

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

  • 00：Windows
  • 10：unix
  • 15：ESXi
  • 20：VIP
  • 30：コンソール
  • 40：NW機器（L2,L3）
  • 50：NW機器（FW,LB）
  • 60：URL
  • 70：物理機器
  • 75：マネージドモニタリング for Zabbix
  • 80：その他
IpAddressString○IPアドレス64192.0.2.130
  • 監視連携が「0：監視コントロールパネルと連携していない」の場合
    新規指定、変更ができます
  • 監視連携が「1：監視コントロールパネルと連携して情報を取得」の場合
    新規指定、変更はできません
  • 監視連携が「2：SendAlert（ インシデントAPI）利用用に登録」の場合
    新規指定のみ可能です
ContractIdString○契約区分10

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

  • 0：標準運用契約
  • 1：標準プラスオプション契約
  • 2：拡張運用契約
  • 3：未契約

※ 契約数を超えて指定することはできません

※ 種別が｢20：VIP｣、「30：コンソール」、｢60：URL｣、｢80:その他｣の場合は指定しないでください

NotesString○補足1000memo
MonitoringLinkageString−監視情報取得元12

マネージドモニタリング for Zabbixを契約している場合、以下から指定してください

  • 0：監視コントロールパネルで設定
  • 1：サービス設定で設定
  • 2：Zabbixで設定
HostIdString−ホストID2512345

マネージドモニタリング for Zabbixを契約している場合、指定してください

  • 監視情報取得元が「2：Zabbixで設定」の場合は、ホストIDを入力します
  • 監視情報取得元が「2：Zabbixで設定」以外の場合は、空白とします
2： レスポンス
正常終了
フィールドタイプ意味備考
StatusCodeStringステータスコード成功時 200が返却されます
Result
−結果
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
ResultCodeString結果コード

以下が返却されます

  • 0：成功
  • 1：異常（入力チェックエラー）
  • 2：異常（システムエラー）
ReceptionNumberString受付番号

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

（例）UUOM1303-0828

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

3： エラーメッセージ
エラーHTTP Status CodeErrorTypeErrorMessage説明備考
パラメータエラー200UOM Parameter ErrorUOM 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. OperationNodeMasterId is a required.運用ノードマスタIDが不正NODE_MASTER_ID_REQUIRED_FIELD
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. OperationNodeName for the operation target is a required.運用対象ノード名情報が不正OPERATION_NODE_REQUIRED_FIELD
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Input 38 characters or less in OperationNodeName.運用対象ノード名最大文字数超過OPERATION_NODE__CHARACTER_OVER
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Some characters contained in the OperationNodeName are not allowed to enter. The available characters are half-width alpha numeric, hyphen (-), underscore (_) and dot (.).運用対象ノード名入力形式不正NOT_SPECIFY_CHARACTER_NODE
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. You can not update operation target contains.運用対象ノード名変更不可OPERATION_NODE_API_SPECIFIED
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. The OperationNodeName is duplicated.運用対象ノード名入力値重複OPERATION_NODE_OVER_LAPPING
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Input 128 characters or less in OperationNodeTitle.運用対象ノード名称最大文字数超過NODE_TITLE_CHARACTER_OVER
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. IpAddress is a required.IPアドレス未指定IP_ADDRESS_REQUIRED_FIELD
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Input 128 characters or less in IpAddress's field.IPアドレス最大文字数超過IP_ADDRESSS_CHARACTER_OVER
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Specify IpAddress in IPv4 or IPv6 format.IPアドレス不正IP_ADDRESS_WRONG_FORMAT_NODE
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. The IpAddress of Operation Target Node has already been registered. Specify the correct IpAddress which has no duplicate.IPアドレス入力値重複IP_ADDRESS_ALREADY_REGISTED_NODE
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Don't input IP address when it's URL, physical equipment, and other.IPアドレス入力不可NOT_IP_ADDRESS
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. CategoryId is a required.種別指定未入力TYPE_REQUIRED_FIELD
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Not specified value.種別指定内容不正TYPE_VALUE_CHECK
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. The value of the provision has not been set in ContractId.契約区分指定不正CONTRACT_SECTION_SPECIFIED
パラメータエラー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 cannot change the configuration of Monitoring Cooperation.監視連携での指定不可UPDATE_TYPE_DOUBLE_SPECIFIED
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. You can not specify a new.更新タイプ0：新規設定でマスタIDが指定されているためUPDATE_TYPE_NEW_SPECIFIED
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. It exceeds the allowed number of contracts for the Standard Operation. Change the MonitoringFlg with correct one and reapply it with the acceptable range of the number.標準契約件数超過NORMAL_CONTRACT_POSSIBLE_NUMBER
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. It exceeds the allowed number of contracts for the Standard Plus. Change the MonitoringFlg with correct one and reapply it with the acceptable range of the number.標準プラス契約数超過NORMAL_PLUS_CONTRACT_POSSIBLE_NUMBER
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. It exceeds the allowed number of contracts for the Advanced Operation. Change the ConMonitoringFlg with correct one and reapply it with the acceptable range of the number.拡張契約件数超過ADVANCEDL_CONTRACT_POSSIBLE_NUMBER
パラメータエラー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 Details have not been updated.設定更新対象のレコードがないDETAILS_NOT_UPDATE
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. There is no change you can apply.設定可能なレコードが存在しないNO_ITEM_IS_READY
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Specified parameters there is a problem, you can not apply.設定内容不正により申請不可APPLICATION_PARAMETER_ERROR
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Input 100 items or less for updating and deleting.1度に100件を超える設定は不可APPLICATION_MORE_UPDATABLE
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. You can't change IpAddress if MonitoringFlg is On or API.IPアドレスの変更不可IP_ADDRESS_SPECIFIED_UPDATA
パラメータエラー200UOM Parameter Error

UOM 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. Hyphen is selected as CategoryId. Select suitable CategoryId.レコード種別に90（ハイフン）指定不可CATEGORY_ID_WRONG_VALUE
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Wrong MonitoringFlg is selected.監視連携に0:無、1: 有、2:API、3:メール以外を指定MONITORING_FLAG_WRONG_VALUE
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred.You cannot manage this without the Standard Operation contract. Specify a ContractId that is available to you.標準運用契約がない状態で、契約区分に0（標準）が指定されているCANT_APPLY_STANDARD_OPERATION
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred.You cannot manage this without the Standard Plus option contract. Specify a ContractId that is available to you.標準プラスオプション契約がない状態で、契約区分に1（標準プラス）が指定されているCANT_APPLY_STANDARD_PLUS
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred.You cannot manage this without the Advanced Operation contract. Specify a ContractId that is available to you.拡張運用契約がない状態で、契約区分に2（拡張）が指定されているCANT_APPLY_ADVANCED
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. There are Alert Support Link Applications having the same IpAddress. Specify another IpAddress or delete the obsolete applications.「運用ノード設定」で削除済みのノードに紐付く「アラート通知/対応設定」が存在する状態で、削除したノードと同一IPアドレスで新規の「運用ノード設定」をしようとしたCANT_SPECIFY_IP_ADDRESS
パラメータエラー200UOM Parameter Error

UOM parameter error occurred.
You cannot specify 0 in the first octet of the IpAddress.

IPアドレスの第1オクテットに0が指定されているFIRST_ZERO_IP_ADDRESS
例外エラー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 = "ChangeOperationNodeApplication"
PARAMS = '{
	"ServiceCode" : "uom12345678",
	"MasterId" : "SA9876543",
	"ApplicationMailAdressAdd" : "iij-taro@example.jp",
	"Locale" : "0",
	"ApplicationList" : [
		{ "UpdateType" : "2",
		"OperationNodeMasterId" : "123",
		"MonitoringFlg" : "1",
		"OperationNodeName" : "uom12345678_testnode_001",
		"OperationNodeTitle" : "testnode_001",
		"CategoryId" : "00",
		"IpAddress" : "192.0.2.130",
		"ContractId" : "0",
		"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>ReceptionNumber</name>
									<value>UUOM1303-0828</value>
								</member>
								<member>
									<name>ResultCode</name>
									<value>0</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）
 正常終了
{
	"ChangeOperationNodeApplicationResponse": {
		"StatusCode":"200",
		"Result":{
			"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
			"ReceptionNumber":"UUOM1303-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."
		}
	}
}