ChangeMonitoringTargetIPAddressSegmentApplication

「UOMポータル」の「サービス設定」から「監視ネットワーク設定」を実施するのと同様に、設定を行えます。

GetMonitoringTargetIPAddressSegmentInfo（監視ネットワーク設定設定内容取得）で取得した結果をもとに、変更したいレコード、または新規レコードを設定します。

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

HTTPメソッド	Action	名称
POST	ChangeMonitoringTargetIPAddressSegmentApplication	監視ネットワーク設定設定更新

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

パラメータ		タイプ	必須	意味	最大文字数	リクエスト例	備考
ServiceCode		String	○	サービスコード	15	uom12345678	ご契約のサービスコードを指定してください
Application MailAdress Add		String	○	設定時メール送付先	500	iij-taro@example.jp	登録済みの「お問い合わせ連絡先グループ」以外に設定時のメールを送付したい場合は、「設定時メール送付先」にアドレスを入力します
MasterId		String	○	設定者マスターID	15	SA9876543	マスターIDを指定してください
Locale		int	○	表示言語	1	0	下記のみ利用可能です 0：日本語
Application List		Array	○	設定リスト	−	−	設定情報を格納したリストです
	Update Type	int	○	設定タイプ	1	0	以下から指定してください 0：追加 1：更新 2：削除 3：何もしない ※ 選択がない場合は設定更新対象になりません
	IpSegment MasterId	int	○	監視ネットワークマスタID	9	123	設定レコードごとに割り当てられたマスタIDを指定してください。新規の受理待ち、受理の場合は指定不要です
	IpSegment	String	○	監視ネットワーク	64	192.0.2.128	IPv4、またはIPv6アドレスを指定してください ※ IPv4では第4オクテットが、"0"、"255"は指定できません
	Subnet Mask	String	○	サブネットマスク	2	26	24～64の範囲で指定してください ※ IPv4では24～32までです
	Notes	String	○	補足	1000	memo	補足事項があれば入力してください

2：レスポンス

正常終了

フィールド		タイプ	意味	備考
StatusCode		String	ステータスコード	成功時 200が返却されます
Result		−	結果
	RequestId	String	リクエストID	APIリクエストごとに割り当てられる一意なIDです
	ResultCode	String	結果コード	以下が返却されます 0：成功 1：異常（入力チェックエラー） 2：異常（システムエラー）
	ReceptionNumber	String	受付番号	設定を受け付けた番号が返却されます（例）KUOM1303-0828

異常終了

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

3：エラーメッセージ

エラー	HTTP Status Code	ErrorType	ErrorMessage	説明	備考
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. Input 500 characters or less in ApplicationMailAdressAdd field.	設定時メール送付先の最大文字数超過	APPLICATION_EMAIL_CHARACTER_OVER
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. Enter the Email Address in the proper email address format.	設定時メール送付先のメールアドレス形式が不正	NOT_EMAIL_ADDRESS_FORMAT
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. IpSegmentMasterId is a required.	監視ネットワークマスタIDが不正	KANSHI_MASTER_ID_REQUIRED_FIELD
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. IpSegment is a required.	監視ネットワーク情報が不正	IP_SEGMENT_REQUIRED_FIELD
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. Input 128 characters or less in IpSegment.	監視ネットワーク最大文字数超過	IP_SEGMENT_CHARACTER_OVER
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. Specify IpSegment in IPv4 or IPv6 format.	監視ネットワーク入力形式不正	IP_ADDRESS_WRONG_FORMAT_KANSHI
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. You have specified a network address or a broadcast address in IpSegment.	監視ネットワークアドレス不正	IP_ADDRESS_TYPE_NG
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. The ranges specified by IpSegment and SubnetMask are overlapping.	監視ネットワーク入力値重複	IP_ADDRESS_OVER_LAPPING
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. The IpSegment has already been registered. Specify the correct IpSegment which has no duplicate.	監視ネットワーク重複	IP_ADDRESS_ALREADY_REGISTED_KANSHI
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. You cannot submit the application since it is not the private segment specified by us. Specify a IpSegment that can be entered.	プライベートIPアドレスセグメント指定不可アドレス	PRIVATE_IP_ADDRESS_NOT_ENTERED
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. SubnetMask is a required.	サブネットマスク不正	SUBNET_MASK_REQUIRED_FIELD
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. Select a value of 32 or less in SubnetMask if IpSegment is in IPv4 format, or select a value of 64 or less if it is in IPv6 format.	サブネットマスク指定不正	IP_ADDRESS_SEGMENT_NG
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. Input 1000 characters or less in Notes field.	最大文字数超過	NOTES_CHARACTER_OVER
パラメータエラー	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 Parameter Error	UOM parameter error occurred. UpdateType is a required.	設定タイプ不正	UPDATE_TYPE_REQUIRED_FIELD
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. UpdateType must be Update, Delete, or Nochange.	設定タイプ指定数値不正	UPDATE_TYPE_WRONG_FORMAT
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. The records are old. Update to the latest records.	設定更新対象レコードが削除・受理・受理待ちのため更新不可	APPLICATION_REGISTER_CHECK
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. Input 100 items or less for updating and deleting.	1度に100件を超える設定は不可	APPLICATION_MORE_UPDATABLE
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. There is no change you can apply.	設定更新可能なレコード変更がない	NO_ITEM_IS_READY
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. The Details have not been updated.	設定更新対象のレコードがない	DETAILS_NOT_UPDATE
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. You cannot submit the application since there is no Monitoring Target IP Address Segment.	監視ネットワークの全レコード削除	SINCE_NO_IP_SEGMENT
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. Specified parameters there is a problem, you can not apply.	設定内容不正により申請不可	APPLICATION_PARAMETER_ERROR
パラメータエラー	200	UOM Parameter Error	UOM parameter error occurred. Application is denied, because apply IpSegment is disabled. Apply IpSegment which is available.	利用可能なネットワーク以外が指定されている	APPLICATION_SEGMENT_DISABLED
例外エラー	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 = "ChangeMonitoringTargetIPAddressSegmentApplication"
PARAMS = '{
	"ServiceCode" : "uom12345678",
	"MasterId" : "SA9876543",
	"ApplicationMailAdressAdd" : "iij-taro@example.jp",
	"Locale" : "0",
	"ApplicationList" : [
		{ "UpdateType" : "1",
		"IpSegmentMasterId" : "40001",
		"IpSegment" : "192.0.2.128",
		"SubnetMask" : "26",
		"Notes" : "memo" },
		{ "UpdateType" : "3",
		"IpSegmentMasterId" : "40002",
		"IpSegment" : "192.0.2.32",
		"SubnetMask" : "28",
		"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>KUOM1303-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）

正常終了
{
	"ChangeMonitoringTargetIPAddressSegmentApplicationResponse": {
		"StatusCode":"200",
		"Result":{
			"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
			"ReceptionNumber":"KUOM1303-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."
		}
	}
}

公開
マニュアル一覧へ

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

ChangeMonitoringTargetIPAddressSegmentApplication

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

2：レスポンス

正常終了

異常終了

3：エラーメッセージ

4：警告メッセージ

5：制限

6：サンプル（REST形式）

config.rb

レスポンス（XML）

レスポンス（JSON）

ChangeMonitoringTargetIPAddressSegmentApplication

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

2： レスポンス

正常終了

異常終了

3： エラーメッセージ

4：警告メッセージ

5：制限

6：サンプル（REST形式）

config.rb

レスポンス（XML）

レスポンス（JSON）

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

2：レスポンス

3：エラーメッセージ