Jump to

• Request
• Response
• Examples

Stop a Stack

post

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/stack/instances/{stackName}/stop

Stop all the resources in the stack.

Request

Supported Media Types

• multipart/form-data

Path Parameters

• identityDomainId: string
  Name of the Oracle Cloud identity domain
• stackName: string
  Name of a stack whose resources are to be stopped

Form Parameters

• config-payload(optional): string
  Path to a JSON file containing any stop parameters for the resources in this stack. These parameters are specific to each resource type.

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted. Will stop all the resources in the stack.

Body ()

Root Schema : ondemand-response

Type: object

Show Source

• details(optional): object details
  The response body contains information about the requested stack operation.

{
    "properties":{
        "details":{
            "description":"The response body contains information about the requested stack operation.",
            "properties":{
                "message":{
                    "type":"string",
                    "description":"Message"
                },
                "jobId":{
                    "type":"string",
                    "description":"Job ID"
                }
            }
        }
    }
}

Nested Schema : details

Type: object

The response body contains information about the requested stack operation.

Show Source

• jobId(optional): string
  Job ID
• message(optional): string
  Message

{
    "description":"The response body contains information about the requested stack operation.",
    "properties":{
        "message":{
            "type":"string",
            "description":"Message"
        },
        "jobId":{
            "type":"string",
            "description":"Job ID"
        }
    }
}

400 Response

Bad Request. Returned if there is bad input.

Back to Top

Examples

The following example shows how to stop a specific stack in Oracle Cloud Stack by submitting a POST request to the stop endpoint for the stack.

cURL Command

curl -i -X POST \
-u yourUsername:yourPassword \
-H "X-ID-TENANT-NAME:MyIdentityDomain" \
https://psm.us.oraclecloud.com/paas/api/v1.1/instancemgmt/MyIdentityDomain/services/stack/instances/MyStack/stop

If any resources in the stack support stop parameters, you can specify these parameters as a JSON file on your local file system. The file is sent as a form parameter.

curl -i -X POST \
-u yourUsername:yourPassword \
-H "X-ID-TENANT-NAME:MyIdentityDomain" \
-F "config-payload=@MyStackStop.json" \
https://psm.us.oraclecloud.com/paas/api/v1.1/instancemgmt/MyIdentityDomain/services/stack/instances/MyStack/stop

Note: This example uses the URL prefix for the United States. For information about the URL prefixes for other regions of the world, see Send Requests.

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 200 OK
Date: Thu, 25 Apr 2017 18:50:14 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following shows an example of the response body in JSON format.

{
  "details":{
    "message":"Submitted job to stop stack [MyStack] in domain [MyIdentityDomain].",
    "jobId":"101231"
  }
}

Back to Top