GetOperationNodeMaster
「UOMポータル」の「サービス設定」から「運用ノード設定参照」を確認するのと同様に、現在の登録情報を取得(参照)できます。
HTTPメソッド | Action | 名称 |
---|---|---|
POST | GetOperationNodeMaster | 運用ノード設定マスタ情報取得 |
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 | 結果コード | 以下が返却されます
| ||
ApplicationList | Array | 設定リスト | 設定情報を格納したリストです | ||
OperationNodeMasterId | int | 運用ノードマスタID | 設定レコードごとに割り当てられたマスタIDです。新規の受理待ちや受理等、マスタIDが発行されていないレコードは取得しません | ||
MonitoringFlg | String | 監視連携 | 以下が返却されます
| ||
OperationNodeName | String | 運用対象ノード名 | 先頭に”サービスコード_”を付与して返却されます (例)uom12345678_testnode_001 | ||
OperationNodeTitle | String | 運用対象ノード名称 | (例)testnode_001 | ||
CategoryId | String | 種別 | 以下が返却されます
| ||
IpAddress | String | IPアドレス | (例)192.0.2.130 | ||
ContractId | String | 契約区分 | 新規、変更の場合以下が返却されます
| ||
ApplicationTakeEffectDatetime | DateTime | 適用日時 | 形式:YYYY/MM/DD hh:mm:ss (例)2014/04/23 10:00:00 | ||
Notes | String | 補足 | (例)memo | ||
MonitoringLinkage | String | 監視情報取得元 | マネージドモニタリング for Zabbixを契約している場合、以下が返却されます
| ||
HostId | String | ホストID | マネージドモニタリング for 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:警告メッセージ
なし
5:制限config.rb
なし
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 = "GetOperationNodeMaster" 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>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>ApplicationList</name> <value> <array> <data> <value> <struct> <member> <name>OperationNodeMasterId</name> <value>123</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>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> 異常終了 <?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)
正常終了 { "GetOperationNodeMasterResponse": { "StatusCode":"200", "Result":{ "RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx", "ResultCode":"0", "ApplicationList":[ { "OperationNodeMasterId":"123", "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", "MonitoringFlg":"0", "OperationNodeName":"uom12345678_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." } } }