# GetCloudVmCluster


Returns information about the specified VM cluster.

## Request Syntax


```
{
   "cloudVmClusterId": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [cloudVmClusterId](#API_GetCloudVmCluster_RequestSyntax) **   <a name="odb-GetCloudVmCluster-request-cloudVmClusterId"></a>
The unique identifier of the VM cluster.  
Type: String  
Length Constraints: Minimum length of 6. Maximum length of 64.  
Pattern: `[a-zA-Z0-9_~.-]+`   
Required: Yes

## Response Syntax


```
{
   "cloudVmCluster": { 
      "cloudExadataInfrastructureArn": "string",
      "cloudExadataInfrastructureId": "string",
      "cloudVmClusterArn": "string",
      "cloudVmClusterId": "string",
      "clusterName": "string",
      "computeModel": "string",
      "cpuCoreCount": number,
      "createdAt": "string",
      "dataCollectionOptions": { 
         "isDiagnosticsEventsEnabled": boolean,
         "isHealthMonitoringEnabled": boolean,
         "isIncidentLogsEnabled": boolean
      },
      "dataStorageSizeInTBs": number,
      "dbNodeStorageSizeInGBs": number,
      "dbServers": [ "string" ],
      "diskRedundancy": "string",
      "displayName": "string",
      "domain": "string",
      "giVersion": "string",
      "hostname": "string",
      "iamRoles": [ 
         { 
            "awsIntegration": "string",
            "iamRoleArn": "string",
            "status": "string",
            "statusReason": "string"
         }
      ],
      "iormConfigCache": { 
         "dbPlans": [ 
            { 
               "dbName": "string",
               "flashCacheLimit": "string",
               "share": number
            }
         ],
         "lifecycleDetails": "string",
         "lifecycleState": "string",
         "objective": "string"
      },
      "isLocalBackupEnabled": boolean,
      "isSparseDiskgroupEnabled": boolean,
      "lastUpdateHistoryEntryId": "string",
      "licenseModel": "string",
      "listenerPort": number,
      "memorySizeInGBs": number,
      "nodeCount": number,
      "ocid": "string",
      "ociResourceAnchorName": "string",
      "ociUrl": "string",
      "odbNetworkArn": "string",
      "odbNetworkId": "string",
      "percentProgress": number,
      "scanDnsName": "string",
      "scanDnsRecordId": "string",
      "scanIpIds": [ "string" ],
      "shape": "string",
      "sshPublicKeys": [ "string" ],
      "status": "string",
      "statusReason": "string",
      "storageSizeInGBs": number,
      "systemVersion": "string",
      "timeZone": "string",
      "vipIds": [ "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.

 ** [cloudVmCluster](#API_GetCloudVmCluster_ResponseSyntax) **   <a name="odb-GetCloudVmCluster-response-cloudVmCluster"></a>
The VM cluster.  
Type: [CloudVmCluster](API_CloudVmCluster.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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

 ** 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

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/odb-2024-08-20/GetCloudVmCluster) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/odb-2024-08-20/GetCloudVmCluster)