Jump to

• Request
• Response
• Examples

Stop, Start or Restart a Service Instance or Compute Node

post

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

Stops, starts or restarts a service instance or one of its compute nodes.

Request

Supported Media Types

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

Path Parameters

• identityDomainId: string
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

• serviceId: string
  Name of the Database Classic Cloud Service instance.

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
  Identity domain ID for the Database Classic Cloud Service account:
   

  • For a Cloud account with Identity Cloud Service: the identity service ID, which has the form idcs-letters-and-numbers. You can find this ID in the Identity Service Id field on the Overview tab of the Service Details page for Database Classic Cloud Service in My Services.

  • For a traditional cloud account: the name of the identity domain.

Body ()

The request body defines the details of the stop, start or restart request.

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

• lifecycleState(optional): string
  Type of the request. Valid values are:

  • stop: Stops the Database Classic Cloud Service instance or compute node.
  • start: Starts the Database Classic Cloud Service instance or compute node.
  • restart: Restarts the Database Classic Cloud Service instance or compute node.
• lifecycleTimeout(optional): string
  Timeout (minutes) for each request. The range of valid values are 1 to 300 minutes (inclusive). This value defaults to 60 minutes.
• vmName(optional): string
  Name of compute node to stop, start, or restart.

{
    "title":"Request Body",
    "type":"object",
    "description":"",
    "properties":{
        "lifecycleState":{
            "type":"string",
            "description":"Type of the request. Valid values are:<ul><li><code>stop</code>: Stops the Database Classic Cloud Service instance or compute node.</li><li><code>start</code>: Starts the Database Classic Cloud Service instance or compute node.</li><li><code>restart</code>: Restarts the Database Classic Cloud Service instance or compute node."
        },
        "lifecycleTimeout":{
            "type":"string",
            "description":"Timeout (minutes) for each request. The range of valid values are <code>1</code> to <code>300</code> minutes (inclusive). This value defaults to <code>60</code> minutes."
        },
        "vmName":{
            "type":"string",
            "description":"Name of compute node to stop, start, or restart."
        }
    }
}

Back to Top

Response

202 Response

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

Headers

• Location: string
  A REST URI you can use to check the progress and completion of the stop, start, or restart operation.

Back to Top

Examples

The following example shows how to restart a Database Classic Cloud Service instance by submitting a POST request on the REST endpoint using cURL.

This example uses a traditional cloud account, so the {identityDomainId} path parameter and the X-ID-TENANT-NAME header parameter are set to the account's domain name, which is usexample. The Oracle Cloud user name of the user making the call is dbcsadmin. The name of the service instance being restarted is db12c-xp-si.

cURL Command

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

$ curl --include --request POST \
--user dbcsadmin:password \
--header "X-ID-TENANT-NAME:usexample" \
--header "Content-Type:application/json" \
--data '{ "lifecycleState" : "Restart" }' \
https://dbaas.oraclecloud.com/paas/service/dbcs/api/v1.1/instances/usexample/db12c-xp-si

HTTP Status Code and Response Headers

HTTP/1.1 202 Accepted
Date: date-and-time-stamp
Server: Oracle-Application-Server-11g
Location: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/status/control/job/5745522
Content-Length: 0
X-ORACLE-DMS-ECID: id-string
X-ORACLE-DMS-ECID: id-string
X-Frame-Options: DENY
Service-URI: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/db12c-xp-si
Vary: Accept-Encoding,User-Agent
Retry-After: 30
Content-Language: en
Content-Type: application/json

Back to Top