ServiceOfferingInstance stop request

Description

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

API stability classification

Committed

API overview

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 objects

Input parameters to include in operationParams

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

The following example shows an HTTP request to stop a Service Offering Instance (SOI):

URL Syntax /csm/serviceofferinginstance/<soi-guid>/stopCompute
{
"preCallout" : "",
"postCallout" : "",
"callbackURL" : "",
"timeout" : 0
}

The following example shows the response for the preceding request:

[{
"cloudClass" : "com.bmc.cloud.model.beans.ServiceOfferingInstance",
"description" : " ",
"functionalComponents" : [ "/functionalcomponent/ac83741d-3576-49df-a068-a49199e5f2f1" ],
"guid" : "4a9afa59-c370-4240-8948-ca6d629d8ba3",
"name" : "ZichichiGold-7",
"owner" : "enduserA",
"provisionDate" : 1373458875000,
"provisionedDeploymentModel" : "{\"attributes\":{\"functionalmodelguid\":\"80835FA3-D9D5-6203-5AA6-ADE6269A9747\",\"name\":\"GoldServiceDepDef\",\"resourceset\":[{\"name\":\"GoldResourceSet\",\"description\":\"\",\"guid\":\"F82C39DB-B62B-AD35-5F77-ADEB49DF790A\",\"tags\":null,\"network\":{\"nics\":[{\"networklabel\":\"Management\",\"isdhcp\":true,\"nicnumber\":0},{\"networklabel\":\"Customer\",\"isdhcp\":true,\"nicnumber\":1}],\"vlbentry\":[{\"nic\":1,\"serverportnumber\":80,\"enabled\":true,\"lbpoolname\":\"vlp\"}],\"vfwrule\":[{\"destinationnic\":1,\"destinationport\":8080,\"description\":\"Auto\",\"sourceaddress\":\"192.168.20.2\",\"transportprotocol\":6,\"sourcenetworkaddress\":\"\",\"permit\":true,\"sourcemask\":\"\",\"enabled\":true}],\"vlbpools\":[{\"clientport\":8080,\"description\":\"\",\"poolparameters\":[],\"transportprotocol\":6,\"lbpoolname\":\"vlp\",\"networkname\":\"Customer\"}]},\"functionalcomponent\":[{\"guid\":\"50639AFD-7FD8-AE24-770F-ADE67938548B\"}],\"compute\":{\"computecontainer\":{\"cpus\":[{\"policy\":\"No Less Than\",\"count\":2}],\"installableresource\":\"PDC_ENT00012129\",\"hwarchitecture\":\"X86\",\"virtual\":true,\"installOS\":false,\"memory\":[{\"policy\":\"No Less Than\",\"mb\":2048}],\"installsoftware\":false},\"instances\":1}}],\"guid\":\"C91DB80A-D6BD-1B7A-8996-ADE83F43EAB3\"},\"class\":\"deploymentmodel\",\"version\":1.1}",
"provisionedFunctionalModel" : "{\"attributes\":{\"functionalcomponent\":[{\"name\":\"WindowsGoldComponent\",\"description\":\"WindowsGoldComponent\",\"guid\":\"50639AFD-7FD8-AE24-770F-ADE67938548B\",\"tags\":null,\"operatingsystem\":{\"productcatalogid\":\"PDC_ENT00012128\",\"postinstall\":{\"actiontype\":null,\"action\":null}},\"constraints\":{},\"software\":[]}],\"name\":\"ZichichiGoldBlueprint\",\"description\":\"\",\"guid\":\"80835FA3-D9D5-6203-5AA6-ADE6269A9747\",\"connection\":[{\"functionalcomponent2\":{\"guid\":\"50639AFD-7FD8-AE24-770F-ADE67938548B\"},\"name\":\"GoldTestConnection\",\"description\":\"\",\"guid\":\"0697E5DF-ADC5-D02B-81B8-ADE7F85548AD\",\"direction\":\"bidirectional\",\"functionalcomponent1\":{\"guid\":\"50639AFD-7FD8-AE24-770F-ADE67938548B\"}}]},\"class\":\"functionalmodel\",\"version\":1}",
"reconciliationID" : "OI-4a42b8911cda47c78dabae7a2d1d2b95",
"state" : "Installed",
"tenant" : "/organization/OI-AEB2311D96D84BACB7E16DFC0476CDDD",
"tokenID" : "4a9afa59-c370-4240-8948-ca6d629d8ba3"
}]