公開
マニュアル一覧へ

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

IIJ統合運用管理サービス API Reference

GetProcedureManualInfo

ChangeAlertMatchingApplication（アラート通知/対応設定設定更新）を行うために必要な手順書情報を取得します。

本APIで取得した手順書IDを利用して、標準運用手順書、及び拡張運用手順書の指定を行えます。

HTTPメソッドAction名称
POST（REST形式）GetProcedureManualInfo標準・拡張運用手順書情報取得
1： リクエストパラメータ
パラメータタイプ必須意味最大文字数リクエスト例備考
ServiceCodeString○サービスコード15uom12345678ご契約のサービスコードを指定してください
MasterIdString○設定者マスターID15SA9876543マスターIDを指定してください
ProcedureManualTypeint○手順書種別11

取得する手順書の種別を指定してください

  • 1：標準手順書のみ
  • 2：個別手順書のみ
  • 3：定型手順書のみ
  • 4：標準手順書+定型手順書
  • 5：個別手順書+定型手順書
Localeint○表示言語10

下記のみ利用可能です

0：日本語

2： レスポンス
正常終了
フィールドタイプ意味備考
StatusCodeStringステータスコード成功時200が返却されます
Result
−結果
RequestIdStringリクエストIDAPIリクエストごとに割り当てられる一意なIDです
ResultCodeString結果コード

以下が返却されます

  • 0：成功
  • 1：異常（入力チェックエラー）
  • 2：異常（システムエラー）
ApplicationList
Array設定リスト設定情報を格納したリストです
ProcedureManualIdString手順書ID

手順書IDを返却します

(例)400-uom12345678-P4343

ProcedureManualNameString手順書名

手順書IDに紐づく手順書名を返却します

(例)DNS Server 起動（Win2012)

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

3： エラーメッセージ
エラーHTTP Status CodeErrorTypeErrorMessage説明備考
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. ServiceCode is a required.サービスコードが不正SERVICE_CODE_REQUIRED_FIELD
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. MasterID is a required.マスターIDが不正MASTER_ID_REQUIRED_FIELD
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. There is no MasterID.マスターIDが登録されていないMASTER_ID_NONE
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. There is no UOM contract.UOMの契約が存在しないUOM_CONTRACT_NONE
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. ProcedureManualType is not selected.手順書種別が選択されていないMANUAL_TYPE_REQUIRED_FIELD
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. Wrong MANUAL TYPE is selected.手順書種別が不正MANUAL_TYPE_VALUE_CHECK
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. It is denied, because Contract of Standard Plus Option does not exist.標準プラス契約が存在しないSTANDARD_PLUS_CONTRACT_NONE
パラメータエラー200UOM Parameter ErrorUOM parameter error occurred. It is denied, because Contract of Advanced Operation does not exist.拡張契約が存在しないADVANCED_CONTRACT_NONE
例外エラー200UOM Exception ErrorUOM system exception error occurred.UOM-API設備のシステム障害SYSTEM_EXCEPTION_ERROR
Webシステムエラー200UOM WebSystem ErrorUOM 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 = "GetProcedureManualInfo"
PARAMS = '{
	"ServiceCode" : "uom12345678",
	"MasterId" : "SA9876543",
	"ProcedureManualType" : "1",
	"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>ProcedureManualId</name>
															<value>400-uom12345678-P4323</value>
														</member>
														<member>
															<name>ProcedureManualName</name>
															<value>DNS Server 起動（Win2003)</value>
														</member>
													</struct>
												</value>
												<value>
													<struct>
														<member>
															<name>ProcedureManualId</name>
															<value>400-uom12345678-P4333</value>
														</member>
														<member>
															<name>ProcedureManualName</name>
															<value>DNS Server 起動（Win2008)</value>
														</member>
													</struct>
												</value>
												<value>
													<struct>
														<member>
															<name>ProcedureManualId</name>
															<value>400-uom12345678-P4343</value>
														</member>
														<member>
															<name>ProcedureManualName</name>
															<value>DNS Server 起動（Win2012)</value>
														</member>
													</struct>
												</value>
												<value>
													<struct>
														<member>
															<name>ProcedureManualId</name>
															<value>400-uom12345678-P3302</value>
														</member>
														<member>
															<name>ProcedureManualName</name>
															<value>OS 起動(Win2003)</value>
														</member>
													</struct>
												</value>
												<value>
													<struct>
														<member>
															<name>ProcedureManualId</name>
															<value>400-uom12345678-P3303</value>
														</member>
														<member>
															<name>ProcedureManualName</name>
															<value>OS 起動(Win2008)</value>
														</member>
													</struct>
												</value>
												<value>
													<struct>
														<member>
															<name>ProcedureManualId</name>
															<value>400-uom12345678-P3304</value>
														</member>
														<member>
															<name>ProcedureManualName</name>
															<value>OS 起動(Win2012)</value>
														</member>
													</struct>
												</value>
												<value>
													<struct>
														<member>
															<name>ProcedureManualId</name>
															<value>400-uom12345678-P7301</value>
														</member>
														<member>
															<name>ProcedureManualName</name>
															<value>アラート発生連絡1</value>
														</member>
													</struct>
												</value>
												<value>
													<struct>
														<member>
															<name>ProcedureManualId</name>
															<value>400-uom12345678-P7302</value>
														</member>
														<member>
															<name>ProcedureManualName</name>
															<value>アラート発生連絡2</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）
正常終了
{
	"GetProcedureManualInfoResponse": {
		"StatusCode":"200",
		"Result":{
			"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
			"ResultCode":"0",
			"ApplicationList":[
				{"ProcedureManualId" : "400-uom12345678-P4323",
				"ProcedureManualName" : "DNS Server 起動（Win2003)"},
				{"ProcedureManualId" : "400-uom12345678-P4333",
				"ProcedureManualName" : "DNS Server 起動（Win2008)"},
				{"ProcedureManualId" : "400-uom12345678-P4343",
				"ProcedureManualName" : "DNS Server 起動（Win2012)"},
				{"ProcedureManualId" : "400-uom12345678-P3302",
				"ProcedureManualName" : "OS 起動(Win2003)"},
				{"ProcedureManualId" : "400-uom12345678-P3303",
				"ProcedureManualName" : "OS 起動(Win2008)"},
				{"ProcedureManualId" : "400-uom12345678-P3304",
				"ProcedureManualName" : "OS 起動(Win2012)"},
				{"ProcedureManualId" : "400-uom12345678-P7301",
				"ProcedureManualName" : "アラート発生連絡1"},
				{"ProcedureManualId" : "400-uom12345678-P7302",
				"ProcedureManualName" : "アラート発生連絡2"}
			]
		}
	}
}
異常終了
{
	"ErrorResponse": {
		"Result":{
			"RequestId":"xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx",
			"ErrorType":"UOMParameterError",
			"ErrorMessage":"UOM parameter error occurred. Service code is a required field."
		}
	}
}