Get Cluster ID
GET https://{{cluster-vip}}/irisservices/api/v1/public/cluster?fetchStats=true&fetchTimeSeriesSchema=true&includeMinimumNodesInfo=true
Returns information such as Cohesity cluster ID, number of nodes, created time, software version, and hardware model of the Cohesity Cluster.
The Cohesity cluster ID value is required for destroying the Cohesity cluster.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fetchStats | boolean | ||
fetchTimeSeriesSchema | boolean | ||
includeMinimumNodesInfo | boolean |
Request Body
[{"name"=>"fetchStats", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"fetchTimeSeriesSchema", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"includeMinimumNodesInfo", "value"=>"true", "datatype"=>"boolean"}]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | ||
Accept | string |
RESPONSES
status: OK
"{\n \"id\": {{cluster_ID}},\n \"incarnationId\": {{incarnation_id}},\n \"createdTimeMsecs\": 1674582711960,\n \"currentTimeMsecs\": 1674677397000,\n \"nodeCount\": 3,\n \"clusterSoftwareVersion\": \"6.6.0d_ent_release-20230118_735c1ab3\",\n \"targetSoftwareVersion\": \"6.6.0d_ent_release-20230118_735c1ab3\",\n \"currentOperation\": \"kNone\",\n \"hardwareInfo\": {\n \"hardwareModels\": [\n \"C5026\"\n ],\n \"hardwareVendors\": [\n \"Advantech\"\n ]\n },\n \"stats\": {\n \"id\": 5545431855964130,\n \"usagePerfStats\": {\n \"physicalCapacityBytes\": 72835348568229,\n \"systemCapacityBytes\": 75547059646464,\n \"totalPhysicalUsageBytes\": 1118208,\n \"totalPhysicalRawUsageBytes\": 1146880,\n \"systemUsageBytes\": 128732749824,\n \"dataInBytes\": 551957,\n \"dataInBytesAfterReduction\": 1141593,\n \"numBytesRead\": 0,\n \"numBytesWritten\": 0,\n \"readIos\": 0,\n \"writeIos\": 0,\n \"readLatencyMsecs\": 0,\n \"writeLatencyMsecs\": 0\n },\n \"localUsagePerfStats\": {\n \"physicalCapacityBytes\": 72835348568229,\n \"systemCapacityBytes\": 75547059646464,\n \"minUsablePhysicalCapacityBytes\": 72835348568229,\n \"totalPhysicalUsageBytes\": 1118208,\n \"totalPhysicalRawUsageBytes\": 1146880,\n \"systemUsageBytes\": 128732749824,\n \"numBytesRead\": 0,\n \"numBytesWritten\": 0,\n \"readIos\": 0,\n \"writeIos\": 0,\n \"readLatencyMsecs\": 0,\n \"writeLatencyMsecs\": 0\n },\n \"logicalStats\": {\n \"totalLogicalUsageBytes\": 29969\n },\n \"dataUsageStats\": {\n \"totalLogicalUsageBytes\": 29969,\n \"dataProtectLogicalUsageBytes\": 0,\n \"dataProtectPhysicalUsageBytes\": 0,\n \"fileServicesLogicalUsageBytes\": 0,\n \"fileServicesPhysicalUsageBytes\": 0,\n \"dataInBytes\": 551957,\n \"dataInBytesAfterDedup\": 1146880,\n \"dataWrittenBytes\": 1116376,\n \"localDataWrittenBytes\": 1116376,\n \"localTierResiliencyImpactBytes\": 0,\n \"localTotalPhysicalUsageBytes\": 1118208\n },\n \"dataReductionRatio\": 0.026800917181776556\n },\n \"encryptionEnabled\": false,\n \"eulaConfig\": {\n \"signedTime\": 1674597279,\n \"signedByUser\": \"admin\",\n \"signedVersion\": 4\n },\n \"licenseState\": {\n \"state\": \"kSkipped\",\n \"failedAttempts\": 1\n },\n \"clusterType\": \"kPhysical\",\n \"supportedConfig\": {\n \"minNodesAllowed\": 1\n },\n \"availableMetadataSpace\": 4416882962601,\n \"usedMetadataSpacePct\": 1.4585967068971621,\n \"proxyVMSubnet\": \"198.18.0.100/28\",\n \"name\": \"Cohesity cluster\",\n \"dnsServerIps\": [\n \"{{dns_ip}}\"\n ],\n \"domainNames\": [\n \"{{Domain_name}}\"\n ],\n \"reverseTunnelEnabled\": false,\n \"reverseTunnelEndTimeMsecs\": 0,\n \"enableUpgradePkgPolling\": false,\n \"enableActiveMonitoring\": true,\n \"clusterAuditLogConfig\": {\n \"enabled\": true,\n \"retentionPeriodDays\": 90\n },\n \"filerAuditLogConfig\": {\n \"enabled\": false,\n \"retentionPeriodDays\": 90\n },\n \"tieringAuditLogConfig\": {\n \"enabled\": false,\n \"retentionPeriodDays\": 90\n },\n \"isDocumentationLocal\": false,\n \"languageLocale\": \"en-us\",\n \"timezone\": \"UTC\",\n \"smbAdDisabled\": false,\n \"smbMultichannelEnabled\": true,\n \"turboMode\": false,\n \"ntpSettings\": {\n \"ntpServersInternal\": false,\n \"ntpAuthenticationEnabled\": false\n },\n \"multiTenancyEnabled\": false,\n \"tenantViewboxSharingEnabled\": false,\n \"metadataFaultToleranceFactor\": 0,\n \"faultToleranceLevel\": \"kNode\",\n \"appsSubnet\": {\n \"id\": 0,\n \"ip\": \"192.168.0.0\",\n \"netmaskBits\": 16,\n \"description\": \"Default apps subnet\",\n \"component\": \"athena\",\n \"nfsAccess\": \"kReadWrite\",\n \"smbAccess\": \"kReadWrite\",\n \"s3Access\": \"kReadWrite\"\n },\n \"googleAnalyticsEnabled\": true,\n \"pcieSsdTierRebalanceDelaySecs\": 900,\n \"kmsServerId\": 0,\n \"schemaInfoList\": [\n {\n \"key\": \"dataIn\",\n \"entityId\": \"Cohesity cluster (ID 5545431855964130)\",\n \"metricName\": \"BrickBytesLogical\",\n \"schemaName\": \"ApolloV2ClusterStats\"\n },\n {\n \"key\": \"dataWritten\",\n \"entityId\": \"Cohesity cluster (ID 5545431855964130)\",\n \"metricName\": \"ChunkBytesMorphed\",\n \"schemaName\": \"ApolloV2ClusterStats\"\n },\n {\n \"key\": \"storageConsumedLocalTier\",\n \"entityId\": \"5545431855964130:Local\",\n \"metricName\": \"kMorphedUsageBytes\",\n \"schemaName\": \"kBridgeClusterTierPhysicalStats\"\n },\n {\n \"key\": \"localResiliencyImpact\",\n \"entityId\": \"Cohesity cluster (ID 5545431855964130)\",\n \"metricName\": \"ResiliencyOverheadBytes:Local\",\n \"schemaName\": \"ApolloV2ClusterStats\"\n },\n {\n \"key\": \"logicalSize\",\n \"entityId\": \"5545431855964130\",\n \"metricName\": \"kUnmorphedUsageBytes\",\n \"schemaName\": \"kBridgeClusterLogicalStats\"\n }\n ],\n \"nodeIps\": \"{{Node1_IP}},{{Node2_IP}},{{Node3_IP}}\",\n \"ipPreference\": 1,\n \"chassisCount\": 1,\n \"assignedRacksCount\": 0,\n \"TenantId\": null,\n \"LocalTenantId\": null,\n \"RegionId\": null,\n \"minimumFailureDomainsNeeded\": 1,\n \"isClusterMfaEnabled\": false,\n \"diskCountByTier\": [\n {\n \"storageTier\": \"PCIeSSD\",\n \"diskCount\": 3\n },\n {\n \"storageTier\": \"SATA-HDD\",\n \"diskCount\": 9\n }\n ]\n}"