1. REST API for MySQL Cloud Service
  2. Tasks
  3. Service Instances

Scale a Service instance

post

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/MySQLCS/instances/{serviceId}/hosts/scale

Scale a MySQL Cloud Service instance's compute nodes, either up or down.

Request

Supported Media Types
Path Parameters
Header Parameters
Body ()
The request body defines details for the scaling operation.
Root Schema : Scaling Request Body
Type: object
Title: Scaling Request Body
Defines component parameters for the scaling operation. See the nested 'components' schema for details.
Show Source
Nested Schema : Scaling Component Details
Type: object
Title: Scaling Component Details
Details for the 'components' schema in the scaling operation.
Show Source
  • hosts
    A list of hosts to control.
  • Desired compute shape. A shape defines the number of Oracle Compute Units (OCPUs) and amount of memory (RAM). Valid shapes include:
    • oc3: 1 OCPU, 7.5 GB memory
    • oc4: 2 OCPUs, 15 GB memory
    • oc5: 4 OCPUs, 30 GB memory
    • oc6: 8 OCPUs, 60 GB memory
    • oc7: 16 OCPUs, 120 GB memory
    • oc1m: 1 OCPU, 15 GB memory
    • oc2m: 2 OCPUs, 30 GB memory
    • oc3m: 4 OCPUs, 60 GB memory
    • oc4m: 8 OCPUs, 120 GB memory
    • oc5m: 16 OCPUs, 240 GB memory

    See About Shapes in Using Oracle Compute Cloud Service for more information about shapes.

Nested Schema : hosts
Type: array
A list of hosts to control.
Show Source

Response

Supported Media Types

202 Response

Accepted. See Status Codes for information about other possible HTTP status codes.
Body ()
Root Schema : Response Body
Type: object
Title: Response Body
The response body contains information about the operation.
Show Source

Examples

The following example shows how to scale the shape of a MySQL Cloud Service instance by submitting a POST request on the REST endpoint using cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the Oracle Public Cloud or Oracle Cloud Machine REST server to contact for your identity domain or tenant name. See Send Requests for the appropriate URL structure to use on Oracle Public Cloud or Oracle Cloud Machine.

cURL Command

curl -i -X POST \
  -u "username:password" \
  -H "X-ID-TENANT-NAME:ExampleIdentityDomain" \
  -d '{"components":{"mysql":{"shape":"oc5","hosts":["mytestinstance-mysql-1"]}}}' \
  -H "Accept: application/json" \
  -H "Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json" \
  https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance/hosts/scale

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 202 Accepted
Date: Wed, 30 Nov 2016 23:08:24 GMT
Transfer-Encoding: chunked
Location:https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/3480
Content-Type: application/json
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Service-URI: https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/MyTestInstance
Retry-After: 60
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
X-ORACLE-DMS-ECID: d-7262--2099d98613bc0e4-16817786bd3-303edc0c8
Access-Control-Allow-Origin: *
X-Frame-Options: DENY

Example of Response Body

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

{
    "details": {
        "message": "Submitted job to scaling job in service [MyTestInstance] in domain [ExampleIdentityDomain].",
        "jobId": "3480"
    }
}