GetOperationNodeInfo

「UOMポータル」の「サービス設定」から「運用ノード設定」を実施するのと同様に、現在の設定情報を取得できます。

ChangeOperationNodeApplication（運用ノード設定設定更新）実行前に、更新可能な設定リストを確認するために利用します。

HTTPメソッド	Action	名称
POST	GetOperationNodeInfo	運用ノード設定設定内容取得

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：異常（システムエラー）
	StandardContractCount		int	標準運用契約設定数	標準運用契約で設定済みのレコード数が返却されます
	StandardContractReadyCount		int	標準運用契約設定可能数	標準運用契約で設定可能なレコード数が返却されます
	StandardPlusContractCount		int	標準プラス契約設定数	標準プラス契約で設定済みのレコード数が返却されます
	StandardPlusContractReadyCount		int	標準プラス契約設定可能数	標準プラス契約で設定可能なレコード数が返却されます
	AdvancedContractCount		int	拡張運用契約設定数	拡張運用契約で設定済みのレコード数が返却されます
	AdvancedContractReadyCount		int	拡張運用契約設定可能数	拡張運用契約で設定可能なレコード数が返却されます
	WarningMessageList		Array	警告メッセージリスト	警告メッセージを格納したリストです
		WarningMessageCode	String	警告メッセージコード	警告メッセージのコードです
		WarningMessage	String	警告メッセージ	警告メッセージです
	ApplicationList		Array	設定リスト	設定を格納したリストです
		OperationNodeMasterId	int	運用ノードマスタID	設定レコードごとに割り当てられたマスタIDです。新規の受理待ち、受理の場合は未割り当てです
		ApplicationState	String	設定状態	以下が返却されます 00：設定可能 10：受理待ち 20：受理 25：設定不可
		ApplicationDetails	String	設定内容	以下が返却されます 00：新規 01：監視コントロールパネルで監視対象ノードが削除されており削除が必要なノード
		MonitoringFlg	String	監視連携	以下が返却されます 0：監視コントロールパネルと連携していない 1：監視コントロールパネルと連携して情報を取得 2：SendAlert （インシデントAPI）利用用に登録
		OperationNodeName	String	運用対象ノード名	先頭に”サービスコード_”を付与して返却されます（例）uom12345678_testnode_001
		OperationNodeTitle	String	運用対象ノード名称	（例）testnode_001
		CategoryId	String	種別	以下が返却されます 00：Windows 10：unix 15：ESXi 20：VIP 30：コンソール 40：NW機器（L2,L3） 50：NW機器（FW,LB） 60：URL 70：物理機器 75：マネージドモニタリング for Zabbix 80：その他 90：選択なし
		IpAddress	String	IPアドレス	（例）192.0.2.130
		ContractId	String	契約区分	新規、変更の場合、以下が返却されます 0：標準運用契約 1：標準プラスオプション契約 2：拡張運用契約 3：未契約
		ApplicationTakeEffectDatetime	DateTime	適用日時	形式：YYYY/MM/DD hh:mm:ss （例）2014/04/23 10:00:00
		Notes	String	補足	（例）memo
		MonitoringLinkage	String	監視情報取得元	マネージドモニタリング for Zabbixを契約している場合、以下が返却されます 0：監視コントロールパネルで設定 1：サービス設定で設定 2：Zabbixで設定
		HostId	String	ホストID	マネージドモニタリング for Zabbixを契約している場合、以下が返却されます監視情報取得元が「2：Zabbixで設定」の場合、値が入ります監視情報取得元が「2：Zabbixで設定」以外の場合、空白です

異常終了

フィールド		タイプ	意味	備考
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：警告メッセージ

