This objects represents a deployment including all clusters, hosts, services, roles, etc in the system. It can be used to save and restore all settings.
name | data type | description |
---|---|---|
timestamp | string | Readonly. This timestamp is provided when you request a deployment and is not required (or even read) when creating a deployment. This timestamp is useful if you have multiple deployments saved and want to determine which one to use as a restore point. |
clusters | array of ApiCluster | List of clusters in the system including their services, roles and complete config values. |
hosts | array of ApiHost | List of hosts in the system |
users | array of ApiUser | List of all users in the system |
versionInfo | ApiVersionInfo | Full version information about the running Cloudera Manager instance |
managementService | ApiService | The full configuration of the Cloudera Manager management service including all the management roles and their config values |
managerSettings | ApiConfigList | The full configuration of Cloudera Manager itself including licensing info |
allHostsConfig | ApiConfigList | Configuration parameters that apply to all hosts, unless overridden at the host level. Available since API v3. |
peers | array of ApiCmPeer | The list of peers configured in Cloudera Manager. Available since API v3. |
hostTemplates | ApiHostTemplateList | The list of all host templates in Cloudera Manager. |
Example
{ "timestamp" : "...", "clusters" : [ { "name" : "...", "displayName" : "...", "fullVersion" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "SERVICE" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : { }, "serviceState" : "STOPPED", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { }, { } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "ROLE" ], "config" : { }, "roles" : [ { }, { } ], "displayName" : "...", "roleConfigGroups" : [ { }, { } ], "replicationSchedules" : [ { }, { } ], "snapshotPolicies" : [ { }, { } ], "entityStatus" : "NONE", "tags" : [ { }, { } ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : { }, "serviceState" : "STARTED", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ { }, { } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "HOST" ], "config" : { }, "roles" : [ { }, { } ], "displayName" : "...", "roleConfigGroups" : [ { }, { } ], "replicationSchedules" : [ { }, { } ], "snapshotPolicies" : [ { }, { } ], "entityStatus" : "BAD_HEALTH", "tags" : [ { }, { } ], "serviceVersion" : "..." } ], "parcels" : [ { "product" : "...", "version" : "...", "stage" : "...", "state" : { }, "clusterRef" : { }, "displayName" : "...", "description" : "..." }, { "product" : "...", "version" : "...", "stage" : "...", "state" : { }, "clusterRef" : { }, "displayName" : "...", "description" : "..." } ], "clusterUrl" : "...", "hostsUrl" : "...", "entityStatus" : "STOPPED", "uuid" : "...", "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ], "clusterType" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "displayName" : "...", "fullVersion" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "CONTROL_PLANE" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : { }, "serviceState" : "STOPPING", "healthSummary" : "BAD", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ { }, { } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "CLUSTER" ], "config" : { }, "roles" : [ { }, { } ], "displayName" : "...", "roleConfigGroups" : [ { }, { } ], "replicationSchedules" : [ { }, { } ], "snapshotPolicies" : [ { }, { } ], "entityStatus" : "HISTORY_NOT_AVAILABLE", "tags" : [ { }, { } ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : { }, "serviceState" : "STOPPED", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ { }, { } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "CLUSTER" ], "config" : { }, "roles" : [ { }, { } ], "displayName" : "...", "roleConfigGroups" : [ { }, { } ], "replicationSchedules" : [ { }, { } ], "snapshotPolicies" : [ { }, { } ], "entityStatus" : "DOWN", "tags" : [ { }, { } ], "serviceVersion" : "..." } ], "parcels" : [ { "product" : "...", "version" : "...", "stage" : "...", "state" : { }, "clusterRef" : { }, "displayName" : "...", "description" : "..." }, { "product" : "...", "version" : "...", "stage" : "...", "state" : { }, "clusterRef" : { }, "displayName" : "...", "description" : "..." } ], "clusterUrl" : "...", "hostsUrl" : "...", "entityStatus" : "HISTORY_NOT_AVAILABLE", "uuid" : "...", "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ], "clusterType" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ], "hosts" : [ { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "BUSY" } ], "healthSummary" : "HISTORY_NOT_AVAILABLE", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "OFFLINED", "maintenanceOwners" : [ "CONTROL_PLANE", "SERVICE" ], "config" : { "items" : [ { }, { } ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "CONCERNING_HEALTH", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "UBUNTU_LUCID", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "BUSY" } ], "healthSummary" : "HISTORY_NOT_AVAILABLE", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "UNKNOWN", "maintenanceOwners" : [ "HOST", "ROLE" ], "config" : { "items" : [ { }, { } ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "STOPPED", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "RHEL5", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ], "users" : [ { "name" : "...", "password" : "...", "roles" : [ "...", "..." ], "pwHash" : "...", "pwSalt" : 12345, "pwLogin" : true }, { "name" : "...", "password" : "...", "roles" : [ "...", "..." ], "pwHash" : "...", "pwSalt" : 12345, "pwLogin" : true } ], "versionInfo" : { "version" : "...", "snapshot" : true, "buildUser" : "...", "buildTimestamp" : "...", "gitHash" : "..." }, "managementService" : { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STOPPING", "healthSummary" : "CONCERNING", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "CLUSTER" ], "config" : { "roleTypeConfigs" : [ { }, { } ], "items" : [ { }, { } ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : { }, "serviceRef" : { }, "roleState" : "STARTED", "commissionState" : "COMMISSIONED", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { }, { } ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "ROLE" ], "config" : { }, "roleConfigGroupRef" : { }, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "STOPPING", "tags" : [ { }, { } ] }, { "name" : "...", "type" : "...", "hostRef" : { }, "serviceRef" : { }, "roleState" : "BUSY", "commissionState" : "OFFLINING", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { }, { } ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "ROLE" ], "config" : { }, "roleConfigGroupRef" : { }, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "STOPPED", "tags" : [ { }, { } ] } ], "displayName" : "...", "roleConfigGroups" : [ { "name" : "...", "roleType" : "...", "base" : true, "config" : { }, "displayName" : "...", "serviceRef" : { } }, { "name" : "...", "roleType" : "...", "base" : true, "config" : { }, "displayName" : "...", "serviceRef" : { } } ], "replicationSchedules" : [ { "hdfsArguments" : { }, "hiveArguments" : { }, "hdfsCloudArguments" : { }, "ozoneReplicationArguments" : { }, "history" : [ { }, { } ], "active" : true, "hiveCloudArguments" : { }, "hbaseArguments" : { }, "hive3Arguments" : { }, "rangerArguments" : { }, "icebergArguments" : { }, "atlasReplicationArguments" : { }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "YEAR", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : { }, "hiveArguments" : { }, "hdfsCloudArguments" : { }, "ozoneReplicationArguments" : { }, "history" : [ { }, { } ], "active" : true, "hiveCloudArguments" : { }, "hbaseArguments" : { }, "hive3Arguments" : { }, "rangerArguments" : { }, "icebergArguments" : { }, "atlasReplicationArguments" : { }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "MONTH", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true } ], "snapshotPolicies" : [ { "name" : "...", "description" : "...", "hourlySnapshots" : 12345, "dailySnapshots" : 12345, "weeklySnapshots" : 12345, "monthlySnapshots" : 12345, "yearlySnapshots" : 12345, "minuteOfHour" : 12345, "hoursForHourlySnapshots" : [ 12345, 12345 ], "hourOfDay" : 12345, "dayOfWeek" : 12345, "dayOfMonth" : 12345, "monthOfYear" : 12345, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true, "hbaseArguments" : { }, "hdfsArguments" : { }, "ozoneArguments" : { }, "lastCommand" : { }, "lastSuccessfulCommand" : { }, "paused" : true }, { "name" : "...", "description" : "...", "hourlySnapshots" : 12345, "dailySnapshots" : 12345, "weeklySnapshots" : 12345, "monthlySnapshots" : 12345, "yearlySnapshots" : 12345, "minuteOfHour" : 12345, "hoursForHourlySnapshots" : [ 12345, 12345 ], "hourOfDay" : 12345, "dayOfWeek" : 12345, "dayOfMonth" : 12345, "monthOfYear" : 12345, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true, "hbaseArguments" : { }, "hdfsArguments" : { }, "ozoneArguments" : { }, "lastCommand" : { }, "lastSuccessfulCommand" : { }, "paused" : true } ], "entityStatus" : "UNKNOWN", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." }, "managerSettings" : { "items" : [ { "name" : "...", "value" : "...", "required" : true, "default" : "...", "displayName" : "...", "description" : "...", "relatedName" : "...", "sensitive" : true, "validationState" : "OK", "validationMessage" : "...", "validationWarningsSuppressed" : true }, { "name" : "...", "value" : "...", "required" : true, "default" : "...", "displayName" : "...", "description" : "...", "relatedName" : "...", "sensitive" : true, "validationState" : "OK", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "allHostsConfig" : { "items" : [ { "name" : "...", "value" : "...", "required" : true, "default" : "...", "displayName" : "...", "description" : "...", "relatedName" : "...", "sensitive" : true, "validationState" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true }, { "name" : "...", "value" : "...", "required" : true, "default" : "...", "displayName" : "...", "description" : "...", "relatedName" : "...", "sensitive" : true, "validationState" : "OK", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "peers" : [ { "name" : "...", "type" : "STATUS_AGGREGATION", "url" : "...", "username" : "...", "password" : "...", "clouderaManagerCreatedUser" : true, "createUserWithAdminRole" : true }, { "name" : "...", "type" : "STATUS_AGGREGATION", "url" : "...", "username" : "...", "password" : "...", "clouderaManagerCreatedUser" : true, "createUserWithAdminRole" : true } ], "hostTemplates" : { "items" : [ { "name" : "...", "clusterRef" : { }, "roleConfigGroupRefs" : [ { }, { } ] }, { "name" : "...", "clusterRef" : { }, "roleConfigGroupRefs" : [ { }, { } ] } ] } }