Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateCloudVmCluster

Updates the properties of the specified VM cluster.

Request Syntax


{
   "cloudVmClusterId": "string",
   "cpuCoreCount": number,
   "dataCollectionOptions": { 
      "isDiagnosticsEventsEnabled": boolean,
      "isHealthMonitoringEnabled": boolean,
      "isIncidentLogsEnabled": boolean
   },
   "dataStorageSizeInTBs": number,
   "dbNodeStorageSizeInGBs": number,
   "displayName": "string",
   "licenseModel": "string",
   "memorySizeInGBs": number,
   "sshPublicKeys": [ "string" ],
   "storageSizeInGBs": number
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

cloudVmClusterId

The unique identifier of the VM cluster to update.

Type: String

Length Constraints: Minimum length of 6. Maximum length of 64.

Pattern: [a-zA-Z0-9_~.-]+

Required: Yes

cpuCoreCount

The number of CPU cores to enable on the VM cluster. If you don't specify a value, the existing number of CPU cores is retained.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

dataCollectionOptions

The set of preferences for the diagnostic collection options for the VM cluster.

Type: DataCollectionOptions object

Required: No

dataStorageSizeInTBs

The size of the data disk group, in terabytes (TB), to allocate for the VM cluster.

Type: Double

Valid Range: Minimum value of 0.

Required: No

dbNodeStorageSizeInGBs

The amount of local node storage, in gigabytes (GB), to allocate for the VM cluster.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

displayName

A new user-friendly name for the VM cluster.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [a-zA-Z_](?!.*--)[a-zA-Z0-9_-]*

Required: No

licenseModel

The Oracle license model to apply to the VM cluster.

Type: String

Valid Values: BRING_YOUR_OWN_LICENSE | LICENSE_INCLUDED

Required: No

memorySizeInGBs

The amount of memory, in gigabytes (GB), to allocate for the VM cluster.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

sshPublicKeys

The public key portion of one or more key pairs used for SSH access to the VM cluster.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 1024 items.

Required: No

storageSizeInGBs

The amount of local node storage, in gigabytes (GB), to allocate to the VM cluster.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

Response Syntax


{
   "cloudVmClusterId": "string",
   "displayName": "string",
   "status": "string",
   "statusReason": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

cloudVmClusterId

The unique identifier of the updated VM cluster.

Type: String

displayName

The user-friendly name of the updated VM cluster.

Type: String

status

The current status of the VM cluster.

Type: String

statusReason

Additional information about the current status of the VM cluster, if applicable.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have sufficient access to perform this action. Make sure you have the required permissions and try again.

HTTP Status Code: 400

ConflictException

Occurs when a conflict with the current status of your resource. Fix any inconsistencies with your resource and try again.

resourceId: The identifier of the resource that caused the conflict.
resourceType: The type of resource that caused the conflict.

HTTP Status Code: 400

InternalServerException

Occurs when there is an internal failure in the Oracle Database@AWS service. Wait and try again.

retryAfterSeconds: The number of seconds to wait before retrying the request after an internal server error.

HTTP Status Code: 500

ResourceNotFoundException

The operation tried to access a resource that doesn't exist. Make sure you provided the correct resource and try again.

resourceId: The identifier of the resource that was not found.
resourceType: The type of resource that was not found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

retryAfterSeconds: The number of seconds to wait before retrying the request after being throttled.

HTTP Status Code: 400

ValidationException

The request has failed validation because it is missing required fields or has invalid inputs.

fieldList: A list of fields that failed validation.
reason: The reason why the validation failed.

HTTP Status Code: 400