CreateNewOperationStopApplication
「UOMポータル」の「運用コントロールパネル」から「対応停止申請」を実施するのと同様に、対応停止申請を新たに申請できます。
| HTTPメソッド | Action | 名称 |
|---|---|---|
| POST | CreateNewOperationStopApplication | 対応停止申請（新規申請） |
1： リクエストパラメータ
| パラメータ | タイプ | 必須 | 意味 | 最大文字数 | リクエスト例 | 備考 | |
|---|---|---|---|---|---|---|---|
| OfficeId | String | ○ | 事業者コード | 11 | IIJ00000001 | 固定 | |
| ServiceCode | String | ○ | サービスコード | 15 | uom12345678 | ご契約のサービスコードを指定してください | |
| MasterId | String | ○ | 申請者マスターID | 15 | SA9876543 | マスターIDを指定してください | |
| NodeList | Array | − | ノードリスト | − | − | ノード単位の情報を格納したリストです | |
| OperationNodeName | String | ○ | 運用対象ノード名 | 115 | uom12345678_testnode_001 | 先頭に”サービスコード_”を付与してください | |
| MonitoringId | String | ○ | 監視ID | 30 | 12345 | ||
| StartDatetime | String | ○ | 適用開始日時 | 19 | 2017-07-07 10:10:30 | YYYY-MM-DD hh:mm:ssの形式で指定してください | |
| EndDatetime | String | ○ | 適用終了日時 | 19 | 2017-07-20 10:10:30 | YYYY-MM-DD hh:mm:ssの形式で指定してください | |
| ApplyReason | String | ○ | 申請理由 | 1 | 1 | 以下から指定してください
| |
| ApplyReasonOther | String | △ | 申請理由その他 | 600 | メンテナンスのため | 申請理由で「3：その他」を指定した場合必須です | |
| ApplyMilcc | String | − | 申請メールCC | 750 | iij-taro@example.jp | RFCの規定において有効なメールアドレスを指定してください（カンマ区切りで複数登録可能） | |
| Locale | String | ○ | 表示言語 | 1 | 0 | 下記のみ利用可能です 0：日本語 | |
2： レスポンス
| フィールド | タイプ | 意味 | 備考 | |
|---|---|---|---|---|
| StatusCode | String | ステータスコード | 成功時200が返却されます | |
| Result | − | 結果 | ||
| RequestId | String | リクエストID | APIリクエストごとに割り当てられる一意なIDです | |
| ReceptNo | String | 受付番号 | 申請を受け付けた番号が返却されます （例）SUOM1609-0002 | |
| ReceptNoSubNo | String | 受付番号枝番 | ||
異常終了
| フィールド | タイプ | 意味 | 備考 | |
|---|---|---|---|---|
| Result | − | 結果 | ||
| RequestId | String | リクエストID | APIリクエストごとに割り当てられる一意なIDです | |
| ErrorType | String | エラータイプ | 異常終了となったエラータイプです | |
| ErrorMessage | String | エラーメッセージ | 異常終了となったエラーメッセージです | |
3： エラーメッセージ
| エラー | HTTP Status Code | ErrorType | ErrorMessage | 説明 |
|---|---|---|---|---|
パラメータエラー | 400 | Parameter Error | There are invalid parameters. | パラメータの形式が無効 |
Webシステムエラー | 500 | 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 = "20161003"
# Content-Type の設定
CONTENTTYPEVALUE = "application/json; charset=utf-8"
# 対応停止申請（新規申請）
# 以下の内容は、適宜修正してください。
ACTION = "CreateNewOperationStopApplication"
PARAMS = '{
"OfficeId" : "IIJ00000001",
"ServiceCode" : "uom12345678",
"MasterId" : "SA9876543",
"NodeList" :[
{"OperationNodeName" : "uom12345678_testnode_001",
"MonitoringId" : "12345"},
{"OperationNodeName" : "uom12345678_testnode_002",
"MonitoringId" : "98765"}
],
"StartDatetime" : "2017-07-07 10:10:30",
"EndDatetime" : "2017-07-20 10:10:30",
"ApplyReason" : "1",
"ApplyReasonOther" : "申請理由その他",
"ApplyMilcc" : "iij-taro@example.jp",
"Locale" : "0"
}'
レスポンス（XML）
本APIでは、XMLでのリクエストを許可していません。
レスポンス（JSON）
正常終了
{
" CreateNewOperationStopApplicationResponse": {
"Result":{
"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
"ReceptNo":"SUOM1234-0001",
"ReceptNoSubNo":"01"
}
}
}
異常終了
{
"ErrorResponse":{
"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
"ErrorType":"UOMWebSystemError",
"ErrorMessage":"UOM Web System error occurred."
}
}