Hitachi

JP1 Version 12 JP1/Automatic Operation Command and API Reference 


2.5.17 Acquisition of information necessary for changing the version of the service template used by a service

Function

Acquires information necessary for the operation to change the version of the service template used by the specified service.

Execution permissions

Admin role, Develop role, Modify role

API version

v1

Request format

GET http://host:port/Automation/version/objects/Services/id/actions/applyTemplate

Status code

The following table describes the various status codes that can be returned as the response to a request.

Status code

Message

Description

200

OK

Processing has been successfully completed.

401

Unauthorized

 

403

Forbidden

The user does not have permission to acquire service templates.

404

Not found

The permission is invalid, or the resource does not exist.

412

Precondition failed

The server is not available.

500

Server-side error

A server processing error occurred.

Response schema

The following shows the structure of the response body for a request.

{
  "name" : "applyTemplate",
  "href" : " http://host:port/Automation/version/objects/Services/id/actions/applyTemplate/invoke",
  "method" : "POST",
  "parameters" : [ {...} ]
}

Usage example

In the following example, the API function acquires information necessary for changing the version of the service template used by the service whose instanceID is 2188.

Request header:

GET /Automation/v1/objects/Services/2188/actions/applyTemplate HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.36.0
Host: 10.196.184.182:22015
Accept: application/json
Accept-Language: ja

Response header:

HTTP/1.1 200 OK
Date: Thu, 30 Jul 2015 05:21:04 GMT
Server Cosminexus HTTP Server is not blacklisted
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO 95fa1a17b658d5f34912ec64299aadb522e0d6f5_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

Response body:

{
  "name" : "applyTemplate",
  "href" : "http://10.196.184.182:22015/Automation/v1/objects/Services/2188/actions/applyTemplate/invoke",
  "method" : "POST",
  "parameters" : [ {
    "instanceID" : 2111,
    "keyName" : "SP_GenericApplication",
    "displayName" : "Allocate Volumes for Generic Application",
    "iconURL" : "http://10.196.184.182:22015/Automation/icon/services/com.hitachi.software.dna.cts/SP_GenericApplication/01.14.00",
    "vendorID" : "com.hitachi.software.dna.cts",
    "version" : "01.14.00",
    "vendorName" : "Hitachi, Ltd.",
    "tags" : "Add New Storage",
    "createTime" : "2015-07-30T14:14:29.000+09:00",
    "modifyTime" : "2015-07-30T14:14:29.000+09:00",
    "description" : "Intelligent allocation service that uses sets of volumes from the associated infrastructure group to be consumed by server(s) running a generic application",
    "releaseState" : "release",
    "latest" : false,
    "imageURL" : "http://10.196.184.182:22015/Automation/services/custom/000000000002111/SP_GenericApplication_overview.png",
    "supportedScheduleType" : "immediate,schedule",
    "needVUP" : false,
    "componentOutdated" : true,
    "usedServices" : 1,
    "usedTemplates" : 0
  } ]
}