2.4.6 サービステンプレートのインポート
機能
指定したサービステンプレートをインポートします。
実行権限
Adminロール,Developロール
APIのバージョン
v1
リクエスト形式
POST http://host:port/Automation/version/services/ServiceTemplates/actions/import/invoke
リクエストボディーには,サービステンプレート(.stまたは.zip)を指定してください。
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
|---|---|---|
200 |
OK |
成功しました。 |
400 |
Bad Request |
.stファイルまたは.zipファイル以外が指定されました。 または,指定された.stファイルまたは.zipファイルが,壊れているか誤っています。 |
401 |
Unauthorized |
ログイン権限がありません。 |
403 |
Forbidden |
インポートの権限がありません。 |
412 |
Precondition failed |
サーバが利用できません。 |
415 |
Unsupported media type |
Content-Typeヘッダーの指定が不正です。 |
500 |
Server-side error |
一時保存フォルダへの保存に失敗しました。または,サーバ処理エラーが発生しました。 |
レスポンスのスキーマ
リクエストに対するレスポンスボディーの構造を次に示します。
{
"instanceID" : "instance-id",
"created" : "created-date-and-time",
"updated" : "updated-date-and-time",
"completed" : "completed-date-and-time",
"state" : "state",
"affectedResources" : [ {...} ],
"result" : [ {...} ],
"resultType" : "result-type"
}
使用例
サービステンプレート(SP_GenericApplication_01.20.00.st)をインポートする場合の使用例を示します。
リクエストヘッダー:
POST /Automation/v1/services/ServiceTemplates/actions/import/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.36.0
Host: 10.196.184.182:22015
Accept: application/json
Content-Length: 2106265
Expect: 100-continue
Content-Type: multipart/form-data; boundary=------------------------5564f06622f7727e
Accept-Language: ja
レスポンスヘッダー:
HTTP/1.1 100 Continue
HTTP/1.1 200 OK
Date: Wed, 29 Jul 2015 07:48:21 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 9c9f012d1d34b9ede86d68728604c884b85e8_Vlo8Y30JdDBUB3ljJSVPaRtjBSA=_V0810
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, HEAD, OPTIONS
Access-Control-Allow-Credentials: true
Cache-Control: no-cache
Transfer-Encoding: chunked
Content-Type: application/json
レスポンスボディー:
{
"instanceID" : "f4c5065a-ff42-45df-bca9-e2d79b4b5bb7",
"created" : "2015-07-29T16:48:26.528+09:00",
"updated" : "2015-07-29T16:48:26.528+09:00",
"completed" : "2015-07-29T16:48:26.528+09:00",
"state" : "success",
"affectedResource" : [ "http://10.196.184.182:22015/Automation/v1/objects/ServiceTemplates/1116" ],
"result" : [ {
"message" : "サービステンプレートのインポートに成功しました(サービステンプレートファイル名: SP_GenericApplication_01.20.00.st).",
"messageID" : "KNAE03111-I"
} ]
}