Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

ServiceOfferingInstance stopCompute request

Description

This API stops compute on the service offering instance specified by the identifier in the URI.

API stability classification

Committed

API overview

 

HTTP
method

URI

Return
type

Return type
multiplicity

POST

csm/ServiceOfferingInstance/guid/stopCompute

void

Not applicable

 

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Request message body

This API uses the following objects in the request message body JSON.

Top-level objectsThe [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.

Name

Type

Multi-
plicity

Description

callbackURL
String

0..1

URL to call when the operation finishes

postCallout
String

0..1

Identifier of a callout to run after the operation executes

preCallout
String

0..1

Identifier of a callout to run before the operation executes

timeout
Integer

0..1

Timeout setting. For more information about using the timeout, see Synchronous-and-asynchronous-operations. Timeout values:

  • 0: Immediate timeout
  • -1: Uses the system default timeout value
  • 1..*: Times out in the specified number of seconds

 

HTTP response message

Response message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Response message body

The response message body contains a Task object.

Example

Note

The responses captured in this topic is an example. The responses can change according to your BMC Cloud Lifecycle Management stack.

In the following examples, guid is the GUID of the service offering instance.

Request URL: /csm/serviceofferinginstance/guid/stopCompute

HTTP method: POST

Request payload

{
    "timeout" : -1,
    "preCallout" : "",
    "postCallout" : "",
    "callbackURL" : ""
}

Response payload

[
    {
        "cloudClass": "com.bmc.cloud.model.beans.Task",
        "className": "ServiceOfferingInstance",
        "completionTime": "2017/01/15 06:21:59 CST",
        "creationTime": "2017/01/15 06:20:31 CST",
        "errors": [],
        "guid": "d9cb7392-08f4-418e-8b9d-8a031471f7f4",
        "isCallout": false,
        "isError": false,
        "isSuccess": true,
        "operationName": "stopcompute",
        "parentTaskInternalUUID": "f4e465d5-c15a-42bf-bc51-71dc32cb68fc",
        "results": [
            "com.bmc.cloud.model.beans.ServiceOfferingInstance:{\r\n \"cloudClass\" : \"com.bmc.cloud.model.beans.ServiceOfferingInstance\",\r\n \"blueprintReference\" : \"/blueprintreference/38318b00-4021-42a0-aab3-d6a0e98b9f72\",\r\n \"contractLine\" : \"/contractline/4b9bbd17-c9dc-42b1-864c-94519d57dc78\",\r\n \"deploymentModel\" : \"/deploymentmodel/c9cf2310-41df-4677-bf41-a0c70ccbdba4\",\r\n \"description\" : \" \",\r\n \"functionalComponents\" : [ \"/functionalcomponent/34ba6ef0-dfbc-44a5-b260-fb83fef93da8\" ],\r\n \"functionalModel\" : \"/functionalmodel/b3b63da8-83ad-47a0-a91b-4d23c087b1a0\",\r\n \"guid\" : \"f4e465d5-c15a-42bf-bc51-71dc32cb68fc\",\r\n \"hostnamePrefix\" : \"RT879\",\r\n \"isMonitoringEnabled\" : true,\r\n \"isMonitoringPoliciesEnabled\" : true,\r\n \"isOpsEvalEnabled\" : false,\r\n \"modifiedDate\" : 1484396731000,\r\n \"name\" : \"AutoRO-22\",\r\n \"owner\" : \"SanityEU\",\r\n \"provisionDate\" : 1484314565000,\r\n \"provisionedDeploymentModel\" : \"{\\r\\n \\\"attributes\\\" : {\\r\\n \\\"resourceset\\\" : [ {\\r\\n \\\"functionalComponentReferences\\\" : [ {\\r\\n \\\"type\\\" : \\\"functionalcomponent\\\",\\r\\n \\\"objectGuid\\\" : \\\"29348db4-d3a7-4aa0-b626-a326c4ef3a5e\\\",\\r\\n \\\"guid\\\" : \\\"85bf095c-2da5-4ea1-ab22-094923b070fe\\\"\\r\\n } ],\\r\\n \\\"compute\\\" : {\\r\\n \\\"instances\\\" : 1,\\r\\n \\\"computecontainer\\\" : {\\r\\n \\\"cloudPlatforms\\\" : [ {\\r\\n \\\"name\\\" : \\\"vmware\\\",\\r\\n \\\"installableresources\\\" : [ \\\"PDC000000012127\\\" ],\\r\\n \\\"guid\\\" : \\\"39ca2a74-f318-4aec-8e40-2d03e0b2a522\\\"\\r\\n } ],\\r\\n \\\"memory\\\" : [ {\\r\\n \\\"mb\\\" : 2048,\\r\\n \\\"policy\\\" : \\\"No Less Than\\\",\\r\\n \\\"guid\\\" : \\\"19879e08-6fcd-4add-a71a-590ef046b557\\\"\\r\\n } ],\\r\\n \\\"cpus\\\" : [ {\\r\\n \\\"count\\\" : 2,\\r\\n \\\"policy\\\" : \\\"No Less Than\\\",\\r\\n \\\"guid\\\" : \\\"615f7847-41de-4a89-8508-d53f58fa2665\\\"\\r\\n } ],\\r\\n \\\"disks\\\" : [ {\\r\\n \\\"disknumber\\\" : 1,\\r\\n \\\"policy\\\" : \\\"No Less Than\\\",\\r\\n \\\"amountmb\\\" : 20480,\\r\\n \\\"provisioningSource\\\" : \\\"Template\\\",\\r\\n \\\"guid\\\" : \\\"9302623c-aa72-4903-8b3d-9fa98975aa4d\\\"\\r\\n } ],\\r\\n \\\"hwarchitecture\\\" : \\\"X86\\\",\\r\\n \\\"virtual\\\" : true,\\r\\n \\\"installsoftware\\\" : true,\\r\\n \\\"guid\\\" : \\\"0bfcb64a-5cb8-4f25-966b-e6713ca5a61a\\\",\\r\\n \\\"name\\\" : \\\"vmware\\\"\\r\\n },\\r\\n \\\"guid\\\" : \\\"7c504438-7a23-442c-ab75-39abf4b41033\\\"\\r\\n },\\r\\n \\\"network\\\" : {\\r\\n \\\"nics\\\" : [ {\\r\\n \\\"isdhcp\\\" : true,\\r\\n \\\"nicnumber\\\" : 0,\\r\\n \\\"publicip\\\" : false,\\r\\n \\\"useExternalDNS\\\" : false,\\r\\n \\\"ipForDNS\\\" : \\\"PrivateIP\\\",\\r\\n \\\"guid\\\" : \\\"4b745691-f77f-4542-a3ff-c899e37520e0\\\",\\r\\n \\\"tags\\\" : [ {\\r\\n \\\"tag\\\" : \\\"Management\\\",\\r\\n \\\"taggroup\\\" : \\\"NetworkType\\\"\\r\\n } ]\\r\\n }, {\\r\\n \\\"isdhcp\\\" : true,\\r\\n \\\"nicnumber\\\" : 1,\\r\\n \\\"publicip\\\" : false,\\r\\n \\\"useExternalDNS\\\" : false,\\r\\n \\\"ipForDNS\\\" : \\\"PrivateIP\\\",\\r\\n \\\"guid\\\" : \\\"79ca3df5-30b8-4e8e-9552-9d738ac86206\\\",\\r\\n \\\"tags\\\" : [ {\\r\\n \\\"tag\\\" : \\\"Customer\\\",\\r\\n \\\"taggroup\\\" : \\\"NetworkType\\\"\\r\\n } ]\\r\\n } ],\\r\\n \\\"guid\\\" : \\\"2161c259-b0c4-4e43-ad5f-bd58e0ee2c28\\\"\\r\\n },\\r\\n \\\"guid\\\" : \\\"ce8ba073-d068-45c6-8e2e-618d1d7027af\\\",\\r\\n \\\"name\\\" : \\\"Single Resource\\\"\\r\\n } ],\\r\\n \\\"functionalModelReference\\\" : {\\r\\n \\\"type\\\" : \\\"functionalmodel\\\",\\r\\n \\\"objectGuid\\\" : \\\"b3b63da8-83ad-47a0-a91b-4d23c087b1a0\\\",\\r\\n \\\"guid\\\" : \\\"41893689-aee9-4b57-b15e-fa923c19249e\\\"\\r\\n },\\r\\n \\\"installorder\\\" : {\\r\\n \\\"installstep\\\" : [ {\\r\\n \\\"sequence\\\" : 1,\\r\\n \\\"objectReferences\\\" : [ {\\r\\n \\\"type\\\" : \\\"resourceset\\\",\\r\\n \\\"objectGuid\\\" : \\\"ce8ba073-d068-45c6-8e2e-618d1d7027af\\\",\\r\\n \\\"guid\\\" : \\\"9ed7ef25-9777-4440-9d77-5eddb56acc95\\\"\\r\\n } ],\\r\\n \\\"guid\\\" : \\\"26c41304-4ea3-428f-ac6b-1f75c1de5988\\\"\\r\\n }, {\\r\\n \\\"sequence\\\" : 2,\\r\\n \\\"objectReferences\\\" : [ {\\r\\n \\\"type\\\" : \\\"functionalcomponent\\\",\\r\\n \\\"objectGuid\\\" : \\\"29348db4-d3a7-4aa0-b626-a326c4ef3a5e\\\",\\r\\n \\\"guid\\\" : \\\"71872c6f-d734-4e53-8082-d67b9f335720\\\"\\r\\n } ],\\r\\n \\\"guid\\\" : \\\"c88a0e06-ee2f-4af3-99d3-65cbe03a74b4\\\"\\r\\n } ],\\r\\n \\\"guid\\\" : \\\"aa51e14e-cda7-4b60-9c5d-4fbb73d2e0aa\\\"\\r\\n },\\r\\n \\\"monitoring\\\" : {\\r\\n \\\"enable\\\" : true,\\r\\n \\\"enablePolicies\\\" : true,\\r\\n \\\"guid\\\" : \\\"07239450-a424-4c5b-95b6-4ca42eee8e36\\\"\\r\\n },\\r\\n \\\"guid\\\" : \\\"c9cf2310-41df-4677-bf41-a0c70ccbdba4\\\",\\r\\n \\\"tags\\\" : [ {\\r\\n \\\"tag\\\" : \\\"Gold\\\",\\r\\n \\\"taggroup\\\" : \\\"MonitoringLevel\\\"\\r\\n } ]\\r\\n },\\r\\n \\\"class\\\" : \\\"deploymentmodel\\\",\\r\\n \\\"version\\\" : \\\"4.6\\\",\\r\\n \\\"guid\\\" : \\\"8c011845-b219-47e5-886e-8bbbe7ae84cf\\\"\\r\\n}\",\r\n \"provisionedFunctionalModel\" : \"{\\r\\n \\\"attributes\\\" : {\\r\\n \\\"functionalcomponent\\\" : [ {\\r\\n \\\"guid\\\" : \\\"29348db4-d3a7-4aa0-b626-a326c4ef3a5e\\\",\\r\\n \\\"name\\\" : \\\"Windows OS\\\"\\r\\n } ],\\r\\n \\\"guid\\\" : \\\"b3b63da8-83ad-47a0-a91b-4d23c087b1a0\\\"\\r\\n },\\r\\n \\\"class\\\" : \\\"functionalmodel\\\",\\r\\n \\\"version\\\" : \\\"4.6\\\",\\r\\n \\\"guid\\\" : \\\"341baa8f-1bb7-4e81-bc7d-6578b5207c2d\\\"\\r\\n}\",\r\n \"provisionedServiceOfferingModel\" : \"{\\r\\n \\\"functionalModel\\\" : {\\r\\n \\\"functionalcomponent\\\" : [ {\\r\\n \\\"guid\\\" : \\\"29348db4-d3a7-4aa0-b626-a326c4ef3a5e\\\",\\r\\n \\\"name\\\" : \\\"Windows OS\\\"\\r\\n } ],\\r\\n \\\"guid\\\" : \\\"b3b63da8-83ad-47a0-a91b-4d23c087b1a0\\\"\\r\\n },\\r\\n \\\"deploymentModel\\\" : {\\r\\n \\\"resourceset\\\" : [ {\\r\\n \\\"functionalComponentReferences\\\" : [ {\\r\\n \\\"type\\\" : \\\"functionalcomponent\\\",\\r\\n \\\"objectGuid\\\" : \\\"29348db4-d3a7-4aa0-b626-a326c4ef3a5e\\\",\\r\\n \\\"guid\\\" : \\\"85bf095c-2da5-4ea1-ab22-094923b070fe\\\"\\r\\n } ],\\r\\n \\\"compute\\\" : {\\r\\n \\\"instances\\\" : 1,\\r\\n \\\"computecontainer\\\" : {\\r\\n \\\"cloudPlatforms\\\" : [ {\\r\\n \\\"name\\\" : \\\"vmware\\\",\\r\\n \\\"installableresources\\\" : [ \\\"PDC000000012127\\\" ],\\r\\n \\\"guid\\\" : \\\"39ca2a74-f318-4aec-8e40-2d03e0b2a522\\\"\\r\\n } ],\\r\\n \\\"memory\\\" : [ {\\r\\n \\\"mb\\\" : 2048,\\r\\n \\\"policy\\\" : \\\"No Less Than\\\",\\r\\n \\\"guid\\\" : \\\"19879e08-6fcd-4add-a71a-590ef046b557\\\"\\r\\n } ],\\r\\n \\\"cpus\\\" : [ {\\r\\n \\\"count\\\" : 2,\\r\\n \\\"policy\\\" : \\\"No Less Than\\\",\\r\\n \\\"guid\\\" : \\\"615f7847-41de-4a89-8508-d53f58fa2665\\\"\\r\\n } ],\\r\\n \\\"disks\\\" : [ {\\r\\n \\\"disknumber\\\" : 1,\\r\\n \\\"policy\\\" : \\\"No Less Than\\\",\\r\\n \\\"amountmb\\\" : 20480,\\r\\n \\\"provisioningSource\\\" : \\\"Template\\\",\\r\\n \\\"guid\\\" : \\\"9302623c-aa72-4903-8b3d-9fa98975aa4d\\\"\\r\\n } ],\\r\\n \\\"hwarchitecture\\\" : \\\"X86\\\",\\r\\n \\\"virtual\\\" : true,\\r\\n \\\"installsoftware\\\" : true,\\r\\n \\\"guid\\\" : \\\"0bfcb64a-5cb8-4f25-966b-e6713ca5a61a\\\",\\r\\n \\\"name\\\" : \\\"vmware\\\"\\r\\n },\\r\\n \\\"guid\\\" : \\\"7c504438-7a23-442c-ab75-39abf4b41033\\\"\\r\\n },\\r\\n \\\"network\\\" : {\\r\\n \\\"nics\\\" : [ {\\r\\n \\\"isdhcp\\\" : true,\\r\\n \\\"nicnumber\\\" : 0,\\r\\n \\\"publicip\\\" : false,\\r\\n \\\"useExternalDNS\\\" : false,\\r\\n \\\"ipForDNS\\\" : \\\"PrivateIP\\\",\\r\\n \\\"guid\\\" : \\\"4b745691-f77f-4542-a3ff-c899e37520e0\\\",\\r\\n \\\"tags\\\" : [ {\\r\\n \\\"tag\\\" : \\\"Management\\\",\\r\\n \\\"taggroup\\\" : \\\"NetworkType\\\"\\r\\n } ]\\r\\n }, {\\r\\n \\\"isdhcp\\\" : true,\\r\\n \\\"nicnumber\\\" : 1,\\r\\n \\\"publicip\\\" : false,\\r\\n \\\"useExternalDNS\\\" : false,\\r\\n \\\"ipForDNS\\\" : \\\"PrivateIP\\\",\\r\\n \\\"guid\\\" : \\\"79ca3df5-30b8-4e8e-9552-9d738ac86206\\\",\\r\\n \\\"tags\\\" : [ {\\r\\n \\\"tag\\\" : \\\"Customer\\\",\\r\\n \\\"taggroup\\\" : \\\"NetworkType\\\"\\r\\n } ]\\r\\n } ],\\r\\n \\\"guid\\\" : \\\"2161c259-b0c4-4e43-ad5f-bd58e0ee2c28\\\"\\r\\n },\\r\\n \\\"guid\\\" : \\\"ce8ba073-d068-45c6-8e2e-618d1d7027af\\\",\\r\\n \\\"name\\\" : \\\"Single Resource\\\"\\r\\n } ],\\r\\n \\\"functionalModelReference\\\" : {\\r\\n \\\"type\\\" : \\\"functionalmodel\\\",\\r\\n \\\"objectGuid\\\" : \\\"b3b63da8-83ad-47a0-a91b-4d23c087b1a0\\\",\\r\\n \\\"guid\\\" : \\\"41893689-aee9-4b57-b15e-fa923c19249e\\\"\\r\\n },\\r\\n \\\"installorder\\\" : {\\r\\n \\\"installstep\\\" : [ {\\r\\n \\\"sequence\\\" : 1,\\r\\n \\\"objectReferences\\\" : [ {\\r\\n \\\"type\\\" : \\\"resourceset\\\",\\r\\n \\\"objectGuid\\\" : \\\"ce8ba073-d068-45c6-8e2e-618d1d7027af\\\",\\r\\n \\\"guid\\\" : \\\"9ed7ef25-9777-4440-9d77-5eddb56acc95\\\"\\r\\n } ],\\r\\n \\\"guid\\\" : \\\"26c41304-4ea3-428f-ac6b-1f75c1de5988\\\"\\r\\n }, {\\r\\n \\\"sequence\\\" : 2,\\r\\n \\\"objectReferences\\\" : [ {\\r\\n \\\"type\\\" : \\\"functionalcomponent\\\",\\r\\n \\\"objectGuid\\\" : \\\"29348db4-d3a7-4aa0-b626-a326c4ef3a5e\\\",\\r\\n \\\"guid\\\" : \\\"71872c6f-d734-4e53-8082-d67b9f335720\\\"\\r\\n } ],\\r\\n \\\"guid\\\" : \\\"c88a0e06-ee2f-4af3-99d3-65cbe03a74b4\\\"\\r\\n } ],\\r\\n \\\"guid\\\" : \\\"aa51e14e-cda7-4b60-9c5d-4fbb73d2e0aa\\\"\\r\\n },\\r\\n \\\"monitoring\\\" : {\\r\\n \\\"enable\\\" : true,\\r\\n \\\"enablePolicies\\\" : true,\\r\\n \\\"guid\\\" : \\\"07239450-a424-4c5b-95b6-4ca42eee8e36\\\"\\r\\n },\\r\\n \\\"guid\\\" : \\\"c9cf2310-41df-4677-bf41-a0c70ccbdba4\\\",\\r\\n \\\"tags\\\" : [ {\\r\\n \\\"tag\\\" : \\\"Gold\\\",\\r\\n \\\"taggroup\\\" : \\\"MonitoringLevel\\\"\\r\\n } ]\\r\\n },\\r\\n \\\"guid\\\" : \\\"8b07693f-6a83-4cf6-a315-4f9267396de9\\\",\\r\\n \\\"name\\\" : \\\"Automation_Windows\\\"\\r\\n}\",\r\n \"reconciliationID\" : \"OI-36846a0fb43044589c52c6927002eb36\",\r\n \"resourceSets\" : [ \"/resourceset/8189452a-148b-49bc-a8b6-592eee69b73d\" ],\r\n \"serviceOfferingContractLine\" : \"/serviceofferingcontractline/4b9bbd17-c9dc-42b1-864c-94519d57dc78\",\r\n \"state\" : \"Installed\",\r\n \"tags\" : [ {\r\n \"cloudClass\" : \"com.bmc.cloud.model.beans.Tag\",\r\n \"guid\" : \"c4d5a68f-08b5-4f54-8620-7bb774f7cfb2\",\r\n \"label\" : \"Gold\",\r\n \"modifiedDate\" : 1481602423000,\r\n \"name\" : \"Gold\",\r\n \"tagGroup\" : {\r\n \"cloudClass\" : \"com.bmc.cloud.model.beans.TagGroup\",\r\n \"guid\" : \"03b67d2f-a75c-432c-912c-6fb6decfde18\",\r\n \"modifiedDate\" : 1481602423000,\r\n \"name\" : \"MonitoringLevel\",\r\n \"ownedTags\" : [ \"/tag/Gold\", \"/tag/Silver\", \"/tag/Bronze\" ],\r\n \"tagScope\" : \"System_Internal\"\r\n },\r\n \"tagGroupObject\" : {\r\n \"cloudClass\" : \"com.bmc.cloud.model.beans.TagGroup\",\r\n \"description\" : \"@circular-reference-placeholder@\",\r\n \"guid\" : \"03b67d2f-a75c-432c-912c-6fb6decfde18\",\r\n \"tagScope\" : \"User_Defined\"\r\n }\r\n } ],\r\n \"tenant\" : \"/organization/AGHAA5V0F8DMSAO9KDY6AAK4D7APG9\",\r\n \"tokenID\" : \"f4e465d5-c15a-42bf-bc51-71dc32cb68fc\"\r\n}"
        ],
        "taskInternalUUID": "446a01aa-306d-45a0-b811-96d394c05fe8",
        "taskProgress": 100,
        "taskResultURI": "http://10.1.112.246:9090/csm/task/446a01aa-306d-45a0-b811-96d394c05fe8/result",
        "taskState": "COMPLETED",
        "taskStatusURI": "http://10.1.112.246:9090/csm/task/446a01aa-306d-45a0-b811-96d394c05fe8/status",
        "taskSubState": "task_success_final",
        "transactionID": "9149d724-fa24-4d5f-bb2f-51b16c7e8bfc"
    }
]

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*