ApiDeployment2 Data Model

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. This model will be used v18 and beyond since users will be represented by ApiUser2 v18 and beyond.

Properties
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
authRoles array of ApiAuthRole List of all auth roles in the system Available from v32
externalUserMappings array of ApiExternalUserMapping List of all external user mappings in the system Available from v32
users array of ApiUser2 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.
dataContexts ApiDataContextList The list of all the data contexts in the Cloudera Manager.

Example

{
  "timestamp" : "...",
  "clusters" : [ {
    "name" : "...",
    "displayName" : "...",
    "fullVersion" : "...",
    "maintenanceMode" : true,
    "maintenanceOwners" : [ "SERVICE", "HOST" ],
    "services" : [ {
      "name" : "...",
      "type" : "...",
      "clusterRef" : { },
      "serviceState" : "STOPPING",
      "healthSummary" : "GOOD",
      "configStalenessStatus" : "STALE",
      "clientConfigStalenessStatus" : "STALE",
      "healthChecks" : [ { }, { } ],
      "serviceUrl" : "...",
      "roleInstancesUrl" : "...",
      "maintenanceMode" : true,
      "maintenanceOwners" : [ "ROLE", "HOST" ],
      "config" : { },
      "roles" : [ { }, { } ],
      "displayName" : "...",
      "roleConfigGroups" : [ { }, { } ],
      "replicationSchedules" : [ { }, { } ],
      "snapshotPolicies" : [ { }, { } ],
      "entityStatus" : "STARTING"
    }, {
      "name" : "...",
      "type" : "...",
      "clusterRef" : { },
      "serviceState" : "STARTING",
      "healthSummary" : "CONCERNING",
      "configStalenessStatus" : "STALE",
      "clientConfigStalenessStatus" : "STALE",
      "healthChecks" : [ { }, { } ],
      "serviceUrl" : "...",
      "roleInstancesUrl" : "...",
      "maintenanceMode" : true,
      "maintenanceOwners" : [ "ROLE", "HOST" ],
      "config" : { },
      "roles" : [ { }, { } ],
      "displayName" : "...",
      "roleConfigGroups" : [ { }, { } ],
      "replicationSchedules" : [ { }, { } ],
      "snapshotPolicies" : [ { }, { } ],
      "entityStatus" : "NONE"
    } ],
    "parcels" : [ {
      "product" : "...",
      "version" : "...",
      "stage" : "...",
      "state" : { },
      "clusterRef" : { }
    }, {
      "product" : "...",
      "version" : "...",
      "stage" : "...",
      "state" : { },
      "clusterRef" : { }
    } ],
    "clusterUrl" : "...",
    "hostsUrl" : "...",
    "entityStatus" : "HISTORY_NOT_AVAILABLE",
    "uuid" : "...",
    "dataContextRefs" : [ {
      "name" : "..."
    }, {
      "name" : "..."
    } ],
    "clusterType" : "..."
  }, {
    "name" : "...",
    "displayName" : "...",
    "fullVersion" : "...",
    "maintenanceMode" : true,
    "maintenanceOwners" : [ "ROLE", "ROLE" ],
    "services" : [ {
      "name" : "...",
      "type" : "...",
      "clusterRef" : { },
      "serviceState" : "UNKNOWN",
      "healthSummary" : "BAD",
      "configStalenessStatus" : "FRESH",
      "clientConfigStalenessStatus" : "STALE",
      "healthChecks" : [ { }, { } ],
      "serviceUrl" : "...",
      "roleInstancesUrl" : "...",
      "maintenanceMode" : true,
      "maintenanceOwners" : [ "HOST", "CLUSTER" ],
      "config" : { },
      "roles" : [ { }, { } ],
      "displayName" : "...",
      "roleConfigGroups" : [ { }, { } ],
      "replicationSchedules" : [ { }, { } ],
      "snapshotPolicies" : [ { }, { } ],
      "entityStatus" : "HISTORY_NOT_AVAILABLE"
    }, {
      "name" : "...",
      "type" : "...",
      "clusterRef" : { },
      "serviceState" : "STARTED",
      "healthSummary" : "BAD",
      "configStalenessStatus" : "STALE",
      "clientConfigStalenessStatus" : "STALE_REFRESHABLE",
      "healthChecks" : [ { }, { } ],
      "serviceUrl" : "...",
      "roleInstancesUrl" : "...",
      "maintenanceMode" : true,
      "maintenanceOwners" : [ "SERVICE", "ROLE" ],
      "config" : { },
      "roles" : [ { }, { } ],
      "displayName" : "...",
      "roleConfigGroups" : [ { }, { } ],
      "replicationSchedules" : [ { }, { } ],
      "snapshotPolicies" : [ { }, { } ],
      "entityStatus" : "STOPPED"
    } ],
    "parcels" : [ {
      "product" : "...",
      "version" : "...",
      "stage" : "...",
      "state" : { },
      "clusterRef" : { }
    }, {
      "product" : "...",
      "version" : "...",
      "stage" : "...",
      "state" : { },
      "clusterRef" : { }
    } ],
    "clusterUrl" : "...",
    "hostsUrl" : "...",
    "entityStatus" : "STOPPED",
    "uuid" : "...",
    "dataContextRefs" : [ {
      "name" : "..."
    }, {
      "name" : "..."
    } ],
    "clusterType" : "..."
  } ],
  "hosts" : [ {
    "hostId" : "...",
    "ipAddress" : "...",
    "hostname" : "...",
    "rackId" : "...",
    "lastHeartbeat" : "...",
    "roleRefs" : [ {
      "clusterName" : "...",
      "serviceName" : "...",
      "roleName" : "..."
    }, {
      "clusterName" : "...",
      "serviceName" : "...",
      "roleName" : "..."
    } ],
    "healthSummary" : "DISABLED",
    "healthChecks" : [ {
      "name" : "...",
      "summary" : "DISABLED",
      "explanation" : "...",
      "suppressed" : true
    }, {
      "name" : "...",
      "summary" : "CONCERNING",
      "explanation" : "...",
      "suppressed" : true
    } ],
    "hostUrl" : "...",
    "maintenanceMode" : true,
    "commissionState" : "OFFLINED",
    "maintenanceOwners" : [ "HOST", "HOST" ],
    "config" : {
      "items" : [ { }, { } ]
    },
    "numCores" : 12345,
    "numPhysicalCores" : 12345,
    "totalPhysMemBytes" : 12345,
    "entityStatus" : "GOOD_HEALTH",
    "clusterRef" : {
      "clusterName" : "...",
      "displayName" : "..."
    }
  }, {
    "hostId" : "...",
    "ipAddress" : "...",
    "hostname" : "...",
    "rackId" : "...",
    "lastHeartbeat" : "...",
    "roleRefs" : [ {
      "clusterName" : "...",
      "serviceName" : "...",
      "roleName" : "..."
    }, {
      "clusterName" : "...",
      "serviceName" : "...",
      "roleName" : "..."
    } ],
    "healthSummary" : "DISABLED",
    "healthChecks" : [ {
      "name" : "...",
      "summary" : "HISTORY_NOT_AVAILABLE",
      "explanation" : "...",
      "suppressed" : true
    }, {
      "name" : "...",
      "summary" : "GOOD",
      "explanation" : "...",
      "suppressed" : true
    } ],
    "hostUrl" : "...",
    "maintenanceMode" : true,
    "commissionState" : "OFFLINING",
    "maintenanceOwners" : [ "ROLE", "CLUSTER" ],
    "config" : {
      "items" : [ { }, { } ]
    },
    "numCores" : 12345,
    "numPhysicalCores" : 12345,
    "totalPhysMemBytes" : 12345,
    "entityStatus" : "DOWN",
    "clusterRef" : {
      "clusterName" : "...",
      "displayName" : "..."
    }
  } ],
  "authRoles" : [ {
    "displayName" : "...",
    "name" : "...",
    "clusters" : [ {
      "clusterName" : "...",
      "displayName" : "..."
    }, {
      "clusterName" : "...",
      "displayName" : "..."
    } ],
    "users" : [ {
      "name" : "..."
    }, {
      "name" : "..."
    } ],
    "externalUserMappings" : [ {
      "uuid" : "...",
      "name" : "...",
      "type" : "SAML_ATTRIBUTE"
    }, {
      "uuid" : "...",
      "name" : "...",
      "type" : "SAML_SCRIPT"
    } ],
    "baseRole" : {
      "displayName" : "...",
      "name" : "...",
      "uuid" : "..."
    },
    "uuid" : "...",
    "isCustom" : true
  }, {
    "displayName" : "...",
    "name" : "...",
    "clusters" : [ {
      "clusterName" : "...",
      "displayName" : "..."
    }, {
      "clusterName" : "...",
      "displayName" : "..."
    } ],
    "users" : [ {
      "name" : "..."
    }, {
      "name" : "..."
    } ],
    "externalUserMappings" : [ {
      "uuid" : "...",
      "name" : "...",
      "type" : "SAML_SCRIPT"
    }, {
      "uuid" : "...",
      "name" : "...",
      "type" : "EXTERNAL_PROGRAM"
    } ],
    "baseRole" : {
      "displayName" : "...",
      "name" : "...",
      "uuid" : "..."
    },
    "uuid" : "...",
    "isCustom" : true
  } ],
  "externalUserMappings" : [ {
    "name" : "...",
    "type" : "SAML_ATTRIBUTE",
    "uuid" : "...",
    "authRoles" : [ {
      "displayName" : "...",
      "name" : "...",
      "uuid" : "..."
    }, {
      "displayName" : "...",
      "name" : "...",
      "uuid" : "..."
    } ]
  }, {
    "name" : "...",
    "type" : "SAML_ATTRIBUTE",
    "uuid" : "...",
    "authRoles" : [ {
      "displayName" : "...",
      "name" : "...",
      "uuid" : "..."
    }, {
      "displayName" : "...",
      "name" : "...",
      "uuid" : "..."
    } ]
  } ],
  "users" : [ {
    "name" : "...",
    "password" : "...",
    "authRoles" : [ {
      "displayName" : "...",
      "name" : "...",
      "uuid" : "..."
    }, {
      "displayName" : "...",
      "name" : "...",
      "uuid" : "..."
    } ],
    "pwHash" : "...",
    "pwSalt" : 12345,
    "pwLogin" : true
  }, {
    "name" : "...",
    "password" : "...",
    "authRoles" : [ {
      "displayName" : "...",
      "name" : "...",
      "uuid" : "..."
    }, {
      "displayName" : "...",
      "name" : "...",
      "uuid" : "..."
    } ],
    "pwHash" : "...",
    "pwSalt" : 12345,
    "pwLogin" : true
  } ],
  "versionInfo" : {
    "version" : "...",
    "snapshot" : true,
    "buildUser" : "...",
    "buildTimestamp" : "...",
    "gitHash" : "..."
  },
  "managementService" : {
    "name" : "...",
    "type" : "...",
    "clusterRef" : {
      "clusterName" : "...",
      "displayName" : "..."
    },
    "serviceState" : "STARTED",
    "healthSummary" : "HISTORY_NOT_AVAILABLE",
    "configStalenessStatus" : "FRESH",
    "clientConfigStalenessStatus" : "STALE_REFRESHABLE",
    "healthChecks" : [ {
      "name" : "...",
      "summary" : "BAD",
      "explanation" : "...",
      "suppressed" : true
    }, {
      "name" : "...",
      "summary" : "BAD",
      "explanation" : "...",
      "suppressed" : true
    } ],
    "serviceUrl" : "...",
    "roleInstancesUrl" : "...",
    "maintenanceMode" : true,
    "maintenanceOwners" : [ "CLUSTER", "SERVICE" ],
    "config" : {
      "roleTypeConfigs" : [ { }, { } ],
      "items" : [ { }, { } ]
    },
    "roles" : [ {
      "name" : "...",
      "type" : "...",
      "hostRef" : { },
      "serviceRef" : { },
      "roleState" : "BUSY",
      "commissionState" : "OFFLINING",
      "healthSummary" : "CONCERNING",
      "configStalenessStatus" : "FRESH",
      "healthChecks" : [ { }, { } ],
      "haStatus" : "UNKNOWN",
      "roleUrl" : "...",
      "maintenanceMode" : true,
      "maintenanceOwners" : [ "SERVICE", "HOST" ],
      "config" : { },
      "roleConfigGroupRef" : { },
      "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION",
      "entityStatus" : "UNKNOWN_HEALTH"
    }, {
      "name" : "...",
      "type" : "...",
      "hostRef" : { },
      "serviceRef" : { },
      "roleState" : "STARTING",
      "commissionState" : "OFFLINED",
      "healthSummary" : "DISABLED",
      "configStalenessStatus" : "STALE",
      "healthChecks" : [ { }, { } ],
      "haStatus" : "STANDBY",
      "roleUrl" : "...",
      "maintenanceMode" : true,
      "maintenanceOwners" : [ "CLUSTER", "ROLE" ],
      "config" : { },
      "roleConfigGroupRef" : { },
      "zooKeeperServerMode" : "REPLICATED_FOLLOWER",
      "entityStatus" : "STOPPING"
    } ],
    "displayName" : "...",
    "roleConfigGroups" : [ {
      "name" : "...",
      "roleType" : "...",
      "base" : true,
      "config" : { },
      "displayName" : "...",
      "serviceRef" : { }
    }, {
      "name" : "...",
      "roleType" : "...",
      "base" : true,
      "config" : { },
      "displayName" : "...",
      "serviceRef" : { }
    } ],
    "replicationSchedules" : [ {
      "hdfsArguments" : { },
      "hiveArguments" : { },
      "hdfsCloudArguments" : { },
      "history" : [ { }, { } ],
      "active" : true,
      "hiveCloudArguments" : { },
      "id" : 12345,
      "displayName" : "...",
      "description" : "...",
      "startTime" : "...",
      "endTime" : "...",
      "interval" : 12345,
      "intervalUnit" : "WEEK",
      "nextRun" : "...",
      "paused" : true,
      "alertOnStart" : true,
      "alertOnSuccess" : true,
      "alertOnFail" : true,
      "alertOnAbort" : true
    }, {
      "hdfsArguments" : { },
      "hiveArguments" : { },
      "hdfsCloudArguments" : { },
      "history" : [ { }, { } ],
      "active" : true,
      "hiveCloudArguments" : { },
      "id" : 12345,
      "displayName" : "...",
      "description" : "...",
      "startTime" : "...",
      "endTime" : "...",
      "interval" : 12345,
      "intervalUnit" : "DAY",
      "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" : { },
      "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" : { },
      "lastCommand" : { },
      "lastSuccessfulCommand" : { },
      "paused" : true
    } ],
    "entityStatus" : "HISTORY_NOT_AVAILABLE"
  },
  "managerSettings" : {
    "items" : [ {
      "name" : "...",
      "value" : "...",
      "required" : true,
      "default" : "...",
      "displayName" : "...",
      "description" : "...",
      "relatedName" : "...",
      "sensitive" : true,
      "validationState" : "WARNING",
      "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" : "OK",
      "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
  }, {
    "name" : "...",
    "type" : "REPLICATION",
    "url" : "...",
    "username" : "...",
    "password" : "...",
    "clouderaManagerCreatedUser" : true
  } ],
  "hostTemplates" : {
    "items" : [ {
      "name" : "...",
      "clusterRef" : { },
      "roleConfigGroupRefs" : [ { }, { } ]
    }, {
      "name" : "...",
      "clusterRef" : { },
      "roleConfigGroupRefs" : [ { }, { } ]
    } ]
  },
  "dataContexts" : {
    "items" : [ {
      "name" : "...",
      "displayName" : "...",
      "nameservice" : "...",
      "createdTime" : "...",
      "lastModifiedTime" : "...",
      "services" : [ { }, { } ],
      "servicesDetails" : [ { }, { } ],
      "supportedServiceTypes" : [ "...", "..." ],
      "allowedClusterVersions" : [ { }, { } ],
      "configStalenessStatus" : "STALE",
      "clientConfigStalenessStatus" : "FRESH",
      "healthSummary" : "HISTORY_NOT_AVAILABLE"
    }, {
      "name" : "...",
      "displayName" : "...",
      "nameservice" : "...",
      "createdTime" : "...",
      "lastModifiedTime" : "...",
      "services" : [ { }, { } ],
      "servicesDetails" : [ { }, { } ],
      "supportedServiceTypes" : [ "...", "..." ],
      "allowedClusterVersions" : [ { }, { } ],
      "configStalenessStatus" : "STALE",
      "clientConfigStalenessStatus" : "STALE_REFRESHABLE",
      "healthSummary" : "CONCERNING"
    } ]
  }
}