Get Cluster Host Metrics
get
/bdcsce/api/v1.1/clustermgmt/{identityDomainId}/instances/{clusterId}/metrics
Request
Path Parameters
-
clusterId: string
Identifier for the Cluster
-
identityDomainId: string
Identity domain ID of the Oracle Cloud Service instance, used for authentication.
Security
-
basicAuth: basic
Type:
basic
Response
200 Response
Nested Schema : ClusterMetrics
Type:
Show Source
object
-
activeNodes:
integer(int32)
Active Nodes in Cluster.
-
allocatedMB:
integer(int64)
Allocated memory in resource manager.
-
allocatedVirtualCores:
integer(int32)
Allocated virtual cores in resource manager.
-
appsCompleted:
integer(int32)
Number of jobs completed.
-
appsFailed:
integer(int32)
Number of jobs failed.
-
appsKilled:
integer(int32)
Number of jobs killed.
-
appsPending:
integer(int32)
Number of jobs pending.
-
appsRunning:
integer(int32)
Number of jobs running.
-
appsSubmitted:
integer(int32)
Number of jobs submitted.
-
availableMB:
integer(int64)
Available memory in resource manager.
-
availableVirtualCores:
integer(int32)
Available virtual cores in resource manager.
-
containersAllocated:
integer(int32)
Allocated Containers in resource manager.
-
containersPending:
integer(int32)
Pending Containers in resource manager.
-
containersReserved:
integer(int32)
Reserved Containers in resource manager.
-
decommissionedNodes:
integer(int32)
Decommissioned Nodes in Cluster.
-
lostNodes:
integer(int32)
Lost Nodes in Cluster.
-
rebootedNodes:
integer(int32)
Rebooted Nodes in Cluster.
-
reservedMB:
integer(int64)
Reserved memory in resource manager.
-
reservedVirtualCores:
integer(int32)
Reserved virtual cores in resource manager.
-
totalMB:
integer(int64)
Total Memory in resource manager.
-
totalNodes:
integer(int32)
Total Nodes in Cluster.
-
totalVirtualCores:
integer(int32)
Total Virtual Cores in resource manager.
-
unhealthyNodes:
integer(int32)
Unhealthy Nodes in Cluster.
-
workerNodes:
array workerNodes
Metrics of each Worker Node in the Cluster.
Nested Schema : ClusterWorkerNodeMetrics
Type:
Show Source
object
-
availableVirtualCores:
integer(int64)
The total number of vCores available on the node.
-
availMemoryMB:
integer(int64)
The total amount of memory currently available on the node (in MB).
-
healthReport:
string
Additional information on the health of this node.
-
healthStatus:
string
The health status of the node - Healthy or Unhealthy.
-
id:
string
The node id.
-
lastHealthUpdate:
integer(int64)
The last time the node reported its health (in ms since epoch).
-
nodeHostName:
string
The host name of the node.
-
nodeHTTPAddress:
string
The nodes HTTP address.
-
numContainers:
integer(int32)
The total number of containers currently running on the node.
-
rack(optional):
string
The rack location of this node.
-
state:
string
Allowed Values:
[ "NEW", "RUNNING", "UNHEALTHY", "DECOMMISSIONED", "LOST", "REBOOTED" ]
State of the node - valid values are: NEW, RUNNING, UNHEALTHY, DECOMMISSIONED, LOST, REBOOTED. -
usedMemoryMB:
integer(int64)
The total amount of memory currently used on the node (in MB).
-
usedVirtualCores:
integer(int64)
The total number of vCores currently used on the node.
Nested Schema : ClusterHostMetrics
Type:
Show Source
object
-
clusterName:
string
Name of the cluster.
-
cpuCount:
string
Number of CPUs.
-
hostName:
string
Name of the host.
-
isHealthy:
boolean
Default Value:
false
Is this Host healthy. -
totalMemoryMB:
integer(int64)
Memory on the host.
400 Response
List of errors related to the request.
404 Response
The Cluster Host Metrics was not found.
500 Response
An internal error occurred.
Root Schema : Error
Type:
Show Source
object
-
detail(optional):
string
detail
-
instance(optional):
string
instance
-
o:errorCode(optional):
string
Read Only:
true
error code -
o:errorDetails(optional):
array o:errorDetails
Read Only:
true
error details -
o:errorPath(optional):
string
Read Only:
true
error path -
status:
integer(int32)
status
-
title:
string
title
-
type(optional):
string
Read Only:
true
RFC Link