警告対象	HTTP Status Code	WarningMessageCode	WarningMessage	説明
IPアドレスの重複	200	DUPLICATE_IP_ADDRESS	The IpAddress you have registered in the Monitoring Control Panel is already used in the other application. Delete the existing application, or modify the registered IpAddress in the Monitoring Control Panel.	既存の設定と監視コントロールパネルで登録したIPアドレスが重複しています。既存の設定を削除するか、監視コントロールパネルで登録したIPアドレスを変更してください
ノード名の重複	200	DUPLICATE_NODE_NAME	The OperationNodeName you have registered in the Monitoring Control Panel is already used in the other application. Delete the existing application, or modify the registered OperationNodeName in the Monitoring Control Panel.	既存の設定と監視コントロールパネルで登録した運用対象ノード名が重複しています。既存の設定を削除するか、監視コントロールパネルで登録した運用対象ノード名を変更してください
ノード名の更新	200	CHANGE_NODE_NAME	The 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 = "GetOperationNodeInfo"
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>StandardContractCount</name>
									<value>1</value>
								</member>
								<member>
									<name>StandardContractReadyCount</name>
									<value>2</value>
								</member>
								<member>
									<name>StandardPlusContractCount</name>
									<value>3</value>
								</member>
								<member>
									<name>StandardPlusContractReadyCount</name>
									<value>4</value>
								</member>
								<member>
									<name>AdvancedContractCount</name>
									<value>5</value>
								</member>
								<member>
									<name>AdvancedContractReadyCount</name>
									<value>6</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>OperationNodeMasterId</name>
															<value>123</value>
														</member>
														<member>
															<name>ApplicationState</name>
															<value>00</value>
														</member>
														<member>
															<name>ApplicationDetails</name>
															<value>00</value>
														</member>
														<member>
															<name>MonitoringFlg</name>
															<value>0</value>
														</member>
														<member>
															<name>OperationNodeName</name>
															<value>uom12345678_testnode_001</value>
														</member>
														<member>
															<name>OperationNodeTitle</name>
															<value>testnode_001</value>
														</member>
														<member>
															<name>CategoryId</name>
															<value>00</value>
														</member>
														<member>
															<name>IpAddress</name>
															<value>192.0.2.130</value>
														</member>
														<member>
															<name>ContractId</name>
															<value>0</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>OperationNodeMasterId</name>
															<value>456</value>
														</member>
														<member>
															<name>ApplicationState</name>
															<value>00</value>
														</member>
														<member>
															<name>ApplicationDetails</name>
															<value>00</value>
														</member>
														<member>
															<name>MonitoringFlg</name>
															<value>0</value>
														</member>
														<member>
															<name>OperationNodeName</name>
															<value>uom98532780_testnode_002</value>
														</member>
														<member>
															<name>OperationNodeTitle</name>
															<value>testnode_002</value>
														</member>
														<member>
															<name>CategoryId</name>
															<value>00</value>
														</member>
														<member>
															<name>IpAddress</name>
															<value>192.0.2.40</value>
														</member>
														<member>
															<name>ContractId</name>
															<value>0</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.Specified parameters there is a problem, you can not apply.</value>
					</member>
				</struct>
			</value>
		</param>
	</params>
</methodResponse>

レスポンス（JSON）

正常終了
{
	"GetOperationNodeInfoResponse": {
		"StatusCode":"200",
		"Result": {
			"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
			"ResultCode":"0",
			"StandardContractCount":"1",
			"StandardContractReadyCount":"2",
			"StandardPlusContractCount":"3",
			"StandardPlusContractReadyCount":"4",
			"AdvancedContractCount":"5",
			"AdvancedContractReadyCount":"6",
			"WarningMessageList": [
				{ "WarningMessageCode":"WARNING",
				"WarningMessage":"This is the warning message for the test."},
				{ "WarningMessageCode":"WARNING",
				"WarningMessage":"This is the warning message for the test."}
			],
			"ApplicationList": [
				{ "OperationNodeMasterId":"123",
				"ApplicationState":"00",
				"ApplicationDetails":"00",
				"MonitoringFlg":"0",
				"OperationNodeName":"uom12345678_testnode_001",
				"OperationNodeTitle":"testnode_001",
				"CategoryId":"00",
				"IpAddress":"192.0.2.130",
				"ContractId":"0",
				"ApplicationTakeEffectDatetime":"2014/04/23 10:00:00",
				"Notes":"memo"},
				{ "OperationNodeMasterId":"456",
				"ApplicationState":"00",
				"ApplicationDetails":"00",
				"MonitoringFlg":"0",
				"OperationNodeName":"uom98532780_testnode_002",
				"OperationNodeTitle":"testnode_002",
				"CategoryId":"00",
				"IpAddress":"192.0.2.40",
				"ContractId":"0",
				"ApplicationTakeEffectDatetime":"2014/04/23 10:00:00",
				"Notes":"memo"}
			]
		}	
	}
}
異常終了
{
	"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."
		}
	}
}

公開
マニュアル一覧へ

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

GetOperationNodeInfo

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

2：レスポンス

正常終了

異常終了

3：エラーメッセージ

4：警告メッセージ

5：制限

6：サンプル（REST形式）

config.rb

レスポンス（XML）

レスポンス（JSON）

GetOperationNodeInfo

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

2： レスポンス

正常終了

異常終了

3： エラーメッセージ

4：警告メッセージ

5：制限

6：サンプル（REST形式）

config.rb

レスポンス（XML）

レスポンス（JSON）

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

2：レスポンス

3：エラーメッセージ