公開
マニュアル一覧へ

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

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

GetMonitoringTargetIPAddressSegmentInfo

「UOMポータル」の「サービス設定」から「監視ネットワーク設定」 を実施するのと同様に、現在の設定情報を取得できます。

ChangeMonitoringTargetIPAddressSegmentApplication（監視ネットワーク設定設定更新）実行前に、更新可能な設定リストを確認するために利用します。

HTTPメソッドAction名称
POSTGetMonitoringTargetIPAddressSegmentInfo監視ネットワーク設定設定内容取得
1： リクエストパラメータ
パラメータタイプ必須意味最大文字数リクエスト例備考
ServiceCodeString○

サービスコード

15uom12345678ご契約のサービスコードを指定してください
MasterIdString○設定者マスターID15SA9876543マスターIDを指定してください
Localeint○表示言語10

下記のみ利用可能です

0：日本語

2： レスポンス
正常終了
フィールドタイプ意味備考
StatusCodeStringステータスコード成功時 200が返却されます
Result





−結果
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
ResultCodeString結果コード

以下が返却されます

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


Array設定リスト設定情報を格納したリストです
IpSegmentMasterIdint

監視ネットワークマスタID

設定レコードごとに割り当てられるマスタIDです。新規の受理待ち、受理の場合は未割り当てです

ApplicationStateString設定状態

以下が返却されます

  • 00：設定可能
  • 10：受理待ち
  • 20：受理
ApplicationDetailsString設定内容

以下が返却されます

00：新規

IpSegmentString監視ネットワーク（例）192.0.2.128
SubnetMaskStringサブネットマスク24～64の範囲で返却されます
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：警告メッセージconfig.rb

なし

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 = "GetMonitoringTargetIPAddressSegmentInfo"
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>IpSegmentMasterId</name>
															<value>123</value>
														</member>
														<member>
															<name>ApplicationState</name>
															<value>10</value>
														</member>
														<member>
															<name>ApplicationDetails</name>
															<value>00</value>
														</member>
														<member>
															<name>IpSegment</name>
															<value>192.0.2.128</value>
														</member>
														<member>
															<name>SubnetMask</name>
															<value>26</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>IpSegmentMasterId</name>
															<value>456</value>
														</member>
														<member>
															<name>ApplicationState</name>
															<value>20</value>
														</member>
														<member>
															<name>ApplicationDetails</name>
															<value>00</value>
														</member>
														<member>
															<name>IpSegment</name>
															<value>192.0.2.32</value>
														</member>
														<member>
															<name>SubnetMask</name>
															<value>28</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.Specified parameters there is a problem, you can not apply.</value>
					</member>
				</struct>
			</value>
		</param>
	</params>
</methodResponse>
レスポンス（JSON）
正常終了
{
	"GetMonitoringTargetIPAddressSegmentInfoResponse": {
		"StatusCode":"200",
		"Result":{
			"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
			"ResultCode":"0",
			"ApplicationList":[
				{"IpSegmentMasterId":"123",
				"ApplicationStatus":"10",
				"ApplicationDetails":"00",
				"IpSegment":"192.0.2.128",
				"SubnetMask":"26",
				"ApplicationTakeEffectDatetime":"2014/04/23 10:00:00",
				"Notes":"memo"},
				{"IpSegmentMasterId":"456",
				"ApplicationStatus":20"",
				"ApplicationDetails":"00",
				"IpSegment":"192.0.2.32",
				"SubnetMask":"28",
				"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."
		}
	}
}