StopMonitoring

監視サービスで登録済みの監視項目について監視を停止できます。

HTTPメソッドAction名称
GET または POSTStopMonitoring監視停止API
1: リクエストパラメータ
パラメータタイプ必須意味最大文字数リクエスト例備考
ServiceCodeStringサービスコード15uom12345678

ご契約のサービスコードを指定してください

※ サービスコードのみを指定した場合は、登録されているすべての監視を停止します

IpAddressStringノードIP64192.0.2.130

監視対象ノードのIPアドレスを指定してください

※ IPアドレス指定したノードのすべての監視を停止します

※ IPアドレスは監視登録で利用したIPアドレスを指定してください

(例)グローバルIPアドレス

(例) IIJ統合運用管理サービス”プライベート接続”で払い出されたプライベートIPアドレス

(例) IIJ GIOコンポーネントで払い出されたIPアドレス

MonitoringIdString監視ID3012345

監視設定した項目に紐付く監視IDを指定してください

※ 指定した監視IDのみ監視を停止します

※ ノードIPの指定も必要です

MasterIdString申請者マスターID64SA987654364  マスターIDを指定してください
LocaleString言語10

下記のみ利用可能です

0:日本語

※ APIの正常終了から監視コンパネ及びダッシュボードに監視ステータスが反映されるまでに時間を要します。

2: レスポンス
フィールドタイプ意味備考
ResultCodeString実行結果コード正常の場合、0を返却します
3: エラーメッセージ
エラーHTTP Status CodeErrorTypeErrorMessage説明備考

パラメータエラー

200UOM WebSystem ErrorUOM Web System Error occurred.UOM Web APIの共通内部エラー 
パラメータエラー200UOM Parameter ErrorUOM Parameter Error occurred. Required Parameter is empty.UOM Web APIパラメータエラー(必須チェックNG)

内部パラメータ

ErrorType:PARAMETER_REQUIRED

パラメータエラー200UOM Parameter ErrorUOM Parameter Error occurred. Parameter is too long.UOM Web APIパラメータエラー(最大桁数チェックNG)

内部パラメータ

ErrorType:PARAMETER_TOO_LONG

パラメータエラー200UOM Parameter ErrorUOM Parameter Error occurred. Invalid parameter.UOM Web APIパラメータエラー(禁則文字チェックNG)

内部パラメータ

ErrorType:PARAMETER_ERROR

パラメータエラー200UOM Patrolclarice ErrorUOM Patrolclarice System Error occurred.クラリスシステムエラー

内部パラメータ

ErrorType:2

パラメータエラー200UOM Registration ErrorUOM Information Registration Error occurred.サーバ情報登録エラー

内部パラメータ

ErrorType:3

パラメータエラー200UOM Auth FailureUnable to validate the provided ID.指定したIDが無効

内部パラメータ

ErrorType:AUTH_FAILURE

4:警告メッセージ

なし

5:制限

なし

6:サンプル(Query形式)
リクエスト
POST /json HTTP/1.1
Host: uom.api.iij.jp
Content-Type: application/x-www-form-urlencoded
APIVersion=20150912
AccessKeyId=XXXXXXXXXX
Expire=2013-09-01T10%3A10%3A30Z
SignatureMethod=HmacSHA256
SignatureVersion=2
Signature=XXXXXXXXXXXXXXXXXXXX
Action=StopMonitoring
ServiceCode=uom12345678
MonitoringId=12345
IpAddress=192.0.2.130
MasterId=SA9876543
Locale=0
レスポンス(XML)
<StopMonitoringResponse>
	<RequestId>xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx</RequestId>
	<ResultCode>0</ResultCode>
</StopMonitoringResponse>
レスポンス(JSON)
{
	"StopMonitoringResponse": {
		"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
		"ResultCode": "0"
	}
}
7:サンプル(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"

# 監視停止API
# 以下の内容は、適宜修正してください。
ACTION = "StopMonitoring"
PARAMS = '{
	"MasterId" : "SA9876543",
	"ServiceCode" : "uom12345678",
	"IpAddress" : "192.0.2.130",
	"MonitoringId" : "12345",
	"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>
							</struct>
						</value>
					</member>
				</struct>
			</value>
		</param>
	</params>
</methodResponse>
レスポンス(JSON)
{
	"StopMonitoringResponse": {
		"RequestId": "xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
		"ResultCode": "0"
	}
}