REST API for Oracle Database Exadata Cloud Service (OCI-C)

Stop, Start or Restart a Compute Node

post

/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}

Stops, starts or restarts a compute node associated with an Exadata Cloud Service database deployment. These operations impact all databases running on the compute node.

Request

Supported Media Types

application/vnd.com.oracle.oracloud.provisioning.Service+json

Path Parameters

identityDomainId: string
The value depends on the type of Exadata Cloud Service account that is used to make the request:
- For a Traditional Cloud Account, specify the Identity Domain Name that is associated with the service.
- For a Cloud Account with Identity Cloud Service, specify the Identity Service Id that is associated with the service, which has the format idcs-letters-and-numbers.
serviceId: string

Name of the Exadata Cloud Service database deployment, which uses the compute node you want to act on.

Header Parameters

Authorization: string

Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
X-ID-TENANT-NAME: string
The value depends on the type of Exadata Cloud Service account that is used to make the request:
- For a Traditional Cloud Account, specify the Identity Domain Name that is associated with the service.
- For a Cloud Account with Identity Cloud Service, specify the Identity Service Id that is associated with the service, which has the format idcs-letters-and-numbers.
For more information, see Security, Authentication and Authorization.

The request body defines the details of the compute node lifecycle request. Bold indicates a required value.

Root Schema : stopstart-postrequest

Type: object

The request body defines the details of the compute node lifecycle request. Bold indicates a required value.

Show Source

lifecycleState(optional): string
The operation being performed:
- stop - Stop a running compute node.
- start - Start a stopped compute node.
- restart - Restart a running compute node.
lifecycleTimeout(optional): string

The operation timeout for the request.
The range of valid values is 1 to 300 minutes.
The default is 60 minutes.
vmName(optional): string

Name of the compute node being acted on.

{
    "description":"The request body defines the details of the compute node lifecycle request. <b>Bold</b> indicates a required value.",
    "properties":{
        "lifecycleState":{
            "type":"string",
            "description":"The operation being performed:<ul><li><p><code>stop</code> - Stop a running compute node.</p></li><li><p><code>start</code> - Start a stopped compute node.</p></li><li><p><code>restart</code> - Restart a running compute node.</p></li></ul>"
        },
        "lifecycleTimeout":{
            "type":"string",
            "description":"<p>The operation timeout for the request.</p><p>The range of valid values is <code>1</code> to <code>300</code> minutes.</p><p>The default is <code>60</code> minutes.</p>"
        },
        "vmName":{
            "type":"string",
            "description":"Name of the compute node being acted on."
        }
    }
}

Response

202 Response

Accepted. See Status Codes for information about other possible HTTP status codes.

The Location header returns a REST URI that can be used to access the status of the operation, as described in View the Status of an Operation.

Examples

The following example shows how to stop a compute node associated with an Exadata Cloud Service instance by submitting a POST request on the REST endpoint using cURL.

In this example, the identity domain is usexample and the Oracle Cloud user name and password are serviceadmin and Pa55_word. The name of the Exadata Cloud Service database instance being acted on is db12c and the name of the compute node being stopped is node01.us2.oraclecloud.com.

cURL Command

In the following cURL command, the request body is provided directly in the -d option.

curl -i -X POST --cacert ~/cacert.pem -u serviceadmin:Pa55_word -H "X-ID-TENANT-NAME:usexample" -H "Content-Type:application/json" -d '{ "lifecycleState" : "stop", "vmName" : "node01.us2.oraclecloud.com" }' https://dbaas.oraclecloud.com/paas/service/dbcs/api/v1.1/instances/usexample/db12c

HTTP Status Code and Response Headers

HTTP/2.0 202
server: Oracle-Application-Server-11g
strict-transport-security: max-age=31536000;includeSubDomains
location: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/status/control/job/12209188
content-language: en
access-control-allow-origin: *
access-control-allow-headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
retry-after: 30
access-control-allow-methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
x-oracle-dms-ecid: 005KA6x9wuw6uHFpR0H7id00067c00042A
x-oracle-dms-ecid: 005KA6x9wuw6uHFpR0H7id00067c00042A
service-uri: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/db12c
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Mon, 29 May 2017 04:01:17 GMT