Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateExadbVmCluster

Updates the specified Exascale VM cluster.

Request Syntax


{
   "dataCollectionOptions": { 
      "isDiagnosticsEventsEnabled": boolean,
      "isHealthMonitoringEnabled": boolean,
      "isIncidentLogsEnabled": boolean
   },
   "displayName": "string",
   "enabledEcpuCount": number,
   "exadbVmClusterId": "string",
   "gridImageId": "string",
   "licenseModel": "string",
   "sshPublicKeys": [ "string" ],
   "systemVersion": "string",
   "totalEcpuCount": number,
   "updateAction": "string",
   "vmFileSystemStorageTotalSizeInGBs": 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.

dataCollectionOptions

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

Type: DataCollectionOptions object

Required: No

displayName

A new user-friendly name for the Exascale VM cluster.

Type: String

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

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

Required: No

enabledEcpuCount

The number of ECPUs to enable for the Exascale VM cluster.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

exadbVmClusterId

The unique identifier of the Exascale VM cluster to update.

Type: String

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

Pattern: (arn:(?:aws|aws-cn|aws-us-gov|aws-iso-{0,1}[a-z]{0,1}):[a-z0-9-]+:[a-z0-9-]*:[0-9]+:[a-z0-9-]+/[a-zA-Z0-9_~.-]{6,64}|[a-zA-Z0-9_~.-]{6,64})

Required: Yes

gridImageId

The Grid Infrastructure software image ID for the Exascale VM cluster.

Type: String

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

Required: No

licenseModel

The Oracle license model to apply to the Exascale VM cluster.

Type: String

Valid Values: BRING_YOUR_OWN_LICENSE | LICENSE_INCLUDED

Required: No

sshPublicKeys

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

Type: Array of strings

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

Required: No

systemVersion

The version of the operating system of the image for the Exascale VM cluster.

Type: String

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

Required: No

totalEcpuCount

The total number of ECPUs for the Exascale VM cluster.

Type: Integer

Valid Range: Minimum value of 2.

Required: No

updateAction

The update action to perform on the Exascale VM cluster.

Type: String

Valid Values: ROLLING_APPLY | NON_ROLLING_APPLY | PRECHECK | ROLLBACK

Required: No

vmFileSystemStorageTotalSizeInGBs

The total amount of file system storage, in gigabytes (GB), for the Exascale VM cluster.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

Response Syntax


{
   "displayName": "string",
   "exadbVmClusterId": "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.

displayName

The user-friendly name for the Exascale VM cluster.

Type: String

exadbVmClusterId

The unique identifier of the Exascale VM cluster.

Type: String

status

The current status of the Exascale VM cluster.

Type: String

statusReason

Additional information about the status of the Exascale VM cluster.

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