Get Cohesity Cluster ID

GET https{{cluster-vip}}/irisservices/api/v1/public/cluster

Returns information such as cluster ID, number of nodes, created time, software version, and hardware model of the Cohesity Cluster.

Request Body

[{"name"=>"fetchStats", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"fetchTimeSeriesSchema", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"includeMinimumNodesInfo", "value"=>"true", "datatype"=>"boolean"}]

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Acceptstring

RESPONSES

status: OK

"{\n    \"id\": {{cluster_id}},\n    \"incarnationId\": {{incarnation_id}},\n    \"createdTimeMsecs\": 1674582711960,\n    \"currentTimeMsecs\": 1674682863000,\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    \"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\": \"{{subnet_IP}}\",\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\": \"{{subnet_ip}}\",\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    \"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    \"isClusterMfaEnabled\": false,\n    \"diskCountByTier\": [\n        {\n            \"storageTier\": \"PCIeSSD\",\n            \"diskCount\": 3\n        },\n        {\n            \"storageTier\": \"SATA-HDD\",\n            \"diskCount\": 9\n        }\n    ]\n}"