Jump to

• Request
• Response
• Examples

Scale a Service Instance

put

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

Scales a service instance up or down. Specifically, you can:

• Scale the shape of the service instance's compute nodes up or down.

• Add to the service instance's data or backup storage or add a new storage volume to the compute node of a service instance hosting a single-instance database.

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 scaling request.

Root Schema : Request Body

Type: object

Title: Request Body

Show Source

• additionalStorage(optional): string
  Specify size of additional storage in Giga Bytes. This parameter is optional. User can change shape only without adding storage. If additionalStorage is specified, minimum value is 1GB and maximum value is 1TB.
• componentInstanceName(optional): string
  (Applies only to service instances that use Oracle RAC and Oracle Data Guard together.)

  Specifies whether the scaling operation applies to the primary database or standby database of the Data Guard configuration. Specify the value DB_1 for the primary database or the value DB_2 for the standby database.

• shape(optional): string
  Specify new shape for the Database Classic Cloud Service instance. User can specify a higher shape (Scale Up) or a lower shape (Scale Down). Shape is optional. User can add storage only without changing shape.
• usage(optional): string
  This parameter specifies usage of additional storage and is applicable only when additionalStorage is specified. Specify usage to extend Data or Backup storage volumes of Database Classic Cloud Service instance. Valid values are data to extend Data Storage Volume and fra to extend Backup Storage Volume. If usage is not specified, new storage volume will be created.

{
    "title":"Request Body",
    "type":"object",
    "description":"",
    "properties":{
        "shape":{
            "type":"string",
            "description":"Specify new shape for the Database Classic Cloud Service instance. User can specify a higher shape (Scale Up) or a lower shape (Scale Down). Shape is optional. User can add storage only without changing shape."
        },
        "additionalStorage":{
            "type":"string",
            "description":"Specify size of additional storage in Giga Bytes. This parameter is optional. User can change shape only without adding storage. If additionalStorage is specified, minimum value is 1GB and maximum value is 1TB. "
        },
        "componentInstanceName":{
            "type":"string",
            "description":"(Applies only to service instances that use Oracle RAC and Oracle Data Guard together.)<p>Specifies whether the scaling operation applies to the primary database or standby database of the Data Guard configuration. Specify the value <code>DB_1</code> for the primary database or the value <code>DB_2</code> for the standby database."
        },
        "usage":{
            "type":"string",
            "description":"This parameter specifies usage of additional storage and is applicable only when additionalStorage is specified. Specify usage to extend Data or Backup storage volumes of Database Classic Cloud Service instance. Valid values are <code>data</code> to extend Data Storage Volume and <code>fra</code> to extend Backup Storage Volume. If usage is not specified, new storage volume will be created."
        }
    }
}

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 scaling operation.

Back to Top

Examples

The following example shows how to scale up the shape of a Database Classic Cloud Service instance by submitting a PUT 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 scaled up is named db12c-ee.

cURL Command

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

curl --include --request PUT \
--user dbcsadmin:password \
--header "X-ID-TENANT-NAME:usexample" \
--header "Content-Type:application/json" \
--data '{ "shape" : "oc4" }' \
https://dbaas.oraclecloud.com/paas/service/dbcs/api/v1.1/instances/usexample/db12c-ee

HTTP Status Code and Response Headers

HTTP/1.1 202 Accepted
Date: date-and-time-stamp
Server: Oracle-Application-Server-11g
Set-Cookie: OAMAuthnCookie_dbaas.oraclecloud.com:443=cookie-string
Location: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/status/scale/job/84380
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/usexample/db12c-ee
Vary: Accept-Encoding,User-Agent
Retry-After: 60
Content-Language: en
Content-Type: application/json

Back to Top