GetAddressCustMaster
「UOMポータル」の「サービス設定」から「障害・通知連絡先設定参照」を確認するのと同様に、現在の登録情報を取得(参照)できます。
本APIで取得した連絡先グループIDを利用して、ChangeAlertMatchingApplication(アラート通知/対応設定設定更新)で初報連絡先グループの指定を行えます。
HTTPメソッド | Action | 名称 |
---|---|---|
POST(REST形式) | GetAddressCustMaster | 障害・通知連絡先設定マスタ情報取得 |
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 | 設定リスト | 設定情報を格納したリストです | |||
AddressGroupId | String | 連絡先グループID | 連絡先グループの一意なIDです (例)GAL00000006 | |||
AddressGroupName | String | 絡先グループ名称 | 連絡先グループ名称が返却されます (例)アラート受付連絡先 |
異常終了
フィールド | タイプ | 意味 | 備考 | |
---|---|---|---|---|
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 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:サンプル
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 = "GetAddressCustMaster" 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>AddressGroupId</name> <value>GAL00000001</value> </member> <member> <name>AddressGroupName</name> <value>お知らせ連絡先</value> </member> </struct> </value> <value> <struct> <member> <name>AddressGroupId</name> <value>GAL00000002</value> </member> <member> <name>AddressGroupName</name> <value>メンテナンス連絡先</value> </member> </struct> </value> <value> <struct> <member> <name>AddressGroupId</name> <value>GAL00000003</value> </member> <member> <name>AddressGroupName</name> <value>障害情報連絡先</value> </member> </struct> </value> <value> <struct> <member> <name>AddressGroupId</name> <value>GAL00000004</value> </member> <member> <name>AddressGroupName</name> <value>お問い合わせ連絡先</value> </member> </struct> </value> <value> <struct> <member> <name>AddressGroupId</name> <value>GAL00000005</value> </member> <member> <name>AddressGroupName</name> <value>通常連絡先</value> </member> </struct> </value> <value> <struct> <member> <name>AddressGroupId</name> <value>GAL00000006</value> </member> <member> <name>AddressGroupName</name> <value>アラート受付連絡先</value> </member> </struct> </value> <value> <struct> <member> <name>AddressGroupId</name> <value>GAL00000007</value> </member> <member> <name>AddressGroupName</name> <value>社内連絡先</value> </member> </struct> </value> <value> <struct> <member> <name>AddressGroupId</name> <value>GAL00000260</value> </member> <member> <name>AddressGroupName</name> <value>個別連絡先1</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. Service code is a required field.</value> </member> </struct> </value> </param> </params> </methodResponse>
レスポンス(JSON)
正常終了 { "GetAddressCustMasterResponse": { "StatusCode":"200", "Result":{ "RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx", "ResultCode":"0", "ApplicationList":[ {"AddressGroupId":"GAL00000001", "AddressGroupName":"お知らせ連絡先"}, {"AddressGroupId":"GAL00000002", "AddressGroupName":"メンテナンス連絡先"}, {"AddressGroupId":"GAL00000003", "AddressGroupName":"障害情報連絡先"}, {"AddressGroupId":"GAL00000004", "AddressGroupName":"お問い合わせ連絡先"}, {"AddressGroupId":"GAL00000005", "AddressGroupName":"通常連絡先"}, {"AddressGroupId":"GAL00000006", "AddressGroupName":"アラート受付連絡先"}, {"AddressGroupId":"GAL00000007", "AddressGroupName":"社内連絡先"}, {"AddressGroupId":"GAL00000260", "AddressGroupName":"個別連絡先1"} ] } } } 異常終了 { "ErrorResponse": { "Result":{ "RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx", "ErrorType":"UOMParameterError", "ErrorMessage":"UOM parameter error occurred. Service code is a required field." } } }