Introduced in Cloudera Manager 7.8.1
\nCloudera Product Documentation
", "version" : "7.8.1", "title" : "Cloudera Manager API" }, "basePath" : "/api/v50", "schemes" : [], "tags" : [ { "name" : "ActivitiesResource" }, { "name" : "AllHostsResource" }, { "name" : "AuditsResource" }, { "name" : "AuthRoleMetadatasResource", "description" : "Returns a list of the auth roles' metadata for the built-in roles." }, { "name" : "AuthRolesResource" }, { "name" : "AuthServiceResource", "description" : "." }, { "name" : "AuthServiceRoleCommandsResource" }, { "name" : "AuthServiceRoleConfigGroupsResource" }, { "name" : "AuthServiceRolesResource" }, { "name" : "BatchResource", "description" : "Executes a batch of API requests in one database transaction." }, { "name" : "CdpResource", "description" : "Root resource for the CDPD Api calls." }, { "name" : "CertManagerResource" }, { "name" : "ClouderaManagerResource" }, { "name" : "ClustersResource", "description" : "The root of the Cloudera API (v5)." }, { "name" : "CmPeersResource" }, { "name" : "CommandsResource" }, { "name" : "ControlPlanesResource" }, { "name" : "CspResource", "description" : "Upload CA certificates, client certificates and client key for Credential Storage Provider." }, { "name" : "DashboardsResource" }, { "name" : "DataContextsResource" }, { "name" : "EventsResource" }, { "name" : "ExternalAccountsResource", "description" : "Manage external accounts used by various Cloudera Manager features, for\nperforming external tasks." }, { "name" : "ExternalUserMappingsResource" }, { "name" : "HostTemplatesResource" }, { "name" : "HostsResource" }, { "name" : "ImpalaQueriesResource" }, { "name" : "MgmtRoleCommandsResource" }, { "name" : "MgmtRoleConfigGroupsResource" }, { "name" : "MgmtRolesResource" }, { "name" : "MgmtServiceResource" }, { "name" : "NameservicesResource" }, { "name" : "ParcelResource", "description" : "This interface describes a parcel resource and all the operations that can\nbe performed on it." }, { "name" : "ParcelsResource" }, { "name" : "ProcessResource" }, { "name" : "ReplicationsResource" }, { "name" : "RoleCommandsResource" }, { "name" : "RoleConfigGroupsResource" }, { "name" : "RolesResource" }, { "name" : "ServicesResource" }, { "name" : "SnapshotsResource", "description" : "Available since API v6." }, { "name" : "TagsResource" }, { "name" : "TimeSeriesResource" }, { "name" : "ToolsResource" }, { "name" : "UsersResource" }, { "name" : "WatchedDirResource" }, { "name" : "YarnApplicationsResource" } ], "securityDefinitions" : { "basic" : { "type" : "basic" } }, "security" : [ { "basic" : [] } ], "definitions" : { "ApiActivity" : { "type" : "object", "title" : "ApiActivity", "properties" : { "name" : { "description" : "Activity name.", "type" : "string" }, "type" : { "description" : "Activity type. Whether it's an MR job, a Pig job, a Hive query, etc.", "$ref" : "#/definitions/ApiActivityType" }, "parent" : { "description" : "The name of the parent activity.", "type" : "string" }, "startTime" : { "description" : "The start time of this activity.", "type" : "string" }, "finishTime" : { "description" : "The finish time of this activity.", "type" : "string" }, "id" : { "description" : "Activity id, which is unique within a MapReduce service.", "type" : "string" }, "status" : { "description" : "Activity status.", "$ref" : "#/definitions/ApiActivityStatus" }, "user" : { "description" : "The user who submitted this activity.", "type" : "string" }, "group" : { "description" : "The user-group of this activity.", "type" : "string" }, "inputDir" : { "description" : "The input data directory of the activity. An HDFS url.", "type" : "string" }, "outputDir" : { "description" : "The output result directory of the activity. An HDFS url.", "type" : "string" }, "mapper" : { "description" : "The mapper class.", "type" : "string" }, "combiner" : { "description" : "The combiner class.", "type" : "string" }, "reducer" : { "description" : "The reducer class.", "type" : "string" }, "queueName" : { "description" : "The scheduler queue this activity is in.", "type" : "string" }, "schedulerPriority" : { "description" : "The scheduler priority of this activity.", "type" : "string" } }, "example" : { "name" : "...", "type" : "HIVE", "parent" : "...", "startTime" : "...", "finishTime" : "...", "id" : "...", "status" : "KILLED", "user" : "...", "group" : "...", "inputDir" : "...", "outputDir" : "...", "mapper" : "...", "combiner" : "...", "reducer" : "...", "queueName" : "...", "schedulerPriority" : "..." }, "description" : "Represents a user activity, such as a MapReduce job, a Hive query, an Oozie\nworkflow, etc." }, "ApiActivityList" : { "type" : "object", "title" : "ApiActivityList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiActivity" } } } } ], "example" : { "items" : [ { "name" : "...", "type" : "STREAMING", "parent" : "...", "startTime" : "...", "finishTime" : "...", "id" : "...", "status" : "SUBMITTED", "user" : "...", "group" : "...", "inputDir" : "...", "outputDir" : "...", "mapper" : "...", "combiner" : "...", "reducer" : "...", "queueName" : "...", "schedulerPriority" : "..." }, { "name" : "...", "type" : "PIG", "parent" : "...", "startTime" : "...", "finishTime" : "...", "id" : "...", "status" : "FAILED", "user" : "...", "group" : "...", "inputDir" : "...", "outputDir" : "...", "mapper" : "...", "combiner" : "...", "reducer" : "...", "queueName" : "...", "schedulerPriority" : "..." } ] }, "description" : "A generic list." }, "ApiActivityStatus" : { "type" : "string", "title" : "ApiActivityStatus", "enum" : [ "UNKNOWN", "SUBMITTED", "STARTED", "SUSPENDED", "FAILED", "KILLED", "SUCCEEDED", "ASSUMED_SUCCEEDED" ], "description" : "" }, "ApiActivityType" : { "type" : "string", "title" : "ApiActivityType", "enum" : [ "UNKNOWN", "OOZIE", "PIG", "HIVE", "MR", "STREAMING" ], "description" : "" }, "ApiAddCustomCertsArguments" : { "type" : "object", "title" : "ApiAddCustomCertsArguments", "properties" : { "location" : { "example" : "/opt/cloudera/CMCA", "description" : "The location on disk to store the CMCA directory. If there is already a CMCA created there,\nit will be backed up, and a new one will be created in its place.", "type" : "string" }, "interpretAsFilenames" : { "example" : true, "description" : "Whether the following arguments are interpreted as filenames local to the Cloudera Manager\nhost (true, default) or as the actual data for that argument:\n* hostCerts.hostCert\n* hostCerts.hostKey\n\nIf HTTPS has not been enabled on the Cloudera Manager Admin Console and API, we\n*strongly* recommend that you pass the arguments as filenames local to the Cloudera Manager\nhost (i.e. set to true) to avoid leaking sensitive information over the wire in plaintext.", "type" : "boolean" }, "hostCerts" : { "description" : "A list of HostCertInfo objects, which associate a hostname with the corresponding\ncertificate and private key. Only used if customCA == true.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHostCertInfo" } } }, "example" : { "location" : "/opt/cloudera/CMCA", "interpretAsFilenames" : true, "hostCerts" : [ { "hostname" : "...", "certificate" : "host-cert.pem", "key" : "host-key.pem", "subjectAltNames" : [ "DNS:example.cloudera.com", "..." ] }, { "hostname" : "...", "certificate" : "...", "key" : "...", "subjectAltNames" : [ "...", "DNS:example.cloudera.com" ] } ] }, "description" : "Arguments to add custom certificates to the Auto-TLS certificate database" }, "ApiAddSBNNToNSArguments" : { "type" : "object", "title" : "ApiAddSBNNToNSArguments", "properties" : { "nameServiceName" : { "description" : "The name of the NameService to which the new NameNode(s) should be added.", "type" : "string" }, "newNNHostIds" : { "description" : "List of host ids to which new NameNode(s) should be added.", "type" : "array", "items" : { "type" : "string" } }, "newNNDataDirs" : { "description" : "Mapping of NameNode Data Directories list to host id(s), key is the host id, the value is\na comma separated list of directories to be set as NameNode Data Directories for the new\nNameNode(s).", "type" : "object", "additionalProperties" : { "type" : "string" } }, "clearDataDirs" : { "description" : "Specifies whether the NameNode Data Directories configured should be cleared as a first step,\nor the command should fail if the directories specified are not empty.", "type" : "boolean" }, "restartCluster" : { "description" : "Specifies whether the HDFS dependent services of the cluster should be restarted after the\nchanges are applied, to reconfigure dependent services", "type" : "boolean" } }, "example" : { "nameServiceName" : "...", "newNNHostIds" : [ "...", "..." ], "newNNDataDirs" : { "property1" : "...", "property2" : "..." }, "clearDataDirs" : true, "restartCluster" : true }, "description" : "" }, "ApiAdhocHBaseSnapshot" : { "type" : "object", "title" : "ApiAdhocHBaseSnapshot", "properties" : { "sourceAccount" : { "description" : "", "type" : "string" }, "sourceTable" : { "description" : "", "type" : "string" }, "sourceSchedulerPool" : { "description" : "", "type" : "string" }, "sourceService" : { "description" : "", "$ref" : "#/definitions/ApiServiceRef" }, "sourceNumMappers" : { "description" : "", "type" : "integer" } }, "example" : { "sourceAccount" : "...", "sourceTable" : "...", "sourceSchedulerPool" : "...", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourceNumMappers" : 12345 }, "description" : "An HBase snapshot descriptor." }, "ApiAdhocSnapshot" : { "type" : "object", "title" : "ApiAdhocSnapshot", "properties" : { "snapshotName" : { "description" : "Snapshot name.", "type" : "string" }, "hbaseSnapshot" : { "description" : "", "$ref" : "#/definitions/ApiAdhocHBaseSnapshot" } }, "example" : { "snapshotName" : "...", "hbaseSnapshot" : { "sourceAccount" : "...", "sourceTable" : "...", "sourceSchedulerPool" : "...", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourceNumMappers" : 12345 } }, "description" : "An adhoc snapshot descriptor." }, "ApiAudit" : { "type" : "object", "title" : "ApiAudit", "properties" : { "timestamp" : { "description" : "When the audit event was captured.", "type" : "string" }, "service" : { "description" : "Service name associated with this audit.", "type" : "string" }, "username" : { "description" : "The user who performed this operation.", "type" : "string" }, "impersonator" : { "description" : "The impersonating user (or the proxy user) who submitted this operation.\nThis is usually applicable when using services like Oozie or Hue, who\ncan be configured to impersonate other users and submit jobs.", "type" : "string" }, "ipAddress" : { "description" : "The IP address that the client connected from.", "type" : "string" }, "command" : { "description" : "The command/operation that was requested.", "type" : "string" }, "resource" : { "description" : "The resource that the operation was performed on.", "type" : "string" }, "operationText" : { "description" : "The full text of the requested operation. E.g. the full Hive query.\n\nAvailable since API v5.", "type" : "string" }, "allowed" : { "description" : "Whether the operation was allowed or denied by the authorization system.", "type" : "boolean" }, "serviceValues" : { "description" : "", "type" : "object", "additionalProperties" : { "type" : "string" } } }, "example" : { "timestamp" : "...", "service" : "...", "username" : "...", "impersonator" : "...", "ipAddress" : "...", "command" : "...", "resource" : "...", "operationText" : "...", "allowed" : true, "serviceValues" : { "property1" : "...", "property2" : "..." } }, "description" : "Models audit events from both CM and CM managed services like HDFS, HBase\nand Hive. Audits for CM managed services are retrieved from Cloudera Navigator\nserver." }, "ApiAuditList" : { "type" : "object", "title" : "ApiAuditList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiAudit" } } } } ], "example" : { "items" : [ { "timestamp" : "...", "service" : "...", "username" : "...", "impersonator" : "...", "ipAddress" : "...", "command" : "...", "resource" : "...", "operationText" : "...", "allowed" : true, "serviceValues" : { "property1" : "...", "property2" : "..." } }, { "timestamp" : "...", "service" : "...", "username" : "...", "impersonator" : "...", "ipAddress" : "...", "command" : "...", "resource" : "...", "operationText" : "...", "allowed" : true, "serviceValues" : { "property1" : "...", "property2" : "..." } } ] }, "description" : "A generic list." }, "ApiAuthRole" : { "type" : "object", "title" : "ApiAuthRole", "properties" : { "displayName" : { "description" : "", "type" : "string" }, "name" : { "description" : "", "type" : "string" }, "clusters" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiClusterRef" } }, "users" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiUser2Ref" } }, "externalUserMappings" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiExternalUserMappingRef" } }, "baseRole" : { "description" : "A role this user possesses.\nIn Cloudera Enterprise Datahub Edition, possible values are:\n
", "$ref" : "#/definitions/ApiAuthRoleRef" }, "uuid" : { "description" : "Readonly. The UUID of the authRole.\n
", "type" : "string" }, "isCustom" : { "description" : "", "type" : "boolean" } }, "example" : { "displayName" : "...", "name" : "...", "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "users" : [ { "name" : "..." }, { "name" : "..." } ], "externalUserMappings" : [ { "uuid" : "...", "name" : "...", "type" : "LDAP" }, { "uuid" : "...", "name" : "...", "type" : "SAML_SCRIPT" } ], "baseRole" : { "displayName" : "...", "name" : "...", "uuid" : "..." }, "uuid" : "...", "isCustom" : true }, "description" : "This is the model for user role scope in the API since v18.\nThis is used to support granular permissions." }, "ApiAuthRoleAuthority" : { "type" : "object", "title" : "ApiAuthRoleAuthority", "properties" : { "name" : { "description" : "The name of the authority.", "type" : "string" }, "description" : { "description" : "The description of the authority.", "type" : "string" } }, "example" : { "name" : "...", "description" : "..." }, "description" : "This represents an authority with a name\nand description." }, "ApiAuthRoleList" : { "type" : "object", "title" : "ApiAuthRoleList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiAuthRole" } } } } ], "example" : { "items" : [ { "displayName" : "...", "name" : "...", "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "users" : [ { "name" : "..." }, { "name" : "..." } ], "externalUserMappings" : [ { "uuid" : "...", "name" : "...", "type" : "SAML_SCRIPT" }, { "uuid" : "...", "name" : "...", "type" : "SAML_ATTRIBUTE" } ], "baseRole" : { "displayName" : "...", "name" : "...", "uuid" : "..." }, "uuid" : "...", "isCustom" : true }, { "displayName" : "...", "name" : "...", "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "users" : [ { "name" : "..." }, { "name" : "..." } ], "externalUserMappings" : [ { "uuid" : "...", "name" : "...", "type" : "SAML_ATTRIBUTE" }, { "uuid" : "...", "name" : "...", "type" : "SAML_ATTRIBUTE" } ], "baseRole" : { "displayName" : "...", "name" : "...", "uuid" : "..." }, "uuid" : "...", "isCustom" : true } ] }, "description" : "A list of auth roles." }, "ApiAuthRoleMetadata" : { "type" : "object", "title" : "ApiAuthRoleMetadata", "properties" : { "displayName" : { "description" : "", "type" : "string" }, "uuid" : { "description" : "", "type" : "string" }, "role" : { "description" : "", "type" : "string" }, "authorities" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiAuthRoleAuthority" } }, "allowedScopes" : { "description" : "", "type" : "array", "items" : { "type" : "string" } } }, "example" : { "displayName" : "...", "uuid" : "...", "role" : "...", "authorities" : [ { "name" : "...", "description" : "..." }, { "name" : "...", "description" : "..." } ], "allowedScopes" : [ "...", "..." ] }, "description" : "This is the model for auth role metadata" }, "ApiAuthRoleMetadataList" : { "type" : "object", "title" : "ApiAuthRoleMetadataList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiAuthRoleMetadata" } } } } ], "example" : { "items" : [ { "displayName" : "...", "uuid" : "...", "role" : "...", "authorities" : [ { "name" : "...", "description" : "..." }, { "name" : "...", "description" : "..." } ], "allowedScopes" : [ "...", "..." ] }, { "displayName" : "...", "uuid" : "...", "role" : "...", "authorities" : [ { "name" : "...", "description" : "..." }, { "name" : "...", "description" : "..." } ], "allowedScopes" : [ "...", "..." ] } ] }, "description" : "A list of auth roles metadata." }, "ApiAuthRoleRef" : { "type" : "object", "title" : "ApiAuthRoleRef", "properties" : { "displayName" : { "description" : "The display name of the authRole.\ndisplayName is optional. If a changed displayName is passed\nin, it will be ignored.", "type" : "string" }, "name" : { "description" : "The name of the authRole.\nname is available from v32. It is optional, and cannot be\nmodified. Name takes precedence over uuid. If name is absent,\nuuid will be used for look up.", "type" : "string" }, "uuid" : { "description" : "The uuid of the authRole, which uniquely identifies it in a CM installation.", "type" : "string" } }, "example" : { "displayName" : "...", "name" : "...", "uuid" : "..." }, "description" : "An authRoleRef to operate on ApiAuthRole object" }, "ApiBatchRequest" : { "type" : "object", "title" : "ApiBatchRequest", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiBatchRequestElement" } } } } ], "example" : { "items" : [ { "method" : "PUT", "url" : "...", "body" : {}, "contentType" : "...", "acceptType" : "..." }, { "method" : "DELETE", "url" : "...", "body" : {}, "contentType" : "...", "acceptType" : "..." } ] }, "description" : "A batch request, comprised of one or more request elements." }, "ApiBatchRequestElement" : { "type" : "object", "title" : "ApiBatchRequestElement", "properties" : { "method" : { "description" : "The type of request (e.g. POST, GET, etc.).", "$ref" : "#/definitions/HTTPMethod" }, "url" : { "description" : "The URL of the request. Must not have a scheme, host, or port. The path\nshould be prefixed with \"/api/\", and should include path and query\nparameters.", "type" : "string" }, "body" : { "description" : "Optional body of the request. Must be serialized in accordance with\n#getContentType(). For application/json, use\ncom.cloudera.api.ApiObjectMapper.", "type" : "object" }, "contentType" : { "description" : "Content-Type header of the request element. If unset, the element will be\ntreated as if the wildcard type had been specified unless it has a body,\nin which case it will fall back to application/json.", "type" : "string" }, "acceptType" : { "description" : "Accept header of the request element. The response body (if it exists)\nwill be in this representation. If unset, the element will be treated as\nif the wildcard type had been requested.", "type" : "string" } }, "example" : { "method" : "DELETE", "url" : "...", "body" : {}, "contentType" : "...", "acceptType" : "..." }, "description" : "A single element of a batch request, often part of a list with other\nelements." }, "ApiBatchResponse" : { "type" : "object", "title" : "ApiBatchResponse", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiBatchResponseElement" } }, "success" : { "description" : "Read-only. True if every response element's\nApiBatchResponseElement#getStatusCode() is in the range [200, 300),\nfalse otherwise.", "type" : "boolean" } } } ], "example" : { "items" : [ { "statusCode" : 12345, "response" : {} }, { "statusCode" : 12345, "response" : {} } ], "success" : true }, "description" : "A batch response, comprised of one or more response elements." }, "ApiBatchResponseElement" : { "type" : "object", "title" : "ApiBatchResponseElement", "properties" : { "statusCode" : { "description" : "Read-only. The HTTP status code of the response.", "type" : "integer" }, "response" : { "description" : "Read-only. The (optional) serialized body of the response, in the\nrepresentation produced by the corresponding API endpoint, such as\napplication/json.", "type" : "object" } }, "example" : { "statusCode" : 12345, "response" : {} }, "description" : "A single element of a batch response, often part of a list with other\nelements." }, "ApiBulkCommandList" : { "type" : "object", "title" : "ApiBulkCommandList", "allOf" : [ { "$ref" : "#/definitions/ApiCommandList" }, { "properties" : { "errors" : { "description" : "Errors that occurred when issuing individual commands.", "type" : "array", "items" : { "type" : "string" } } } } ], "example" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] }, "description" : "A list of commands.\n
\nThis list is returned whenever commands are issued in bulk, and contains a\nsecond list with information about errors issuing specific commands." }, "ApiCdhUpgradeArgs" : { "type" : "object", "title" : "ApiCdhUpgradeArgs", "properties" : { "cdhParcelVersion" : { "description" : "If using parcels, the full version of an already distributed\nparcel for the next major CDH version. Default is null, which\nindicates this is a package upgrade. Example versions are:\n'5.0.0-1.cdh5.0.0.p0.11' or '5.0.2-1.cdh5.0.2.p0.32'", "type" : "string" }, "cdhPackageVersion" : { "description" : "If using packages, the full version of the CDH packages being upgraded to,\nsuch as \"5.1.2\". These packages must already be installed on the cluster\nbefore running the upgrade command. For backwards compatibility, if\n\"5.0.0\" is specified here, then the upgrade command will relax validation\nof installed packages to match v6 behavior, only checking major version.\n
\nIntroduced in v9. Has no effect in older API versions, which assume\n\"5.0.0\"", "type" : "string" }, "rollingRestartArgs" : { "description" : "If provided and rolling restart is available, will perform\nrolling restart with the requested arguments. If provided and\nrolling restart is not available, errors. If omitted, will do a\nregular restart.\n
\nIntroduced in v9. Has no effect in older API versions, which must\nalways do a hard restart.", "$ref" : "#/definitions/ApiRollingUpgradeClusterArgs" }, "deployClientConfig" : { "description" : "Not used starting in v9 - Client config is always deployed as part of\nupgrade. For older versions, determines whether client configuration\nshould be deployed as part of upgrade. Default is true.", "type" : "boolean" }, "startAllServices" : { "description" : "Not used starting in v9 - All servies are always started as part of\nupgrade. For older versions, determines whether all services should be\nstarted should be deployed as part of upgrade. Default is true.", "type" : "boolean" } }, "example" : { "cdhParcelVersion" : "...", "cdhPackageVersion" : "...", "rollingRestartArgs" : { "slaveBatchSize" : 12345, "sleepSeconds" : 12345, "slaveFailCountThreshold" : 12345 } }, "description" : "Arguments used for the CDH Upgrade command." }, "ApiCertificateRequest" : { "type" : "object", "title" : "ApiCertificateRequest", "properties" : { "hostname" : { "description" : "Get the hostname of the host requesting certificates", "type" : "string" }, "csr" : { "description" : "Get the certificate signing request in PEM format", "type" : "string" }, "token" : { "description" : "Get the certificate request token", "type" : "string" }, "subjectAltNames" : { "description" : "", "type" : "array", "items" : { "type" : "string" } } }, "example" : { "hostname" : "...", "csr" : "...", "token" : "...", "subjectAltNames" : [ "...", "..." ] }, "description" : "This API class represents a request to retrieve Auto-TLS certificates for a\ngiven host. The request contains the host requesting the certificate, a\nvalid token generated by the certmanager utility, and optionally a\ncertificate signing request.\n\nCurrently, the certificate signing request argument is not supported." }, "ApiCluster" : { "type" : "object", "title" : "ApiCluster", "properties" : { "name" : { "description" : "The name of the cluster.\n
\nImmutable since API v6.\n
\nPrior to API v6, will contain the display name of the cluster.", "type" : "string" }, "displayName" : { "description" : "The display name of the cluster that is shown in the UI.\n
\nAvailable since API v6.", "type" : "string" }, "version" : { "description" : "The CDH version of the cluster.", "$ref" : "#/definitions/ApiClusterVersion" }, "fullVersion" : { "description" : "The full CDH version of the cluster. The expected format is three dot\nseparated version numbers, e.g. \"4.2.1\" or \"5.0.0\". The full version takes\nprecedence over the version field during cluster creation.\n
\nAvailable since API v6.", "type" : "string" }, "maintenanceMode" : { "description" : "Readonly. Whether the cluster is in maintenance mode.\nAvailable since API v2.", "type" : "boolean" }, "maintenanceOwners" : { "description" : "Readonly. The list of objects that trigger this cluster to be in\nmaintenance mode.\nAvailable since API v2.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityType" } }, "services" : { "description" : "Optional. Used during import/export of settings.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiService" } }, "parcels" : { "description" : "Optional. Used during import/export of settings.\nAvailable since API v4.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiParcel" } }, "clusterUrl" : { "description" : "Readonly. Link into the Cloudera Manager web UI for this specific cluster.\n
\nAvailable since API v10.", "type" : "string" }, "hostsUrl" : { "description" : "Readonly. Link into the Cloudera Manager web UI for host table for this cluster.\n
\nAvailable since API v11.", "type" : "string" }, "entityStatus" : { "description" : "Readonly. The entity status for this cluster.\nAvailable since API v11.", "$ref" : "#/definitions/ApiEntityStatus" }, "uuid" : { "description" : "Readonly. The UUID of the cluster.\n
\nAvailable since API v15.", "type" : "string" }, "dataContextRefs" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiDataContextRef" } }, "clusterType" : { "description" : "The type of cluster. If unspecified, defaults to either BASE_CLUSTER (if no data contexts are provided)\nor COMPUTE_CLUSTER (if one or more data contexts are provided).\nAvailable since APIv32.", "type" : "string" }, "tags" : { "description" : "Tags associated with the cluster.\nAvailable since V41.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } } }, "example" : { "name" : "...", "displayName" : "...", "fullVersion" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "ROLE" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STOPPING", "healthSummary" : "BAD", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "SERVICE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "UNKNOWN", "commissionState" : "DECOMMISSIONING", "healthSummary" : "BAD", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "CLUSTER" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION", "entityStatus" : "NONE", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "HISTORY_NOT_AVAILABLE", "commissionState" : "DECOMMISSIONING", "healthSummary" : "CONCERNING", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "CLUSTER" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER", "entityStatus" : "GOOD_HEALTH", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "DAY", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "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" : "UNKNOWN", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STOPPING", "healthSummary" : "BAD", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "SERVICE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "UNKNOWN", "commissionState" : "OFFLINED", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "CLUSTER" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "DOWN", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPED", "commissionState" : "OFFLINING", "healthSummary" : "BAD", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "HOST" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION", "entityStatus" : "DISABLED_HEALTH", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "WEEK", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "WEEK", "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" : "STARTING", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." } ], "parcels" : [ { "product" : "...", "version" : "...", "stage" : "...", "state" : { "progress" : 12345, "totalProgress" : 12345, "count" : 12345, "totalCount" : 12345, "errors" : [ "...", "..." ], "warnings" : [ "...", "..." ] }, "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "displayName" : "...", "description" : "..." }, { "product" : "...", "version" : "...", "stage" : "...", "state" : { "progress" : 12345, "totalProgress" : 12345, "count" : 12345, "totalCount" : 12345, "errors" : [ "...", "..." ], "warnings" : [ "...", "..." ] }, "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "displayName" : "...", "description" : "..." } ], "clusterUrl" : "...", "hostsUrl" : "...", "entityStatus" : "STARTING", "uuid" : "...", "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ], "clusterType" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, "description" : "A cluster represents a set of interdependent services running on a set\nof hosts. All services on a given cluster are of the same software version\n(e.g. CDH4 or CDH5)." }, "ApiClusterList" : { "type" : "object", "title" : "ApiClusterList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiCluster" } } } } ], "example" : { "items" : [ { "name" : "...", "displayName" : "...", "fullVersion" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "CLUSTER" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "HISTORY_NOT_AVAILABLE", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "SERVICE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "BAD_HEALTH", "tags" : [ {}, {} ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "NA", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "CONTROL_PLANE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "STARTING", "tags" : [ {}, {} ], "serviceVersion" : "..." } ], "parcels" : [ { "product" : "...", "version" : "...", "stage" : "...", "state" : {}, "clusterRef" : {}, "displayName" : "...", "description" : "..." }, { "product" : "...", "version" : "...", "stage" : "...", "state" : {}, "clusterRef" : {}, "displayName" : "...", "description" : "..." } ], "clusterUrl" : "...", "hostsUrl" : "...", "entityStatus" : "DOWN", "uuid" : "...", "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ], "clusterType" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "displayName" : "...", "fullVersion" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "CLUSTER" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "STOPPED", "healthSummary" : "BAD", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "SERVICE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "GOOD_HEALTH", "tags" : [ {}, {} ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "UNKNOWN", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "CONTROL_PLANE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "NONE", "tags" : [ {}, {} ], "serviceVersion" : "..." } ], "parcels" : [ { "product" : "...", "version" : "...", "stage" : "...", "state" : {}, "clusterRef" : {}, "displayName" : "...", "description" : "..." }, { "product" : "...", "version" : "...", "stage" : "...", "state" : {}, "clusterRef" : {}, "displayName" : "...", "description" : "..." } ], "clusterUrl" : "...", "hostsUrl" : "...", "entityStatus" : "CONCERNING_HEALTH", "uuid" : "...", "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ], "clusterType" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] }, "description" : "A list of clusters." }, "ApiClusterNameList" : { "type" : "object", "title" : "ApiClusterNameList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "type" : "string" } } } } ], "example" : { "items" : [ "...", "..." ] }, "description" : "A list of cluster names." }, "ApiClusterPerfInspectorArgs" : { "type" : "object", "title" : "ApiClusterPerfInspectorArgs", "properties" : { "pingArgs" : { "description" : "Optional ping request arguments.\nIf not specified, default arguments will be used for ping test.", "$ref" : "#/definitions/ApiPerfInspectorPingArgs" } }, "example" : { "pingArgs" : { "pingTimeoutSecs" : 10, "pingCount" : 10, "pingPacketSizeBytes" : 56 } }, "description" : "Arguments used for the Cluster Performance Inspector" }, "ApiClusterRef" : { "type" : "object", "title" : "ApiClusterRef", "properties" : { "clusterName" : { "description" : "The name of the cluster, which uniquely identifies it in a CM installation.", "type" : "string" }, "displayName" : { "description" : "The display name of the cluster. This is available from v30.", "type" : "string" } }, "example" : { "clusterName" : "...", "displayName" : "..." }, "description" : "A clusterRef references a cluster. To operate on the cluster object,\nuse the cluster API with the clusterName as the parameter." }, "ApiClusterSupportToken" : { "type" : "object", "title" : "ApiClusterSupportToken", "properties" : { "clusterName" : { "description" : "The name of the cluster.\n
\nImmutable since API v6.\n
\nPrior to API v6, will contain the display name of the cluster.", "type" : "string" }, "displayName" : { "description" : "The display name of the cluster that is shown in the UI.\n
\nAvailable since API v6.", "type" : "string" }, "clusterSupportToken" : { "description" : "The unique support token for a cluster.\n
\nAvailable since API v43.", "type" : "string" } }, "example" : { "clusterName" : "...", "displayName" : "...", "clusterSupportToken" : "..." }, "description" : "Information about a cluster support token.\n
\nThe cluster support token indicates the current usage of a cluster managed by Cloudera Manager.\nThe cluster support token is an ASCII encoded string of 32 characters. It is unique to each cluster." }, "ApiClusterSupportTokenList" : { "type" : "object", "title" : "ApiClusterSupportTokenList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiClusterSupportToken" } } } } ], "example" : { "items" : [ { "clusterName" : "...", "displayName" : "...", "clusterSupportToken" : "..." }, { "clusterName" : "...", "displayName" : "...", "clusterSupportToken" : "..." } ] }, "description" : "A list of cluster support tokens." }, "ApiClusterTemplate" : { "type" : "object", "title" : "ApiClusterTemplate", "properties" : { "cdhVersion" : { "description" : "CDH version", "type" : "string" }, "experienceVersion" : { "description" : "Deprecated. Use dataServicesVersion instead.", "type" : "string" }, "dataServicesVersion" : { "description" : "Data Services version", "type" : "string" }, "products" : { "description" : "All the parcels that needs to be deployed and activated", "type" : "array", "items" : { "$ref" : "#/definitions/ApiProductVersion" } }, "services" : { "description" : "All the services that needs to be deployed", "type" : "array", "items" : { "$ref" : "#/definitions/ApiClusterTemplateService" } }, "hostTemplates" : { "description" : "All host templates", "type" : "array", "items" : { "$ref" : "#/definitions/ApiClusterTemplateHostTemplate" } }, "displayName" : { "description" : "Cluster display name", "type" : "string" }, "cmVersion" : { "description" : "CM version for which the template", "type" : "string" }, "instantiator" : { "description" : "A constructor listing all the variables and references that needs to be\nresolved for this template", "$ref" : "#/definitions/ApiClusterTemplateInstantiator" }, "repositories" : { "description" : "List of all repositories registered with CM", "type" : "array", "items" : { "type" : "string" } }, "clusterSpec" : { "description" : "Cluster specification.", "$ref" : "#/definitions/ApiClusterTemplateClusterSpec" }, "tags" : { "description" : "Tags associated with the cluster", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } } }, "example" : { "cdhVersion" : "...", "experienceVersion" : "...", "dataServicesVersion" : "...", "products" : [ { "version" : "...", "product" : "..." }, { "version" : "...", "product" : "..." } ], "services" : [ { "refName" : "...", "serviceType" : "...", "serviceConfigs" : [ { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true }, { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true } ], "roleConfigGroups" : [ { "refName" : "...", "roleType" : "...", "base" : true, "displayName" : "...", "configs" : [ {}, {} ] }, { "refName" : "...", "roleType" : "...", "base" : true, "displayName" : "...", "configs" : [ {}, {} ] } ], "roles" : [ { "refName" : "...", "roleType" : "..." }, { "refName" : "...", "roleType" : "..." } ], "displayName" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "refName" : "...", "serviceType" : "...", "serviceConfigs" : [ { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true }, { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true } ], "roleConfigGroups" : [ { "refName" : "...", "roleType" : "...", "base" : true, "displayName" : "...", "configs" : [ {}, {} ] }, { "refName" : "...", "roleType" : "...", "base" : true, "displayName" : "...", "configs" : [ {}, {} ] } ], "roles" : [ { "refName" : "...", "roleType" : "..." }, { "refName" : "...", "roleType" : "..." } ], "displayName" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ], "hostTemplates" : [ { "refName" : "...", "roleConfigGroupsRefNames" : [ "...", "..." ], "cardinality" : 12345, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "refName" : "...", "roleConfigGroupsRefNames" : [ "...", "..." ], "cardinality" : 12345, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ], "displayName" : "...", "cmVersion" : "...", "instantiator" : { "clusterName" : "...", "hosts" : [ { "hostName" : "...", "hostNameRange" : "...", "rackId" : "...", "hostTemplateRefName" : "...", "roleRefNames" : [ "...", "..." ] }, { "hostName" : "...", "hostNameRange" : "...", "rackId" : "...", "hostTemplateRefName" : "...", "roleRefNames" : [ "...", "..." ] } ], "variables" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "roleConfigGroups" : [ { "rcgRefName" : "...", "name" : "..." }, { "rcgRefName" : "...", "name" : "..." } ], "clusterSpec" : { "dataContextRefs" : [ {}, {} ] }, "keepHostTemplates" : true, "lenient" : true, "enableKerberos" : { "datanodeTransceiverPort" : 12345, "datanodeWebPort" : 12345 } }, "repositories" : [ "...", "..." ], "clusterSpec" : { "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ] }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, "description" : "Details of cluster template" }, "ApiClusterTemplateClusterSpec" : { "type" : "object", "title" : "ApiClusterTemplateClusterSpec", "properties" : { "dataContextRefs" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiDataContextRef" } } }, "example" : { "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ] }, "description" : "Specify type of cluster to create. If one or more ApiDataContextRef are specified, the created cluster\nupon import will be a cluster with clusterType \"COMPUTE\"." }, "ApiClusterTemplateConfig" : { "type" : "object", "title" : "ApiClusterTemplateConfig", "properties" : { "name" : { "description" : "Config name", "type" : "string" }, "value" : { "description" : "Config value", "type" : "string" }, "ref" : { "description" : "Name of the reference. If referring to a service then it will be replaced\nwith actual service name at import time. If referring to a role then it\nwill be replaced with the host name containing that role at import time.", "type" : "string" }, "variable" : { "description" : "Referring a variable. The variable value will be provided by the user at\nimport time. Variable name for this config. At import time the value of\nthis variable will be provided by the\n` * #ApiClusterTemplateInstantiator.Variables", "type" : "string" }, "autoConfig" : { "description" : "This indicates that the value was automatically configured.", "type" : "boolean" } }, "example" : { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true }, "description" : "Config Details: The config can either have a value or ref or variable." }, "ApiClusterTemplateHostInfo" : { "type" : "object", "title" : "ApiClusterTemplateHostInfo", "properties" : { "hostName" : { "description" : "Host name", "type" : "string" }, "hostNameRange" : { "description" : "Host range. Either this this or host name must be provided.", "type" : "string" }, "rackId" : { "description" : "Rack Id", "type" : "string" }, "hostTemplateRefName" : { "description" : "Pointing to the host template reference in the cluster template.", "type" : "string" }, "roleRefNames" : { "description" : "This will used to resolve the roles defined in the cluster template. This\nroleRefName will be used to connect this host with that a role reference\ndefined in cluster template.", "type" : "array", "items" : { "type" : "string" } } }, "example" : { "hostName" : "...", "hostNameRange" : "...", "rackId" : "...", "hostTemplateRefName" : "...", "roleRefNames" : [ "...", "..." ] }, "description" : "This contains information about the host or host range on which provided\nhost template will be applied." }, "ApiClusterTemplateHostTemplate" : { "type" : "object", "title" : "ApiClusterTemplateHostTemplate", "properties" : { "refName" : { "description" : "Reference name", "type" : "string" }, "roleConfigGroupsRefNames" : { "description" : "List of role config groups", "type" : "array", "items" : { "type" : "string" } }, "cardinality" : { "description" : "Represent the cardinality of this host template on source. Defaults to 0.", "type" : "integer" }, "tags" : { "description" : "The tags to be added to hosts when this template is applied", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } } }, "example" : { "refName" : "...", "roleConfigGroupsRefNames" : [ "...", "..." ], "cardinality" : 12345, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, "description" : "Host templates will contain information about the role config groups that\nshould be applied to a host. This basically means a host will have a role\ncorresponding to each config group." }, "ApiClusterTemplateInstantiator" : { "type" : "object", "title" : "ApiClusterTemplateInstantiator", "properties" : { "clusterName" : { "description" : "Cluster name", "type" : "string" }, "hosts" : { "description" : "All the hosts that are part of that cluster", "type" : "array", "items" : { "$ref" : "#/definitions/ApiClusterTemplateHostInfo" } }, "variables" : { "description" : "All the variables the are referred by the cluster template", "type" : "array", "items" : { "$ref" : "#/definitions/ApiClusterTemplateVariable" } }, "roleConfigGroups" : { "description" : "All the role config group informations for non-base RCGs.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiClusterTemplateRoleConfigGroupInfo" } }, "clusterSpec" : { "description" : "Cluster specification.", "$ref" : "#/definitions/ApiClusterTemplateClusterSpec" }, "keepHostTemplates" : { "description" : "Keep the hosts templates from cluster template.", "type" : "boolean" }, "lenient" : { "description" : "Allow setting service parameters that may not currently be supported\nby the current CM version but will be in the future.", "type" : "boolean" }, "enableKerberos" : { "description" : "Enable kerberos authentication", "$ref" : "#/definitions/ApiConfigureForKerberosArguments" } }, "example" : { "clusterName" : "...", "hosts" : [ { "hostName" : "...", "hostNameRange" : "...", "rackId" : "...", "hostTemplateRefName" : "...", "roleRefNames" : [ "...", "..." ] }, { "hostName" : "...", "hostNameRange" : "...", "rackId" : "...", "hostTemplateRefName" : "...", "roleRefNames" : [ "...", "..." ] } ], "variables" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "roleConfigGroups" : [ { "rcgRefName" : "...", "name" : "..." }, { "rcgRefName" : "...", "name" : "..." } ], "clusterSpec" : { "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ] }, "keepHostTemplates" : true, "lenient" : true, "enableKerberos" : { "datanodeTransceiverPort" : 12345, "datanodeWebPort" : 12345 } }, "description" : "Details of cluster template" }, "ApiClusterTemplateRole" : { "type" : "object", "title" : "ApiClusterTemplateRole", "properties" : { "refName" : { "description" : "Role reference name", "type" : "string" }, "roleType" : { "description" : "Role type", "type" : "string" } }, "example" : { "refName" : "...", "roleType" : "..." }, "description" : "Role info: This will contain information related to a role referred by some\nconfiguration. During import type this role must be materizalized." }, "ApiClusterTemplateRoleConfigGroup" : { "type" : "object", "title" : "ApiClusterTemplateRoleConfigGroup", "properties" : { "refName" : { "description" : "The reference name of the role config.", "type" : "string" }, "roleType" : { "description" : "Role type", "type" : "string" }, "base" : { "description" : "If true then it is the base config group for that role. There can only be\none base role config group for a given role type. Defaults to false.", "type" : "boolean" }, "displayName" : { "description" : "Role config group display name", "type" : "string" }, "configs" : { "description" : "List of configurations", "type" : "array", "items" : { "$ref" : "#/definitions/ApiClusterTemplateConfig" } } }, "example" : { "refName" : "...", "roleType" : "...", "base" : true, "displayName" : "...", "configs" : [ { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true }, { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true } ] }, "description" : "Role config group info." }, "ApiClusterTemplateRoleConfigGroupInfo" : { "type" : "object", "title" : "ApiClusterTemplateRoleConfigGroupInfo", "properties" : { "rcgRefName" : { "description" : "Role config group reference name. This much match the reference name from\nthe template.", "type" : "string" }, "name" : { "description" : "Role config group name.", "type" : "string" } }, "example" : { "rcgRefName" : "...", "name" : "..." }, "description" : "During import time information related to all the non-base config groups\nmust be provided." }, "ApiClusterTemplateService" : { "type" : "object", "title" : "ApiClusterTemplateService", "properties" : { "refName" : { "description" : "Reference name of the service. This could be referred by some\nconfiguration.", "type" : "string" }, "serviceType" : { "description" : "Service type", "type" : "string" }, "serviceConfigs" : { "description" : "Service level configuration", "type" : "array", "items" : { "$ref" : "#/definitions/ApiClusterTemplateConfig" } }, "roleConfigGroups" : { "description" : "All role config groups for that service", "type" : "array", "items" : { "$ref" : "#/definitions/ApiClusterTemplateRoleConfigGroup" } }, "roles" : { "description" : "List of roles for this service that are referred by some configuration.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiClusterTemplateRole" } }, "displayName" : { "description" : "Service display name.", "type" : "string" }, "tags" : { "description" : "Tags associated with the service", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } } }, "example" : { "refName" : "...", "serviceType" : "...", "serviceConfigs" : [ { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true }, { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true } ], "roleConfigGroups" : [ { "refName" : "...", "roleType" : "...", "base" : true, "displayName" : "...", "configs" : [ { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true }, { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true } ] }, { "refName" : "...", "roleType" : "...", "base" : true, "displayName" : "...", "configs" : [ { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true }, { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true } ] } ], "roles" : [ { "refName" : "...", "roleType" : "..." }, { "refName" : "...", "roleType" : "..." } ], "displayName" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, "description" : "Service information" }, "ApiClusterTemplateVariable" : { "type" : "object", "title" : "ApiClusterTemplateVariable", "properties" : { "name" : { "description" : "Variable name that are referred in cluster template", "type" : "string" }, "value" : { "description" : "This value will be placed whereever the variable is referred in the cluster\ntemplate", "type" : "string" } }, "example" : { "name" : "...", "value" : "..." }, "description" : "Variable that is referred in cluster template." }, "ApiClusterUtilization" : { "type" : "object", "title" : "ApiClusterUtilization", "properties" : { "totalCpuCores" : { "description" : "Average number of CPU cores available in the cluster during the report window.", "type" : "number" }, "avgCpuUtilization" : { "description" : "Average CPU consumption for the entire cluster during the report window.\nThis includes consumption by user workloads in YARN and Impala, as well as\nconsumption by all services running in the cluster.", "type" : "number" }, "maxCpuUtilization" : { "description" : "Maximum CPU consumption for the entire cluster during the report window.\nThis includes consumption by user workloads in YARN and Impala, as well as\nconsumption by all services running in the cluster.", "type" : "number" }, "avgCpuDailyPeak" : { "description" : "Average daily peak CPU consumption for the entire cluster during the report\nwindow. This includes consumption by user workloads in YARN and Impala, as\nwell as consumption by all services running in the cluster.", "type" : "number" }, "avgWorkloadCpu" : { "description" : "Average CPU consumption by workloads that ran on the cluster during the\nreport window. This includes consumption by user workloads in YARN and\nImpala.", "type" : "number" }, "maxWorkloadCpu" : { "description" : "Maximum CPU consumption by workloads that ran on the cluster during the\nreport window. This includes consumption by user workloads in YARN and\nImpala.", "type" : "number" }, "avgWorkloadCpuDailyPeak" : { "description" : "Average daily peak CPU consumption by workloads that ran on the cluster\nduring the report window. This includes consumption by user workloads in\nYARN and Impala.", "type" : "number" }, "totalMemory" : { "description" : "Average physical memory (in bytes) available in the cluster during the\nreport window. This includes consumption by user workloads in YARN and\nImpala, as well as consumption by all services running in the cluster.", "type" : "number" }, "avgMemoryUtilization" : { "description" : "Average memory consumption (as percentage of total memory) for the entire\ncluster during the report window. This includes consumption by user\nworkloads in YARN and Impala, as well as consumption by all services\nrunning in the cluster.", "type" : "number" }, "maxMemoryUtilization" : { "description" : "Maximum memory consumption (as percentage of total memory) for the entire\ncluster during the report window. This includes consumption by user\nworkloads in YARN and Impala, as well as consumption by all services\nrunning in the cluster.", "type" : "number" }, "avgMemoryDailyPeak" : { "description" : "Average daily peak memory consumption (as percentage of total memory) for\nthe entire cluster during the report window. This includes consumption by\nuser workloads in YARN and Impala, as well as consumption by all services\nrunning in the cluster.", "type" : "number" }, "avgWorkloadMemory" : { "description" : "Average memory consumption (as percentage of total memory) by workloads\nthat ran on the cluster during the report window. This includes consumption\nby user workloads in YARN and Impala.", "type" : "number" }, "maxWorkloadMemory" : { "description" : "Maximum memory consumption (as percentage of total memory) by workloads\nthat ran on the cluster. This includes consumption by user workloads in\nYARN and Impala", "type" : "number" }, "avgWorkloadMemoryDailyPeak" : { "description" : "Average daily peak memory consumption (as percentage of total memory) by\nworkloads that ran on the cluster during the report window. This includes\nconsumption by user workloads in YARN and Impala.", "type" : "number" }, "tenantUtilizations" : { "description" : "A list of tenant utilization reports.", "$ref" : "#/definitions/ApiTenantUtilizationList" }, "maxCpuUtilizationTimestampMs" : { "description" : "Timestamp corresponding to maximum CPU utilization for the entire cluster\nduring the report window.", "type" : "integer" }, "maxMemoryUtilizationTimestampMs" : { "description" : "Timestamp corresponding to maximum memory utilization for the entire\ncluster during the report window.", "type" : "integer" }, "maxWorkloadCpuTimestampMs" : { "description" : "Timestamp corresponds to maximum CPU consumption by workloads that\nran on the cluster during the report window.", "type" : "integer" }, "maxWorkloadMemoryTimestampMs" : { "description" : "Timestamp corresponds to maximum memory resource consumption by workloads that\nran on the cluster during the report window.", "type" : "integer" }, "errorMessage" : { "description" : "Error message while generating utilization report.", "type" : "string" } }, "example" : { "totalCpuCores" : 12345.0, "avgCpuUtilization" : 12345.0, "maxCpuUtilization" : 12345.0, "avgCpuDailyPeak" : 12345.0, "avgWorkloadCpu" : 12345.0, "maxWorkloadCpu" : 12345.0, "avgWorkloadCpuDailyPeak" : 12345.0, "totalMemory" : 12345.0, "avgMemoryUtilization" : 12345.0, "maxMemoryUtilization" : 12345.0, "avgMemoryDailyPeak" : 12345.0, "avgWorkloadMemory" : 12345.0, "maxWorkloadMemory" : 12345.0, "avgWorkloadMemoryDailyPeak" : 12345.0, "tenantUtilizations" : { "items" : [ { "tenantName" : "...", "cpuUtilizationPercentage" : 12345.0, "memoryUtilizationPercentage" : 12345.0 }, { "tenantName" : "...", "cpuUtilizationPercentage" : 12345.0, "memoryUtilizationPercentage" : 12345.0 } ] }, "maxCpuUtilizationTimestampMs" : 12345, "maxMemoryUtilizationTimestampMs" : 12345, "maxWorkloadCpuTimestampMs" : 12345, "maxWorkloadMemoryTimestampMs" : 12345, "errorMessage" : "..." }, "description" : "Utilization report information of a Cluster." }, "ApiClusterVersion" : { "type" : "string", "title" : "ApiClusterVersion", "enum" : [ "CDH3", "CDH3u4X", "CDH4", "CDH5", "CDH6", "CDH7", "DATA_SERVICES1", "UNKNOWN" ], "description" : "The CDH version of the cluster." }, "ApiClustersPerfInspectorArgs" : { "type" : "object", "title" : "ApiClustersPerfInspectorArgs", "properties" : { "sourceCluster" : { "description" : "Required name of the source cluster to run network diagnostics test.", "type" : "string" }, "targetCluster" : { "description" : "Required name of the target cluster to run network diagnostics test.", "type" : "string" }, "pingArgs" : { "description" : "Optional ping request arguments.\nIf not specified, default arguments will be used for ping test.", "$ref" : "#/definitions/ApiPerfInspectorPingArgs" }, "bandwidthArgs" : { "description" : "Optional bandwidth test request arguments.\nIf not specified, default arguments will be used for bandwidth test.\nApplicable since version v32.", "$ref" : "#/definitions/ApiPerfInspectorBandwidthArgs" }, "policyType" : { "description" : "Optional type of performance diagnostics to run.\nIf not specified, defaults to FULL policy type.\nApplicable since version v32.", "$ref" : "#/definitions/PerfInspectorPolicyType" } }, "example" : { "sourceCluster" : "...", "targetCluster" : "...", "pingArgs" : { "pingTimeoutSecs" : 10, "pingCount" : 10, "pingPacketSizeBytes" : 56 }, "bandwidthArgs" : { "runBandwidthDiagnostics" : false, "bandwidthTimeoutSecs" : 10 }, "policyType" : "FULL" }, "description" : "Arguments used for the Cloudera Manager level performance inspector.\nNetwork diagnostics will be run from every host in sourceCluster to every host\nin targetCluster." }, "ApiCmPeer" : { "type" : "object", "title" : "ApiCmPeer", "properties" : { "name" : { "description" : "The name of the remote CM instance. Immutable during update.", "type" : "string" }, "type" : { "description" : "The type of the remote CM instance. Immutable during update.\n\nAvailable since API v11.", "$ref" : "#/definitions/ApiCmPeerType" }, "url" : { "description" : "The URL of the remote CM instance. Mutable during update.", "type" : "string" }, "username" : { "description" : "When creating peers, if 'clouderaManagerCreatedUser' is true, this should be\nthe remote admin username for creating a user in remote Cloudera Manager. The\ncreated remote user will then be stored in the local Cloudera Manager DB and\nused in later communication. If 'clouderaManagerCreatedUser' is false, which\nis not applicable to REPLICATION peer type, Cloudera Manager will store this\nusername in the local DB directly and use it together with 'password' for\ncommunication.\n\nMutable during update.\nWhen set during update, if 'clouderaManagerCreatedUser' is true, a new user\nin remote Cloudera Manager is created, the newly created remote user will be\nstored in the local DB. An attempt to delete the previously created remote\nuser will be made; If 'clouderaManagerCreatedUser' is false, the\nusername/password in the local DB will be updated.", "type" : "string" }, "password" : { "description" : "When creating peers, if 'clouderaManagerCreatedUser' is true, this should be\nthe remote admin password for creating a user in remote Cloudera Manager. The\ncreated remote user will then be stored in the local Cloudera Manager DB and\nused in later communication. If 'clouderaManagerCreatedUser' is false, which\nis not applicable to REPLICATION peer type, Cloudera Manager will store this\npassword in the local DB directly and use it together with 'username' for\ncommunication.\n\nMutable during update.\nWhen set during update, if 'clouderaManagerCreatedUser' is true, a new user\nin remote Cloudera Manager is created, the newly created remote user will be\nstored in the local DB. An attempt to delete the previously created remote\nuser will be made; If 'clouderaManagerCreatedUser' is false, the\nusername/password in the local DB will be updated.", "type" : "string" }, "clouderaManagerCreatedUser" : { "description" : "If true, Cloudera Manager creates a remote user using the given\nusername/password and stores the created user in local DB for use in later\ncommunication. Cloudera Manager will also try to delete the created remote\nuser when deleting such peers.\n\nIf false, Cloudera Manager will store the provided username/password in\nthe local DB and use them in later communication. 'false' value on this\nfield is not applicable to REPLICATION peer type.\n\nAvailable since API v11.\n\nImmutable during update. Should not be set when updating peers.", "type" : "boolean" }, "createUserWithAdminRole" : { "description" : "If true and clouderaManagerCreatedUser is true, the created user will have admin role granted.\n\nIf false and clouderaManagerCreatedUser is true, the created user will have user role.\n\nnull means false.\n\nAvailable since API v44.\n\nNeeds to be set during update if changing the URL.", "type" : "boolean" } }, "example" : { "name" : "...", "type" : "STATUS_AGGREGATION", "url" : "...", "username" : "...", "password" : "...", "clouderaManagerCreatedUser" : true, "createUserWithAdminRole" : true }, "description" : "Information about a Cloudera Manager peer instance.\n
\nThe requirement and usage of username and password properties\nare dependent on the clouderaManagerCreatedUser flag.\n
\nWhen creating peers, if 'clouderaManagerCreatedUser' is true, the\nusername/password should be the credentials of a user with administrator\nprivileges on the remote Cloudera Manager. These credentials are not stored,\nthey are used to connect to the peer and create a user in that peer. The\nnewly created user is stored and used for communication with that peer.\nIf 'clouderaManagerCreatedUser' is false, which is not applicable to\nREPLICATION peer type, the username/password to the remote Cloudera Manager\nare directly stored and used for all communications with that peer.\n
\nWhen updating peers, if 'clouderaManagerCreatedUser' is true and\nusername/password are set, a new remote user will be created. If\n'clouderaManagerCreatedUser' is false and username/password are set, the\nstored username/password will be updated.\n
\nIf 'createUserWithAdminRole' is true and 'clouderaManagerCreatedUser' is true, the\ncreated internal user will also be granted admin role." }, "ApiCmPeerList" : { "type" : "object", "title" : "ApiCmPeerList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiCmPeer" } } } } ], "example" : { "items" : [ { "name" : "...", "type" : "STATUS_AGGREGATION", "url" : "...", "username" : "...", "password" : "...", "clouderaManagerCreatedUser" : true, "createUserWithAdminRole" : true }, { "name" : "...", "type" : "STATUS_AGGREGATION", "url" : "...", "username" : "...", "password" : "...", "clouderaManagerCreatedUser" : true, "createUserWithAdminRole" : true } ] }, "description" : "A list of Cloudera Manager peers." }, "ApiCmPeerType" : { "type" : "string", "title" : "ApiCmPeerType", "enum" : [ "REPLICATION", "STATUS_AGGREGATION" ], "description" : "Enum for CM peer types." }, "ApiCmServer" : { "type" : "object", "title" : "ApiCmServer", "properties" : { "cmServerId" : { "description" : "The CM server ID.", "type" : "string" }, "name" : { "description" : "The CM server hostname.", "type" : "string" }, "ipAddress" : { "description" : "The IP address.", "type" : "string" }, "createdTime" : { "description" : "The created time.", "type" : "string" }, "lastUpdatedTime" : { "description" : "The last updated time.", "type" : "string" }, "haPriority" : { "description" : "HA Priority for active passive mode.", "type" : "string" }, "isAlive" : { "description" : "Is the cm server running.", "type" : "string" } }, "example" : { "cmServerId" : "...", "name" : "...", "ipAddress" : "...", "createdTime" : "...", "lastUpdatedTime" : "...", "haPriority" : "...", "isAlive" : "..." }, "description" : "This is the model for CM server information from v41.\n\nThe class models the host environment that CM server is installed. Each CM server instance\nhas an entry of CmServer entity and updates it periodically." }, "ApiCmServerList" : { "type" : "object", "title" : "ApiCmServerList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiCmServer" } } } } ], "example" : { "items" : [ { "cmServerId" : "...", "name" : "...", "ipAddress" : "...", "createdTime" : "...", "lastUpdatedTime" : "...", "haPriority" : "...", "isAlive" : "..." }, { "cmServerId" : "...", "name" : "...", "ipAddress" : "...", "createdTime" : "...", "lastUpdatedTime" : "...", "haPriority" : "...", "isAlive" : "..." } ] }, "description" : "A generic list." }, "ApiCollectDiagnosticDataArguments" : { "type" : "object", "title" : "ApiCollectDiagnosticDataArguments", "properties" : { "collectCMDBDump" : { "description" : "", "type" : "boolean" }, "bundleSizeBytes" : { "description" : "The maximum approximate bundle size of the output file. Defaults to 0.", "type" : "integer" }, "startTime" : { "description" : "This parameter is ignored between CM 4.5 and CM 5.7 versions.\nFor versions from CM 4.5 to CM 5.7, use endTime and\nbundleSizeBytes instead.\n\nFor CM 5.7+ versions, startTime is an optional parameter that\nis with endTime and bundleSizeBytes. This was introduced\nto perform diagnostic data estimation and collection of global\ndiagnostics data for a certain time range.\nThe start time (in ISO 8601 format)\nof the period to collection statistics for.", "type" : "string" }, "endTime" : { "description" : "The end time (in ISO 8601 format)\nof the period to collection statistics for.", "type" : "string" }, "includeInfoLog" : { "description" : "This parameter is ignored as of CM 4.5.\nINFO logs are always collected.\nWhether to include INFO level logs.\nWARN, ERROR, and FATAL level logs are always included.", "type" : "boolean" }, "ticketNumber" : { "description" : "The support ticket number to attach to this data collection.", "type" : "string" }, "comments" : { "description" : "Comments to include with this data collection.", "type" : "string" }, "clusterName" : { "description" : "Name of the cluster to collect. If null, collects from all clusters.", "type" : "string" }, "enableMonitorMetricsCollection" : { "description" : "Flag to enable collection of metrics for chart display.", "type" : "boolean" }, "roles" : { "description" : "List of roles for which to get logs and metrics.\n\nIf set, this restricts the roles for log and metrics collection\nto the list specified.\n\nIf empty, the default is to get logs for all roles (in the selected\ncluster, if one is selected).\n\nIntroduced in API v10 of the API.", "type" : "array", "items" : { "type" : "string" } }, "phoneHome" : { "description" : "Flag to enable or disable diagnostic bundle upload to EDH.\n\nIf not set, the PHONE_HOME setting decides whether the bundle will get uploaded or not.", "type" : "boolean" } }, "example" : { "collectCMDBDump" : true, "bundleSizeBytes" : 12345, "startTime" : "...", "endTime" : "...", "ticketNumber" : "...", "comments" : "...", "clusterName" : "...", "enableMonitorMetricsCollection" : true, "roles" : [ "...", "..." ], "phoneHome" : true }, "description" : "Arguments used for the collectDiagnosticData command." }, "ApiCommand" : { "type" : "object", "title" : "ApiCommand", "properties" : { "id" : { "description" : "The command ID.", "type" : "integer" }, "name" : { "description" : "The command name.", "type" : "string" }, "startTime" : { "description" : "The start time.", "type" : "string" }, "endTime" : { "description" : "The end time, if the command is finished.", "type" : "string" }, "active" : { "description" : "Whether the command is currently active.", "type" : "boolean" }, "success" : { "description" : "If the command is finished, whether it was successful.", "type" : "boolean" }, "resultMessage" : { "description" : "If the command is finished, the result message.", "type" : "string" }, "resultDataUrl" : { "description" : "URL to the command's downloadable result data, if any exists.", "type" : "string" }, "clusterRef" : { "description" : "Reference to the cluster (for cluster commands only).", "$ref" : "#/definitions/ApiClusterRef" }, "serviceRef" : { "description" : "Reference to the service (for service commands only).", "$ref" : "#/definitions/ApiServiceRef" }, "roleRef" : { "description" : "Reference to the role (for role commands only).", "$ref" : "#/definitions/ApiRoleRef" }, "hostRef" : { "description" : "Reference to the host (for host commands only).", "$ref" : "#/definitions/ApiHostRef" }, "parent" : { "description" : "Reference to the parent command, if any.", "$ref" : "#/definitions/ApiCommand" }, "children" : { "description" : "List of child commands. Only available in the full view.\n
\nThe list contains only the summary view of the children.", "$ref" : "#/definitions/ApiCommandList" }, "canRetry" : { "description" : "If the command can be retried. Available since V11", "type" : "boolean" } }, "example" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true }, "description" : "Provides detailed information about a submitted command.\n\n
There are two types of commands: synchronous and asynchronous.\nSynchronous commands complete immediately, and their results are passed\nback in the returned command object after the execution of an API call.\nOutside of that returned object, there is no way to check the result of a\nsynchronous command.
\n\nAsynchronous commands have unique non-negative IDs. They may still be\nrunning when the API call returns. Clients can check the status of such\ncommands using the API.
" }, "ApiCommandList" : { "type" : "object", "title" : "ApiCommandList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiCommand" } } } } ], "example" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] }, "description" : "A list of commands." }, "ApiCommandMetadata" : { "type" : "object", "title" : "ApiCommandMetadata", "properties" : { "name" : { "description" : "The name of of the command.", "type" : "string" }, "argSchema" : { "description" : "The command arguments schema.\n\nThis is in the form of json schema and\ndescribes the structure of the command\narguments. If null, the command does not\ntake arguments.", "type" : "string" } }, "example" : { "name" : "...", "argSchema" : "..." }, "description" : "Provides metadata information about a command." }, "ApiCommandMetadataList" : { "type" : "object", "title" : "ApiCommandMetadataList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "The list of command metadata objects.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiCommandMetadata" } } } } ], "example" : { "items" : [ { "name" : "...", "argSchema" : "..." }, { "name" : "...", "argSchema" : "..." } ] }, "description" : "A list of command metadata." }, "ApiCommandStep" : { "type" : "object", "title" : "ApiCommandStep", "properties" : { "description" : { "description" : "The command step description.", "type" : "string" }, "startTime" : { "description" : "The start time.", "type" : "string" }, "endTime" : { "description" : "The end time, if the command step is finished.", "type" : "string" }, "state" : { "description" : "Current state of the command step", "$ref" : "#/definitions/State" }, "resultMessage" : { "description" : "If the command step is finished, the result message.", "type" : "string" }, "ignoreError" : { "description" : "Whether the step will continue even upon error.", "type" : "boolean" }, "parallel" : { "description" : "Whether the children are scattered simultaneously, i.e. parallel.\nIf not they would execute one after another, i.e. serially.", "type" : "boolean" }, "processes" : { "description" : "List of processes executed by the command step.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiCommandStepProcess" } }, "clientConfigs" : { "description" : "List of command step client configs.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiCommandStepProcess" } }, "roles" : { "description" : "List of command step roles.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiRoleRef" } }, "clusters" : { "description" : "List of clusters associated with command step.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiClusterRef" } }, "hosts" : { "description" : "List of hosts associated with command step.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHostRef" } }, "services" : { "description" : "List of services associated with command step.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiServiceRef" } }, "children" : { "description" : "List of child command steps.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiCommandStep" } }, "commands" : { "description" : "List of subcommands.\n\nThe list contains only the summary view of the commands.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiCommand" } }, "remoteCommand" : { "description" : "Remote command executed by the current step on a peer cluster.", "$ref" : "#/definitions/ApiRemoteCommand" } }, "example" : { "description" : "...", "startTime" : "...", "endTime" : "...", "state" : "FAILED", "resultMessage" : "...", "ignoreError" : true, "parallel" : true, "processes" : [ { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 }, { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 } ], "clientConfigs" : [ { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 }, { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 } ], "roles" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTING" } ], "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "hosts" : [ { "hostId" : "...", "hostname" : "..." }, { "hostId" : "...", "hostname" : "..." } ], "services" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "children" : [ { "description" : "...", "startTime" : "...", "endTime" : "...", "state" : "RUNNING", "resultMessage" : "...", "ignoreError" : true, "parallel" : true, "processes" : [ { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 }, { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 } ], "clientConfigs" : [ { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 }, { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 } ], "roles" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPING" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPED" } ], "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "hosts" : [ { "hostId" : "...", "hostname" : "..." }, { "hostId" : "...", "hostname" : "..." } ], "services" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "children" : [ {}, {} ], "commands" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "remoteCommand" : { "id" : 12345, "peerName" : "..." } }, { "description" : "...", "startTime" : "...", "endTime" : "...", "state" : "FAILED", "resultMessage" : "...", "ignoreError" : true, "parallel" : true, "processes" : [ { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 }, { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 } ], "clientConfigs" : [ { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 }, { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 } ], "roles" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" } ], "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "hosts" : [ { "hostId" : "...", "hostname" : "..." }, { "hostId" : "...", "hostname" : "..." } ], "services" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "children" : [ {}, {} ], "commands" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "remoteCommand" : { "id" : 12345, "peerName" : "..." } } ], "commands" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ], "remoteCommand" : { "id" : 12345, "peerName" : "..." } }, "description" : "Provides detailed information about a step of a command." }, "ApiCommandStepProcess" : { "type" : "object", "title" : "ApiCommandStepProcess", "properties" : { "name" : { "description" : "Name of the command step process.", "type" : "string" }, "id" : { "description" : "Id of the command step process.", "type" : "integer" }, "program" : { "description" : "The executed program command.", "type" : "string" }, "args" : { "description" : "JSON-encoded list of program arguments.", "type" : "string" }, "stdout" : { "description" : "Last lines of the executed program's standard output.", "type" : "string" }, "stderr" : { "description" : "Last lines of the executed program's standard error.", "type" : "string" }, "exitCode" : { "description" : "The executed program's exit code.", "type" : "integer" } }, "example" : { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 }, "description" : "Provides detailed information about a process executed by a command step." }, "ApiCommandWithSteps" : { "type" : "object", "title" : "ApiCommandWithSteps", "allOf" : [ { "$ref" : "#/definitions/ApiCommand" }, { "properties" : { "displayName" : { "description" : "The command display name.", "type" : "string" }, "steps" : { "description" : "The steps of the command.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiCommandStep" } } } } ], "example" : { "displayName" : "...", "steps" : [ { "description" : "...", "startTime" : "...", "endTime" : "...", "state" : "FAILED", "resultMessage" : "...", "ignoreError" : true, "parallel" : true, "processes" : [ { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 }, { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 } ], "clientConfigs" : [ { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 }, { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 } ], "roles" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTING" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTING" } ], "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "hosts" : [ { "hostId" : "...", "hostname" : "..." }, { "hostId" : "...", "hostname" : "..." } ], "services" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "children" : [ {}, {} ], "commands" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "remoteCommand" : { "id" : 12345, "peerName" : "..." } }, { "description" : "...", "startTime" : "...", "endTime" : "...", "state" : "FAILED", "resultMessage" : "...", "ignoreError" : true, "parallel" : true, "processes" : [ { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 }, { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 } ], "clientConfigs" : [ { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 }, { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 } ], "roles" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "BUSY" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "NA" } ], "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "hosts" : [ { "hostId" : "...", "hostname" : "..." }, { "hostId" : "...", "hostname" : "..." } ], "services" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "children" : [ {}, {} ], "commands" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "remoteCommand" : { "id" : 12345, "peerName" : "..." } } ], "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true }, "description" : "Provides detailed information about a submitted command including all steps\nand a summary of subcommands.\n\n
There are two types of commands: synchronous and asynchronous.\nSynchronous commands complete immediately, and their results are passed\nback in the returned command object after the execution of an API call.\nOutside of that returned object, there is no way to check the result of a\nsynchronous command.
\n\nAsynchronous commands have unique non-negative IDs. They may still be\nrunning when the API call returns. Clients can check the status of such\ncommands using the API.
" }, "ApiCommissionState" : { "type" : "string", "title" : "ApiCommissionState", "enum" : [ "COMMISSIONED", "DECOMMISSIONING", "DECOMMISSIONED", "UNKNOWN", "OFFLINING", "OFFLINED" ], "description" : "Represents the Commission state of an entity." }, "ApiComponentInfo" : { "type" : "object", "title" : "ApiComponentInfo", "properties" : { "name" : { "description" : "The name of the component.", "type" : "string" }, "cdhVersion" : { "description" : "The CDH version on the host.", "type" : "string" }, "cdhRelease" : { "description" : "CDH release on the host.", "type" : "string" }, "componentVersion" : { "description" : "Component version on the host.", "type" : "string" }, "componentRelease" : { "description" : "Component release on the host.", "type" : "string" }, "componentInfoSource" : { "description" : "Source from which component is taken.", "type" : "string" }, "isActive" : { "description" : "returns true if component is active.", "type" : "boolean" }, "componentConfig" : { "description" : "list of config name and value pair associated with component.", "type" : "object", "additionalProperties" : { "type" : "string" } } }, "example" : { "name" : "...", "cdhVersion" : "...", "cdhRelease" : "...", "componentVersion" : "...", "componentRelease" : "...", "componentInfoSource" : "...", "isActive" : true, "componentConfig" : { "property1" : "...", "property2" : "..." } }, "description" : "This is the model for a component in the host." }, "ApiConfig" : { "type" : "object", "title" : "ApiConfig", "properties" : { "name" : { "description" : "Readonly. The canonical name that identifies this configuration parameter.", "type" : "string" }, "value" : { "description" : "The user-defined value. When absent, the default value (if any)\nwill be used. Can also be absent, when enumerating allowed configs.", "type" : "string" }, "required" : { "description" : "Readonly. Requires \"full\" view.\nWhether this configuration is required for the object. If\nany required configuration is not set, operations on the object may not\nwork.", "type" : "boolean" }, "default" : { "description" : "Readonly. Requires \"full\" view. The default value.", "type" : "string" }, "displayName" : { "description" : "Readonly. Requires \"full\" view. A user-friendly name of the parameters,\nas would have been shown in the web UI.", "type" : "string" }, "description" : { "description" : "Readonly. Requires \"full\" view. A textual description of the parameter.", "type" : "string" }, "relatedName" : { "description" : "Readonly. Requires \"full\" view. If applicable, contains the related\nconfiguration variable used by the source project.", "type" : "string" }, "sensitive" : { "description" : "Readonly.\nWhether this configuration is sensitive, i.e. contains information such as passwords, which\nmight affect how the value of this configuration might be shared by the caller.\n\nAvailable since v14.", "type" : "boolean" }, "validationState" : { "description" : "Readonly. Requires \"full\" view.\nState of the configuration parameter after validation.", "$ref" : "#/definitions/ValidationState" }, "validationMessage" : { "description" : "Readonly. Requires \"full\" view.\nA message explaining the parameter's validation state.", "type" : "string" }, "validationWarningsSuppressed" : { "description" : "Readonly. Requires \"full\" view.\nWhether validation warnings associated with this parameter are suppressed.\nIn general, suppressed validation warnings are hidden in the Cloudera\nManager UI. Configurations that do not produce warnings will not contain\nthis field.", "type" : "boolean" } }, "example" : { "name" : "...", "value" : "...", "required" : true, "default" : "...", "displayName" : "...", "description" : "...", "relatedName" : "...", "sensitive" : true, "validationState" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true }, "description" : "Model for a configuration parameter.\n\nWhen an entry's value property is not available, it means the\nentry is not configured. This means that the default value for the entry,\nif any, will be used. Setting a value to null also can be used\nto unset any previously set value for the parameter, reverting to\nthe default value (if any)." }, "ApiConfigList" : { "type" : "object", "title" : "ApiConfigList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiConfig" } } } } ], "example" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "description" : "A list of configuration data." }, "ApiConfigStalenessStatus" : { "type" : "string", "title" : "ApiConfigStalenessStatus", "enum" : [ "FRESH", "STALE_REFRESHABLE", "STALE" ], "description" : "Represents the configuration staleness status of an entity." }, "ApiConfigureForKerberosArguments" : { "type" : "object", "title" : "ApiConfigureForKerberosArguments", "properties" : { "datanodeTransceiverPort" : { "description" : "The HDFS DataNode transceiver port to use. This will be applied to all DataNode\nrole configuration groups. If not specified, this will default to 1004.", "type" : "integer" }, "datanodeWebPort" : { "description" : "The HDFS DataNode web port to use. This will be applied to all DataNode\nrole configuration groups. If not specified, this will default to 1006.", "type" : "integer" } }, "example" : { "datanodeTransceiverPort" : 12345, "datanodeWebPort" : 12345 }, "description" : "Arguments used to configure a cluster for Kerberos." }, "ApiControlPlane" : { "type" : "object", "title" : "ApiControlPlane", "properties" : { "namespace" : { "description" : "The namespace where the control plane is installed. Append the domain to the namespace to get the url of the control plane.", "type" : "string" }, "dnsSuffix" : { "description" : "The domain where the control plane is installed. Append the domain to the namespace to get the url of the control plane.", "type" : "string" }, "uuid" : { "description" : "The universally unique ID of this control plane in Cloudera Manager", "type" : "string" }, "remoteRepoUrl" : { "description" : "The url of the remote repository where the artifacts used to install the control plane are hosted", "type" : "string" }, "version" : { "description" : "The CDP version of the control plane", "type" : "string" }, "manifest" : { "description" : "The content of the manifest.json of the control plane", "type" : "string" }, "valuesYaml" : { "description" : "The content of the values.yaml used to configure the control plane", "type" : "string" }, "tags" : { "description" : "Tags associated with the control plane.\nAvailable since V46.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "kubernetesType" : { "description" : "The kubernetes type on which the control plane is running", "type" : "string" } }, "example" : { "namespace" : "...", "dnsSuffix" : "...", "uuid" : "...", "remoteRepoUrl" : "...", "version" : "...", "manifest" : "...", "valuesYaml" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "kubernetesType" : "..." }, "description" : "A Control Plane in a Cloudera Manager instance" }, "ApiControlPlaneList" : { "type" : "object", "title" : "ApiControlPlaneList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "A list of installed control planes", "type" : "array", "items" : { "$ref" : "#/definitions/ApiControlPlane" } } } } ], "example" : { "items" : [ { "namespace" : "...", "dnsSuffix" : "...", "uuid" : "...", "remoteRepoUrl" : "...", "version" : "...", "manifest" : "...", "valuesYaml" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "kubernetesType" : "..." }, { "namespace" : "...", "dnsSuffix" : "...", "uuid" : "...", "remoteRepoUrl" : "...", "version" : "...", "manifest" : "...", "valuesYaml" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "kubernetesType" : "..." } ] }, "description" : "A list of ApiControlPlanes" }, "ApiControlPlaneRef" : { "type" : "object", "title" : "ApiControlPlaneRef", "properties" : { "uuid" : { "description" : "The name of the control plane, which uniquely identifies it in a CM installation.", "type" : "string" } }, "example" : { "uuid" : "..." }, "description" : "A controlPlaneRef references a control plane. To operate on the control plane object,\nuse the control plane API with the uuid as the parameter." }, "ApiCopyImagesInFeaturesArgs" : { "type" : "object", "title" : "ApiCopyImagesInFeaturesArgs", "properties" : { "selectedFeatures" : { "description" : "The selected feature names (a comma separated list), typically only one,\nthat some container images/packages are associated with.", "type" : "string" } }, "example" : { "selectedFeatures" : "..." }, "description" : "Arguments used for the command to copy images that belongs to one or more features.\nThis is applicable for ECS deployments, where we can perform the image copying ourselves." }, "ApiCreateEnvironment" : { "type" : "object", "title" : "ApiCreateEnvironment", "properties" : { "cmUser" : { "description" : "", "type" : "string" }, "cmPass" : { "description" : "", "type" : "string" }, "cmAddress" : { "description" : "", "type" : "string" }, "clusterName" : { "description" : "", "type" : "string" }, "envName" : { "description" : "", "type" : "string" } }, "example" : { "cmUser" : "...", "cmPass" : "...", "cmAddress" : "...", "clusterName" : "...", "envName" : "..." }, "description" : "Arguments used to install CDP a Private Cloud Control Plane" }, "ApiCspArguments" : { "type" : "object", "title" : "ApiCspArguments", "properties" : { "caCertContent" : { "description" : "The content of the public CA certificate.", "type" : "string" }, "certContent" : { "description" : "The content of the private client certificate.", "type" : "string" }, "keyContent" : { "description" : "The content of the private client key.", "type" : "string" } }, "example" : { "caCertContent" : "...", "certContent" : "...", "keyContent" : "..." }, "description" : "Arguments to upload CA certificates, client certificates and client key for CSP" }, "ApiDashboard" : { "type" : "object", "title" : "ApiDashboard", "properties" : { "name" : { "description" : "Returns the dashboard name.", "type" : "string" }, "json" : { "description" : "Returns the json structure for the dashboard. This should be treated as\nan opaque blob.", "type" : "string" } }, "example" : { "name" : "...", "json" : "..." }, "description" : "A dashboard definition. Dashboards are composed of tsquery-based charts." }, "ApiDashboardList" : { "type" : "object", "title" : "ApiDashboardList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiDashboard" } } } } ], "example" : { "items" : [ { "name" : "...", "json" : "..." }, { "name" : "...", "json" : "..." } ] }, "description" : "A list of dashboard definitions." }, "ApiDataContext" : { "type" : "object", "title" : "ApiDataContext", "properties" : { "name" : { "description" : "", "type" : "string" }, "displayName" : { "description" : "", "type" : "string" }, "nameservice" : { "description" : "", "type" : "string" }, "createdTime" : { "description" : "", "type" : "string" }, "lastModifiedTime" : { "description" : "", "type" : "string" }, "services" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiServiceRef" } }, "servicesDetails" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiService" } }, "supportedServiceTypes" : { "description" : "", "type" : "array", "items" : { "type" : "string" } }, "allowedClusterVersions" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiMapEntry" } }, "configStalenessStatus" : { "description" : "", "$ref" : "#/definitions/ApiConfigStalenessStatus" }, "clientConfigStalenessStatus" : { "description" : "", "$ref" : "#/definitions/ApiConfigStalenessStatus" }, "healthSummary" : { "description" : "", "$ref" : "#/definitions/ApiHealthSummary" } }, "example" : { "name" : "...", "displayName" : "...", "nameservice" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "services" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "servicesDetails" : [ { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "HISTORY_NOT_AVAILABLE", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "HOST" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STARTING", "commissionState" : "OFFLINED", "healthSummary" : "CONCERNING", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "CLUSTER" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_OBSERVER", "entityStatus" : "GOOD_HEALTH", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPING", "commissionState" : "COMMISSIONED", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "HOST" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER", "entityStatus" : "STARTING", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "DAY", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "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" : "CONCERNING_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STOPPED", "healthSummary" : "BAD", "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "HOST" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPING", "commissionState" : "OFFLINING", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "ROLE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "STOPPED", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "NA", "commissionState" : "COMMISSIONED", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "SERVICE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "UNKNOWN", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "WEEK", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "YEAR", "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" : "BAD_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." } ], "supportedServiceTypes" : [ "...", "..." ], "allowedClusterVersions" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "STALE", "healthSummary" : "NOT_AVAILABLE" }, "description" : "ApiDataContext is the persistent storage/services context exported by the base cluster to be\nconsumed by the compute cluster." }, "ApiDataContextList" : { "type" : "object", "title" : "ApiDataContextList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiDataContext" } } } } ], "example" : { "items" : [ { "name" : "...", "displayName" : "...", "nameservice" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "services" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "servicesDetails" : [ { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "STARTING", "healthSummary" : "BAD", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "CLUSTER" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "BAD_HEALTH", "tags" : [ {}, {} ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "STARTED", "healthSummary" : "GOOD", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "CLUSTER" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "HISTORY_NOT_AVAILABLE", "tags" : [ {}, {} ], "serviceVersion" : "..." } ], "supportedServiceTypes" : [ "...", "..." ], "allowedClusterVersions" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "STALE", "healthSummary" : "HISTORY_NOT_AVAILABLE" }, { "name" : "...", "displayName" : "...", "nameservice" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "services" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "servicesDetails" : [ { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "STARTED", "healthSummary" : "BAD", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "ROLE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "NONE", "tags" : [ {}, {} ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "UNKNOWN", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "ROLE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "STOPPED", "tags" : [ {}, {} ], "serviceVersion" : "..." } ], "supportedServiceTypes" : [ "...", "..." ], "allowedClusterVersions" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "FRESH", "healthSummary" : "DISABLED" } ] }, "description" : "List of ApiDataContext" }, "ApiDataContextRef" : { "type" : "object", "title" : "ApiDataContextRef", "properties" : { "name" : { "description" : "", "type" : "string" } }, "example" : { "name" : "..." }, "description" : "Reference to an ApiDataContext object. More properties can be added to this object when we\nsupport mutable datacontexts, but for MVP datacontexts are immutable." }, "ApiDeployment" : { "type" : "object", "title" : "ApiDeployment", "properties" : { "timestamp" : { "description" : "Readonly. This timestamp is provided when you request a deployment and\nis not required (or even read) when creating a deployment. This\ntimestamp is useful if you have multiple deployments saved and\nwant to determine which one to use as a restore point.", "type" : "string" }, "clusters" : { "description" : "List of clusters in the system including their services, roles and\ncomplete config values.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiCluster" } }, "hosts" : { "description" : "List of hosts in the system", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHost" } }, "users" : { "description" : "List of all users in the system", "type" : "array", "items" : { "$ref" : "#/definitions/ApiUser" } }, "versionInfo" : { "description" : "Full version information about the running Cloudera Manager instance", "$ref" : "#/definitions/ApiVersionInfo" }, "managementService" : { "description" : "The full configuration of the Cloudera Manager management service\nincluding all the management roles and their config values", "$ref" : "#/definitions/ApiService" }, "managerSettings" : { "description" : "The full configuration of Cloudera Manager itself including licensing info", "$ref" : "#/definitions/ApiConfigList" }, "allHostsConfig" : { "description" : "Configuration parameters that apply to all hosts, unless overridden at\nthe host level. Available since API v3.", "$ref" : "#/definitions/ApiConfigList" }, "peers" : { "description" : "The list of peers configured in Cloudera Manager.\nAvailable since API v3.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiCmPeer" } }, "hostTemplates" : { "description" : "The list of all host templates in Cloudera Manager.", "$ref" : "#/definitions/ApiHostTemplateList" } }, "example" : { "timestamp" : "...", "clusters" : [ { "name" : "...", "displayName" : "...", "fullVersion" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "CLUSTER" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "UNKNOWN", "healthSummary" : "DISABLED", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "CONTROL_PLANE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "STOPPED", "tags" : [ {}, {} ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "NA", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "SERVICE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "STOPPED", "tags" : [ {}, {} ], "serviceVersion" : "..." } ], "parcels" : [ { "product" : "...", "version" : "...", "stage" : "...", "state" : {}, "clusterRef" : {}, "displayName" : "...", "description" : "..." }, { "product" : "...", "version" : "...", "stage" : "...", "state" : {}, "clusterRef" : {}, "displayName" : "...", "description" : "..." } ], "clusterUrl" : "...", "hostsUrl" : "...", "entityStatus" : "DOWN", "uuid" : "...", "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ], "clusterType" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "displayName" : "...", "fullVersion" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "CONTROL_PLANE" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "NA", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "CLUSTER" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "STOPPING", "tags" : [ {}, {} ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "UNKNOWN", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "ROLE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "STOPPING", "tags" : [ {}, {} ], "serviceVersion" : "..." } ], "parcels" : [ { "product" : "...", "version" : "...", "stage" : "...", "state" : {}, "clusterRef" : {}, "displayName" : "...", "description" : "..." }, { "product" : "...", "version" : "...", "stage" : "...", "state" : {}, "clusterRef" : {}, "displayName" : "...", "description" : "..." } ], "clusterUrl" : "...", "hostsUrl" : "...", "entityStatus" : "DISABLED_HEALTH", "uuid" : "...", "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ], "clusterType" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ], "hosts" : [ { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "BUSY" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTING" } ], "healthSummary" : "HISTORY_NOT_AVAILABLE", "healthChecks" : [ { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "DECOMMISSIONING", "maintenanceOwners" : [ "CLUSTER", "CLUSTER" ], "config" : { "items" : [ {}, {} ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "STOPPED", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "UBUNTU_PRECISE", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "UNKNOWN" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" } ], "healthSummary" : "BAD", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "DECOMMISSIONED", "maintenanceOwners" : [ "SERVICE", "CONTROL_PLANE" ], "config" : { "items" : [ {}, {} ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "STOPPED", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "SLES12", "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" : "STARTED", "healthSummary" : "BAD", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "SERVICE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "HISTORY_NOT_AVAILABLE", "commissionState" : "OFFLINING", "healthSummary" : "BAD", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "CLUSTER" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION", "entityStatus" : "HISTORY_NOT_AVAILABLE", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STARTED", "commissionState" : "UNKNOWN", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "SERVICE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_OBSERVER", "entityStatus" : "STOPPING", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "DAY", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "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" : "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "allHostsConfig" : { "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" : "WARNING", "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" : [ {}, {} ] } ] } }, "description" : "This objects represents a deployment including all clusters, hosts,\nservices, roles, etc in the system. It can be used to save and restore\nall settings." }, "ApiDeployment2" : { "type" : "object", "title" : "ApiDeployment2", "properties" : { "timestamp" : { "description" : "Readonly. This timestamp is provided when you request a deployment and\nis not required (or even read) when creating a deployment. This\ntimestamp is useful if you have multiple deployments saved and\nwant to determine which one to use as a restore point.", "type" : "string" }, "clusters" : { "description" : "List of clusters in the system including their services, roles and\ncomplete config values.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiCluster" } }, "hosts" : { "description" : "List of hosts in the system", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHost" } }, "authRoles" : { "description" : "List of all auth roles in the system\nAvailable from v32", "type" : "array", "items" : { "$ref" : "#/definitions/ApiAuthRole" } }, "externalUserMappings" : { "description" : "List of all external user mappings in the system\nAvailable from v32", "type" : "array", "items" : { "$ref" : "#/definitions/ApiExternalUserMapping" } }, "users" : { "description" : "List of all users in the system", "type" : "array", "items" : { "$ref" : "#/definitions/ApiUser2" } }, "versionInfo" : { "description" : "Full version information about the running Cloudera Manager instance", "$ref" : "#/definitions/ApiVersionInfo" }, "managementService" : { "description" : "The full configuration of the Cloudera Manager management service\nincluding all the management roles and their config values", "$ref" : "#/definitions/ApiService" }, "managerSettings" : { "description" : "The full configuration of Cloudera Manager itself including licensing info", "$ref" : "#/definitions/ApiConfigList" }, "allHostsConfig" : { "description" : "Configuration parameters that apply to all hosts, unless overridden at\nthe host level. Available since API v3.", "$ref" : "#/definitions/ApiConfigList" }, "peers" : { "description" : "The list of peers configured in Cloudera Manager.\nAvailable since API v3.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiCmPeer" } }, "hostTemplates" : { "description" : "The list of all host templates in Cloudera Manager.", "$ref" : "#/definitions/ApiHostTemplateList" }, "dataContexts" : { "description" : "The list of all the data contexts in the Cloudera Manager.", "$ref" : "#/definitions/ApiDataContextList" } }, "example" : { "timestamp" : "...", "clusters" : [ { "name" : "...", "displayName" : "...", "fullVersion" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "HOST" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "HISTORY_NOT_AVAILABLE", "healthSummary" : "BAD", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "SERVICE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "CONCERNING_HEALTH", "tags" : [ {}, {} ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "STARTING", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "CONTROL_PLANE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "GOOD_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" : [ "ROLE", "ROLE" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "NA", "healthSummary" : "DISABLED", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "CLUSTER" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "STOPPING", "tags" : [ {}, {} ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "STARTING", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "ROLE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "HISTORY_NOT_AVAILABLE", "tags" : [ {}, {} ], "serviceVersion" : "..." } ], "parcels" : [ { "product" : "...", "version" : "...", "stage" : "...", "state" : {}, "clusterRef" : {}, "displayName" : "...", "description" : "..." }, { "product" : "...", "version" : "...", "stage" : "...", "state" : {}, "clusterRef" : {}, "displayName" : "...", "description" : "..." } ], "clusterUrl" : "...", "hostsUrl" : "...", "entityStatus" : "NONE", "uuid" : "...", "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ], "clusterType" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ], "hosts" : [ { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPING" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "HISTORY_NOT_AVAILABLE" } ], "healthSummary" : "CONCERNING", "healthChecks" : [ { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "UNKNOWN", "maintenanceOwners" : [ "HOST", "HOST" ], "config" : { "items" : [ {}, {} ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "GOOD_HEALTH", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "UBUNTU_FOCAL", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPING" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "UNKNOWN" } ], "healthSummary" : "HISTORY_NOT_AVAILABLE", "healthChecks" : [ { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "UNKNOWN", "maintenanceOwners" : [ "SERVICE", "ROLE" ], "config" : { "items" : [ {}, {} ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "UNKNOWN_HEALTH", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "RHEL8", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ], "authRoles" : [ { "displayName" : "...", "name" : "...", "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "users" : [ { "name" : "..." }, { "name" : "..." } ], "externalUserMappings" : [ { "uuid" : "...", "name" : "...", "type" : "EXTERNAL_PROGRAM" }, { "uuid" : "...", "name" : "...", "type" : "EXTERNAL_PROGRAM" } ], "baseRole" : { "displayName" : "...", "name" : "...", "uuid" : "..." }, "uuid" : "...", "isCustom" : true }, { "displayName" : "...", "name" : "...", "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "users" : [ { "name" : "..." }, { "name" : "..." } ], "externalUserMappings" : [ { "uuid" : "...", "name" : "...", "type" : "EXTERNAL_PROGRAM" }, { "uuid" : "...", "name" : "...", "type" : "LDAP" } ], "baseRole" : { "displayName" : "...", "name" : "...", "uuid" : "..." }, "uuid" : "...", "isCustom" : true } ], "externalUserMappings" : [ { "name" : "...", "type" : "LDAP", "uuid" : "...", "authRoles" : [ { "displayName" : "...", "name" : "...", "uuid" : "..." }, { "displayName" : "...", "name" : "...", "uuid" : "..." } ] }, { "name" : "...", "type" : "SAML_SCRIPT", "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" : "NA", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "HOST" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STARTING", "commissionState" : "DECOMMISSIONED", "healthSummary" : "GOOD", "configStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "SERVICE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "STANDALONE", "entityStatus" : "STOPPED", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPED", "commissionState" : "DECOMMISSIONING", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "ROLE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER", "entityStatus" : "DOWN", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "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", "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" : "WARNING", "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" : [ {}, {} ] } ] }, "dataContexts" : { "items" : [ { "name" : "...", "displayName" : "...", "nameservice" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "services" : [ {}, {} ], "servicesDetails" : [ {}, {} ], "supportedServiceTypes" : [ "...", "..." ], "allowedClusterVersions" : [ {}, {} ], "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "STALE", "healthSummary" : "CONCERNING" }, { "name" : "...", "displayName" : "...", "nameservice" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "services" : [ {}, {} ], "servicesDetails" : [ {}, {} ], "supportedServiceTypes" : [ "...", "..." ], "allowedClusterVersions" : [ {}, {} ], "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthSummary" : "DISABLED" } ] } }, "description" : "This objects represents a deployment including all clusters, hosts,\nservices, roles, etc in the system. It can be used to save and restore\nall settings. This model will be used v18 and beyond since users will be represented\nby ApiUser2 v18 and beyond." }, "ApiDisableJtHaArguments" : { "type" : "object", "title" : "ApiDisableJtHaArguments", "properties" : { "activeName" : { "description" : "Name of the JobTracker that will be active after HA is disabled.", "type" : "string" } }, "example" : { "activeName" : "..." }, "description" : "Arguments used for disable JT HA command." }, "ApiDisableLlamaHaArguments" : { "type" : "object", "title" : "ApiDisableLlamaHaArguments", "properties" : { "activeName" : { "description" : "Name of the Llama role that will be active after HA is disabled.", "type" : "string" } }, "example" : { "activeName" : "..." }, "description" : "Arguments used for disable Llama HA command." }, "ApiDisableNnHaArguments" : { "type" : "object", "title" : "ApiDisableNnHaArguments", "properties" : { "activeNnName" : { "description" : "Name of the NamdeNode role that is going to be active after\nHigh Availability is disabled.", "type" : "string" }, "snnHostId" : { "description" : "Id of the host where the new SecondaryNameNode will be created.", "type" : "string" }, "snnCheckpointDirList" : { "description" : "List of directories used for checkpointing by the new SecondaryNameNode.", "type" : "array", "items" : { "type" : "string" } }, "snnName" : { "description" : "Name of the new SecondaryNameNode role (Optional).", "type" : "string" } }, "example" : { "activeNnName" : "...", "snnHostId" : "...", "snnCheckpointDirList" : [ "...", "..." ], "snnName" : "..." }, "description" : "Arguments used for Disable NameNode High Availability command." }, "ApiDisableOozieHaArguments" : { "type" : "object", "title" : "ApiDisableOozieHaArguments", "properties" : { "activeName" : { "description" : "Name of the Oozie Server that will be active after HA is disabled.", "type" : "string" } }, "example" : { "activeName" : "..." }, "description" : "" }, "ApiDisableRmHaArguments" : { "type" : "object", "title" : "ApiDisableRmHaArguments", "properties" : { "activeName" : { "description" : "Name of the ResourceManager that will be active after HA is disabled.", "type" : "string" } }, "example" : { "activeName" : "..." }, "description" : "Arguments used for Disable RM HA command." }, "ApiDisableSentryHaArgs" : { "type" : "object", "title" : "ApiDisableSentryHaArgs", "properties" : { "activeName" : { "description" : "Name of the single role that will remain active after HA is disabled.", "type" : "string" } }, "example" : { "activeName" : "..." }, "description" : "Arguments used for disable Sentry HA API call." }, "ApiEcho" : { "type" : "object", "title" : "ApiEcho", "properties" : { "message" : { "description" : "", "type" : "string" } }, "example" : { "message" : "..." }, "description" : "The echoMessage carries a message to be echoed back from the API service." }, "ApiEnableJtHaArguments" : { "type" : "object", "title" : "ApiEnableJtHaArguments", "properties" : { "newJtHostId" : { "description" : "Id of host on which second JobTracker role will be added.", "type" : "string" }, "forceInitZNode" : { "description" : "Initialize the ZNode even if it already exists. This can happen if\nJobTracker HA was enabled before and then disabled. Disable operation\ndoesn't delete this ZNode. Defaults to true.", "type" : "boolean" }, "zkServiceName" : { "description" : "Name of the ZooKeeper service that will be used for auto-failover.\nThis is an optional parameter if the MapReduce to ZooKeeper dependency is\nalready set in CM.", "type" : "string" }, "newJtRoleName" : { "description" : "Name of the second JobTracker role to be created (Optional)", "type" : "string" }, "fc1RoleName" : { "description" : "Name of first Failover Controller role to be created.\nThis is the Failover Controller co-located with the current\nJobTracker (Optional)", "type" : "string" }, "fc2RoleName" : { "description" : "Name of second Failover Controller role to be created.\nThis is the Failover Controller co-located with the new\nJobTracker (Optional)", "type" : "string" }, "logicalName" : { "description" : "Logical name of the JobTracker pair. If value is not provided,\n\"logicaljt\" is used as the default. The name can contain\nonly alphanumeric characters and \"-\".\n\nAvailable since API v8.", "type" : "string" } }, "example" : { "newJtHostId" : "...", "forceInitZNode" : true, "zkServiceName" : "...", "newJtRoleName" : "...", "fc1RoleName" : "...", "fc2RoleName" : "...", "logicalName" : "..." }, "description" : "Arguments used for enable JT HA command." }, "ApiEnableLlamaHaArguments" : { "type" : "object", "title" : "ApiEnableLlamaHaArguments", "properties" : { "newLlamaHostId" : { "description" : "HostId of the host on which the second Llama role will be created.", "type" : "string" }, "newLlamaRoleName" : { "description" : "Name of the second Llama role to be created (optional).", "type" : "string" }, "zkServiceName" : { "description" : "Name of the ZooKeeper service that will be used for auto-failover.\nThis argument may be omitted if the ZooKeeper dependency for Impala\nis already configured.", "type" : "string" } }, "example" : { "newLlamaHostId" : "...", "newLlamaRoleName" : "...", "zkServiceName" : "..." }, "description" : "Arguments used for enable Llama HA command." }, "ApiEnableLlamaRmArguments" : { "type" : "object", "title" : "ApiEnableLlamaRmArguments", "required" : [ "skipRestart" ], "properties" : { "llama1HostId" : { "description" : "HostId of the host on which the first Llama role will be created.", "type" : "string" }, "llama1RoleName" : { "description" : "Name of the first Llama role to be created (optional).", "type" : "string" }, "llama2HostId" : { "description" : "HostId of the host on which the second Llama role will be created.", "type" : "string" }, "llama2RoleName" : { "description" : "Name of the second Llama role to be created (optional).", "type" : "string" }, "zkServiceName" : { "description" : "Name of the ZooKeeper service that will be used for auto-failover.\nOnly relevant when enabling Llama RM in HA mode (i.e., when two\nLlama roles are being created). This argument may be omitted if\nthe ZooKeeper dependency for Impala is already configured.", "type" : "string" }, "skipRestart" : { "description" : "Skip the restart of Yarn, Impala, and their dependent services,\nand don't deploy client configuration. Default is false (i.e.,\nby default, the services are restarted and client configuration\nis deployed).", "type" : "boolean" } }, "example" : { "llama1HostId" : "...", "llama1RoleName" : "...", "llama2HostId" : "...", "llama2RoleName" : "...", "zkServiceName" : "...", "skipRestart" : true }, "description" : "Arguments used for enable Llama RM command." }, "ApiEnableNnHaArguments" : { "type" : "object", "title" : "ApiEnableNnHaArguments", "properties" : { "activeNnName" : { "description" : "Name of the NameNode role that is going to be made Highly Available.", "type" : "string" }, "standbyNnName" : { "description" : "Name of the new Standby NameNode role that will be created during the\ncommand (Optional).", "type" : "string" }, "standbyNnHostId" : { "description" : "Id of the host on which new Standby NameNode will be created.", "type" : "string" }, "standbyNameDirList" : { "description" : "List of directories for the new Standby NameNode.\nIf not provided then it will use same dirs as Active NameNode.", "type" : "array", "items" : { "type" : "string" } }, "nameservice" : { "description" : "Nameservice to be used while enabling Highly Available.\nIt must be specified if Active NameNode isn't configured with it.\nIf Active NameNode is already configured, then this need not\nbe specified. However, if it is still specified, it must match\nthe existing config for the Active NameNode.", "type" : "string" }, "qjName" : { "description" : "Name of the journal located on each JournalNodes' filesystem.\nThis can be optionally provided if the config hasn't already been set for the\nActive NameNode.\nIf this isn't provided and Active NameNode doesn't also have the config,\nthen nameservice is used by default. If Active NameNode already has this configured,\nthen it much match the existing config.", "type" : "string" }, "activeFcName" : { "description" : "Name of the FailoverController role to be created on\nActive NameNode's host (Optional).", "type" : "string" }, "standbyFcName" : { "description" : "Name of the FailoverController role to be created on\nStandby NameNode's host (Optional).", "type" : "string" }, "zkServiceName" : { "description" : "Name of the ZooKeeper service to be used for Auto-Failover.\nThis MUST be provided if HDFS doesn't have a ZooKeeper dependency.\nIf the dependency is already set, then this should be the name of the same\nZooKeeper service, but can also be omitted in that case.", "type" : "string" }, "jns" : { "description" : "Arguments for the JournalNodes to be created during the command.\nMust be provided only if JournalNodes don't exist already in HDFS.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiJournalNodeArguments" } }, "forceInitZNode" : { "description" : "Boolean indicating if the ZNode should be force initialized if it is\nalready present. Useful while re-enabling High Availability. (Default: TRUE)", "type" : "boolean" }, "clearExistingStandbyNameDirs" : { "description" : "Boolean indicating if the existing name directories for Standby NameNode\nshould be cleared during the workflow.\nUseful while re-enabling High Availability. (Default: TRUE)", "type" : "boolean" }, "clearExistingJnEditsDir" : { "description" : "Boolean indicating if the existing edits directories for the JournalNodes\nfor the specified nameservice should be cleared during the workflow.\nUseful while re-enabling High Availability. (Default: TRUE)", "type" : "boolean" } }, "example" : { "activeNnName" : "...", "standbyNnName" : "...", "standbyNnHostId" : "...", "standbyNameDirList" : [ "...", "..." ], "nameservice" : "...", "qjName" : "...", "activeFcName" : "...", "standbyFcName" : "...", "zkServiceName" : "...", "jns" : [ { "jnName" : "...", "jnHostId" : "...", "jnEditsDir" : "..." }, { "jnName" : "...", "jnHostId" : "...", "jnEditsDir" : "..." } ], "forceInitZNode" : true, "clearExistingStandbyNameDirs" : true, "clearExistingJnEditsDir" : true }, "description" : "Arguments used for Enable NameNode High Availability command." }, "ApiEnableOozieHaArguments" : { "type" : "object", "title" : "ApiEnableOozieHaArguments", "properties" : { "newOozieServerHostIds" : { "description" : "IDs of the hosts on which new Oozie Servers will be added.", "type" : "array", "items" : { "type" : "string" } }, "newOozieServerRoleNames" : { "description" : "Names of the new Oozie Servers. This is an optional argument,\nbut if provided, it should match the length of host IDs provided.", "type" : "array", "items" : { "type" : "string" } }, "zkServiceName" : { "description" : "Name of the ZooKeeper service that will be used for Oozie HA.\nThis is an optional parameter if the Oozie to ZooKeeper dependency is\nalready set in CM.", "type" : "string" }, "loadBalancerHostname" : { "description" : "Hostname of the load balancer used for Oozie HA.\nOptional if load balancer host and ports are already set in CM.", "type" : "string" }, "loadBalancerPort" : { "description" : "HTTP port of the load balancer used for Oozie HA.\nOptional if load balancer host and ports are already set in CM.", "type" : "integer" }, "loadBalancerSslPort" : { "description" : "HTTPS port of the load balancer used for Oozie HA when SSL is enabled.\nThis port is only used for oozie.base.url -- the callback is always\non HTTP.\nOptional if load balancer host and ports are already set in CM.", "type" : "integer" }, "loadBalancerHostPort" : { "description" : "Address of the load balancer used for Oozie HA.\nThis is an optional parameter if this config is already set in CM.", "type" : "string" } }, "example" : { "newOozieServerHostIds" : [ "...", "..." ], "newOozieServerRoleNames" : [ "...", "..." ], "zkServiceName" : "...", "loadBalancerHostname" : "...", "loadBalancerPort" : 12345, "loadBalancerSslPort" : 12345 }, "description" : "" }, "ApiEnableRmHaArguments" : { "type" : "object", "title" : "ApiEnableRmHaArguments", "properties" : { "newRmHostId" : { "description" : "Id of host on which second ResourceManager role will be added.", "type" : "string" }, "newRmRoleName" : { "description" : "Name of the second ResourceManager role to be created (Optional)", "type" : "string" }, "zkServiceName" : { "description" : "Name of the ZooKeeper service that will be used for auto-failover.\nThis is an optional parameter if the Yarn to ZooKeeper dependency is\nalready set in CM.", "type" : "string" } }, "example" : { "newRmHostId" : "...", "newRmRoleName" : "...", "zkServiceName" : "..." }, "description" : "Arguments used for enable RM HA command." }, "ApiEnableSentryHaArgs" : { "type" : "object", "title" : "ApiEnableSentryHaArgs", "properties" : { "newSentryHostId" : { "description" : "Id of host on which new Sentry Server role will be added.", "type" : "string" }, "newSentryRoleName" : { "description" : "Name of the new Sentry Server role to be created. This is an\noptional argument.", "type" : "string" }, "zkServiceName" : { "description" : "Name of the ZooKeeper service that will be used for Sentry HA.\nThis is an optional parameter if the Sentry to ZooKeeper dependency is\nalready set in CM.", "type" : "string" }, "rrcArgs" : { "description" : "", "$ref" : "#/definitions/ApiSimpleRollingRestartClusterArgs" } }, "example" : { "newSentryHostId" : "...", "newSentryRoleName" : "...", "zkServiceName" : "...", "rrcArgs" : { "slaveBatchSize" : 12345, "sleepSeconds" : 12345, "slaveFailCountThreshold" : 12345 } }, "description" : "Arguments used for enable Sentry HA command." }, "ApiEndPoint" : { "type" : "object", "title" : "ApiEndPoint", "properties" : { "name" : { "description" : "Name for the endPoint.", "type" : "string" }, "version" : { "description" : "Endpoint specific version.", "type" : "string" }, "serviceConfigs" : { "description" : "Additional configs for the endPoint.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiMapEntry" } }, "endPointHostList" : { "description" : "List hosts (uris) for this endPoint.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEndPointHost" } }, "serviceType" : { "description" : "Endpoint service type.", "type" : "string" } }, "example" : { "name" : "...", "version" : "...", "serviceConfigs" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "endPointHostList" : [ { "uri" : "...", "endPointConfigs" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "type" : "..." }, { "uri" : "...", "endPointConfigs" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "type" : "..." } ], "serviceType" : "..." }, "description" : "This defines a single logical service in the SDX cluster. A single service can expose one\nor more URLs. This ApiEndPoint groups the URLs logically for configuration, versioning,\nor any other service specific reason." }, "ApiEndPointHost" : { "type" : "object", "title" : "ApiEndPointHost", "properties" : { "uri" : { "description" : "Uri for the endPoint.", "type" : "string" }, "endPointConfigs" : { "description" : "EndPointHost specific configs.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiMapEntry" } }, "type" : { "description" : "Get endPointHost type.", "type" : "string" } }, "example" : { "uri" : "...", "endPointConfigs" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "type" : "..." }, "description" : "A host endPoint for a service." }, "ApiEntityStatus" : { "type" : "string", "title" : "ApiEntityStatus", "enum" : [ "UNKNOWN", "NONE", "STOPPED", "DOWN", "UNKNOWN_HEALTH", "DISABLED_HEALTH", "CONCERNING_HEALTH", "BAD_HEALTH", "GOOD_HEALTH", "STARTING", "STOPPING", "HISTORY_NOT_AVAILABLE" ], "description" : "The single value used by the Cloudera Manager UI to represent the status of\nthe entity. It is computed from a variety of other entity-specific states,\nnot all values apply to all entities. For example, STARTING/STOPPING do not\napply to a host." }, "ApiEntityTag" : { "type" : "object", "title" : "ApiEntityTag", "properties" : { "name" : { "description" : "", "type" : "string" }, "value" : { "description" : "", "type" : "string" } }, "example" : { "name" : "...", "value" : "..." }, "description" : "Tag associated with an Entity in a Cloudera Manager instance" }, "ApiEntityType" : { "type" : "string", "title" : "ApiEntityType", "enum" : [ "CLUSTER", "SERVICE", "ROLE", "HOST", "CONTROL_PLANE" ], "description" : "Represents the types of entities." }, "ApiEvent" : { "type" : "object", "title" : "ApiEvent", "properties" : { "id" : { "description" : "A unique ID for this event.", "type" : "string" }, "content" : { "description" : "The content payload of this event.", "type" : "string" }, "timeOccurred" : { "description" : "When the event was generated.", "type" : "string" }, "timeReceived" : { "description" : "When the event was stored by Cloudera Manager. Events do not arrive in\nthe order that they are generated. If you are writing an event poller,\nthis is a useful field to query.", "type" : "string" }, "category" : { "description" : "The category of this event -- whether it is a health event, an audit\nevent, an activity event, etc.", "$ref" : "#/definitions/ApiEventCategory" }, "severity" : { "description" : "The severity of the event.", "$ref" : "#/definitions/ApiEventSeverity" }, "alert" : { "description" : "Whether the event is promoted to an alert according to configuration. Defaults to false", "type" : "boolean" }, "attributes" : { "description" : "A list of key-value attribute pairs.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEventAttribute" } } }, "example" : { "id" : "...", "content" : "...", "timeOccurred" : "...", "timeReceived" : "...", "category" : "AUDIT_EVENT", "severity" : "INFORMATIONAL", "alert" : true, "attributes" : [ { "name" : "...", "values" : [ "...", "..." ] }, { "name" : "...", "values" : [ "...", "..." ] } ] }, "description" : "Events model noteworthy incidents in Cloudera Manager or the managed\nHadoop cluster. An event carries its event category, severity, and a\nstring content. They also have generic attributes, which are free-form\nkey value pairs. Important events may be promoted into alerts." }, "ApiEventAttribute" : { "type" : "object", "title" : "ApiEventAttribute", "properties" : { "name" : { "description" : "", "type" : "string" }, "values" : { "description" : "", "type" : "array", "items" : { "type" : "string" } } }, "example" : { "name" : "...", "values" : [ "...", "..." ] }, "description" : "" }, "ApiEventCategory" : { "type" : "string", "title" : "ApiEventCategory", "enum" : [ "UNKNOWN", "HEALTH_EVENT", "LOG_EVENT", "AUDIT_EVENT", "ACTIVITY_EVENT", "HBASE", "SYSTEM" ], "description" : "" }, "ApiEventQueryResult" : { "type" : "object", "title" : "ApiEventQueryResult", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "totalResults" : { "description" : "The total number of matched results. Some are possibly not shown due\nto pagination.", "type" : "integer" }, "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEvent" } } } } ], "example" : { "totalResults" : 12345, "items" : [ { "id" : "...", "content" : "...", "timeOccurred" : "...", "timeReceived" : "...", "category" : "SYSTEM", "severity" : "CRITICAL", "alert" : true, "attributes" : [ { "name" : "...", "values" : [ "...", "..." ] }, { "name" : "...", "values" : [ "...", "..." ] } ] }, { "id" : "...", "content" : "...", "timeOccurred" : "...", "timeReceived" : "...", "category" : "UNKNOWN", "severity" : "INFORMATIONAL", "alert" : true, "attributes" : [ { "name" : "...", "values" : [ "...", "..." ] }, { "name" : "...", "values" : [ "...", "..." ] } ] } ] }, "description" : "A generic list." }, "ApiEventSeverity" : { "type" : "string", "title" : "ApiEventSeverity", "enum" : [ "UNKNOWN", "INFORMATIONAL", "IMPORTANT", "CRITICAL" ], "description" : "" }, "ApiExternalAccount" : { "type" : "object", "title" : "ApiExternalAccount", "properties" : { "name" : { "description" : "Represents the intial name of the account; used to uniquely identify this account.", "type" : "string" }, "displayName" : { "description" : "Represents a modifiable label to identify this account for user-visible purposes.", "type" : "string" }, "createdTime" : { "description" : "Represents the time of creation for this account.", "type" : "string" }, "lastModifiedTime" : { "description" : "Represents the last modification time for this account.", "type" : "string" }, "typeName" : { "description" : "Represents the Type ID of a supported external account type.\nThe type represented by this field dictates which configuration options must be defined\nfor this account.", "type" : "string" }, "accountConfigs" : { "description" : "Represents the account configuration for this account.\n\nWhen an account is retrieved from the server,\nthe configs returned must match allowed configuration for the type of this account.\n\nWhen specified for creation of a new account or for the update of an existing account,\nthis field must include every required configuration parameter specified in the type's definition,\nwith the account configuration's value field specified to represent the specific\nconfiguration desired for this account.", "$ref" : "#/definitions/ApiConfigList" } }, "example" : { "name" : "...", "displayName" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "typeName" : "...", "accountConfigs" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "Represents an instantiation of an external account type, referencing a supported\nexternal account type, via the typeName field, along with suitable configuration to\naccess an external resource of the provided type.\n\nThe typeName field must match the name of an external account type." }, "ApiExternalAccountCategory" : { "type" : "object", "title" : "ApiExternalAccountCategory", "properties" : { "name" : { "description" : "Represents an identifier for a category.", "type" : "string" }, "displayName" : { "description" : "Represents a localized display name for a category.", "type" : "string" }, "description" : { "description" : "Represents a localized description for a category.", "type" : "string" } }, "example" : { "name" : "...", "displayName" : "...", "description" : "..." }, "description" : "Type representing an external account category." }, "ApiExternalAccountCategoryList" : { "type" : "object", "title" : "ApiExternalAccountCategoryList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiExternalAccountCategory" } } } } ], "example" : { "items" : [ { "name" : "...", "displayName" : "...", "description" : "..." }, { "name" : "...", "displayName" : "...", "description" : "..." } ] }, "description" : "Represents a list of external account categories." }, "ApiExternalAccountList" : { "type" : "object", "title" : "ApiExternalAccountList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiExternalAccount" } } } } ], "example" : { "items" : [ { "name" : "...", "displayName" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "typeName" : "...", "accountConfigs" : { "items" : [ {}, {} ] } }, { "name" : "...", "displayName" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "typeName" : "...", "accountConfigs" : { "items" : [ {}, {} ] } } ] }, "description" : "Represents a list of external accounts." }, "ApiExternalAccountType" : { "type" : "object", "title" : "ApiExternalAccountType", "properties" : { "name" : { "description" : "Represents the immutable name for this account.", "type" : "string" }, "categoryName" : { "description" : "Represents the category of this account.", "type" : "string" }, "type" : { "description" : "Represents the type for this account.", "type" : "string" }, "displayName" : { "description" : "Represents the localized display name for this account.", "type" : "string" }, "description" : { "description" : "Represents the localized description for this account type.", "type" : "string" }, "allowedAccountConfigs" : { "description" : "Represents the list of allowed account configs.", "$ref" : "#/definitions/ApiConfigList" } }, "example" : { "name" : "...", "categoryName" : "...", "type" : "...", "displayName" : "...", "description" : "...", "allowedAccountConfigs" : { "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "A supported external account type.\nAn external account type represents an external authentication source that is used by\nCloudera Manager in its APIs to take suitable actions that require authentication to an\nexternal service.\n\nAn external account type is uniquely identified by a server-generated ID and identifies with\na category identifier: e.g. The \"AWS\" category has an account type \"AWS_Access_Key_Authorization\"" }, "ApiExternalAccountTypeList" : { "type" : "object", "title" : "ApiExternalAccountTypeList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiExternalAccountType" } } } } ], "example" : { "items" : [ { "name" : "...", "categoryName" : "...", "type" : "...", "displayName" : "...", "description" : "...", "allowedAccountConfigs" : { "items" : [ {}, {} ] } }, { "name" : "...", "categoryName" : "...", "type" : "...", "displayName" : "...", "description" : "...", "allowedAccountConfigs" : { "items" : [ {}, {} ] } } ] }, "description" : "Represents a list of external account types." }, "ApiExternalUserMapping" : { "type" : "object", "title" : "ApiExternalUserMapping", "properties" : { "name" : { "description" : "The name of the external mapping", "type" : "string" }, "type" : { "description" : "The type of the external mapping", "$ref" : "#/definitions/ApiExternalUserMappingType" }, "uuid" : { "description" : "Readonly. The UUID of the authRole.\n
", "type" : "string" }, "authRoles" : { "description" : "A list of ApiAuthRole that this user possesses.\n\nEach custom role with be a built-in role with a set of scopes.\nApiAuthRole is the model for specifying custom roles.\nOnly admins and user admins can create/delete/update external\nuser mappings.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiAuthRoleRef" } } }, "example" : { "name" : "...", "type" : "EXTERNAL_PROGRAM", "uuid" : "...", "authRoles" : [ { "displayName" : "...", "name" : "...", "uuid" : "..." }, { "displayName" : "...", "name" : "...", "uuid" : "..." } ] }, "description" : "This is the model for external user mapping information in the API, v19 and beyond.\nThese can be of 4 types : LDAP group, SAML, SAML attribute and External Script.\n
" }, "ApiExternalUserMappingList" : { "type" : "object", "title" : "ApiExternalUserMappingList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiExternalUserMapping" } } } } ], "example" : { "items" : [ { "name" : "...", "type" : "SAML_SCRIPT", "uuid" : "...", "authRoles" : [ { "displayName" : "...", "name" : "...", "uuid" : "..." }, { "displayName" : "...", "name" : "...", "uuid" : "..." } ] }, { "name" : "...", "type" : "EXTERNAL_PROGRAM", "uuid" : "...", "authRoles" : [ { "displayName" : "...", "name" : "...", "uuid" : "..." }, { "displayName" : "...", "name" : "...", "uuid" : "..." } ] } ] }, "description" : "A list of external user mappings." }, "ApiExternalUserMappingRef" : { "type" : "object", "title" : "ApiExternalUserMappingRef", "properties" : { "uuid" : { "description" : "The uuid of the external user mapping, which uniquely identifies it in a CM installation.", "type" : "string" }, "name" : { "description" : "The name of the mapping.", "type" : "string" }, "type" : { "description" : "The type of the mapping.", "$ref" : "#/definitions/ApiExternalUserMappingType" } }, "example" : { "uuid" : "...", "name" : "...", "type" : "SAML_SCRIPT" }, "description" : "An externalUserMappingRef references an externalUserMapping." }, "ApiExternalUserMappingType" : { "type" : "string", "title" : "ApiExternalUserMappingType", "enum" : [ "LDAP", "SAML_SCRIPT", "SAML_ATTRIBUTE", "EXTERNAL_PROGRAM" ], "description" : "Enum for external user mapping types" }, "ApiGenerateCmcaArguments" : { "type" : "object", "title" : "ApiGenerateCmcaArguments", "allOf" : [ { "$ref" : "#/definitions/BaseApiSshCmdArguments" }, { "properties" : { "location" : { "example" : "/opt/cloudera/CMCA", "description" : "The location on disk to store the CMCA directory. If there is already a CMCA created there,\nit will be backed up, and a new one will be created in its place.", "type" : "string" }, "customCA" : { "example" : false, "description" : "Whether to generate an internal CMCA (false) or use user-provided certificates (true).\n\nWhen set to true (user-provided certificates), the following other arguments must be given:\n* cmHostCert\n* cmHostKey\n* caCert\n* keystorePasswd\n* truststorePasswd", "type" : "boolean" }, "interpretAsFilenames" : { "example" : true, "description" : "Whether the following arguments are interpreted as filenames local to the Cloudera Manager\nhost (true, default) or as the actual data for that argument:\n* cmHostCert\n* cmHostKey\n* caCert\n* keystorePasswd\n* truststorePasswd\n* trustedCaCerts\n* hostCerts.hostCert\n* hostCerts.hostKey\n\nIf HTTPS has not been enabled on the Cloudera Manager Admin Console and API, we\n*strongly* recommend that you pass the arguments as filenames local to the Cloudera Manager\nhost (i.e. set to true) to avoid leaking sensitive information over the wire in plaintext.", "type" : "boolean" }, "cmHostCert" : { "example" : "host-cert.pem", "description" : "The certificate for the CM host in PEM format. Only used if customCA == true.", "type" : "string" }, "cmHostKey" : { "example" : "host-key.pem", "description" : "The private key for the CM host in PEM format. Only used if customCA == true.", "type" : "string" }, "caCert" : { "example" : "ca-cert.pem", "description" : "The certificate for the user-provided certificate authority in PEM format. Only used if\ncustomCA == true.", "type" : "string" }, "keystorePasswd" : { "example" : "keystore.pw.txt", "description" : "The password used for all Auto-TLS keystores. Only used if customCA == true.", "type" : "string" }, "truststorePasswd" : { "example" : "truststore.pw.txt", "description" : "The password used for all Auto-TLS truststores. Only used if customCA == true.", "type" : "string" }, "trustedCaCerts" : { "example" : "cacerts.pem", "description" : "A list of CA certificates that will be imported into the Auto-TLS truststore and\ndistributed to all hosts.", "type" : "string" }, "additionalArguments" : { "example" : "--override", "description" : "A list of additional arguments that can be passed to the certificate manager", "type" : "array", "items" : { "type" : "string" } }, "hostCerts" : { "description" : "A list of HostCertInfo objects, which associate a hostname with the corresponding\ncertificate and private key. Only used if customCA == true.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHostCertInfo" } }, "configureAllServices" : { "description" : "Whether to configure all existing services to use Auto-TLS. Defaults to false.\n\nIf false, only MGMT services will be configured to use Auto-TLS. Use the cluster-level\nConfigureAutoTlsServices command to configure Auto-TLS services for a single cluster only.\n\nAll future services will be configured to use Auto-TLS regardless of this setting.", "type" : "boolean" } } } ], "example" : { "location" : "/opt/cloudera/CMCA", "customCA" : false, "interpretAsFilenames" : true, "cmHostCert" : "host-cert.pem", "cmHostKey" : "host-key.pem", "caCert" : "ca-cert.pem", "keystorePasswd" : "keystore.pw.txt", "truststorePasswd" : "truststore.pw.txt", "trustedCaCerts" : "cacerts.pem", "additionalArguments" : [ "--override", "ca_expiration=301010" ], "hostCerts" : [ { "hostname" : "...", "certificate" : "host-cert.pem", "key" : "host-key.pem", "subjectAltNames" : [ "DNS:example.cloudera.com", "..." ] }, { "hostname" : "...", "certificate" : "...", "key" : "...", "subjectAltNames" : [ "...", "DNS:example.cloudera.com" ] } ], "configureAllServices" : true, "sshPort" : 22, "userName" : "...", "password" : "...", "privateKey" : "...", "passphrase" : "..." }, "description" : "Arguments to generate a Cloudera Manager Certificate Authority (CMCA)." }, "ApiGenerateCopyDockerArgs" : { "type" : "object", "title" : "ApiGenerateCopyDockerArgs", "required" : [ "selectedFeaturesOnly" ], "properties" : { "remoteRepoUrl" : { "description" : "The url of the remote repository where the private cloud artifacts to install are hosted", "type" : "string" }, "dockerRegistry" : { "description" : "The url of the Docker Registry where images required for install will be copied to", "type" : "string" }, "controlPlaneUuid" : { "description" : "Optional. The uuid of the control plane, if copying docker images for an upgrade", "type" : "string" }, "selectedFeatures" : { "description" : "Optional. The name of the feature(s) in a comma separated list that container images/packages are associated with.\nWhen it is null, copy all the images.", "type" : "string" }, "selectedFeaturesOnly" : { "description" : "Optional. If true, then only images/packages that belong to the selected features will be processed.\nIf false, then images/packages that don't belong to any features will also be processed in\naddition to the ones that belong to the selected features.\nThis should be set to false (default) for install/upgrades.\nto true when copying specific images/packages associated with a specific feature.", "type" : "boolean" } }, "example" : { "remoteRepoUrl" : "...", "dockerRegistry" : "...", "controlPlaneUuid" : "...", "selectedFeatures" : "...", "selectedFeaturesOnly" : true }, "description" : "Arguments used for the command to generate the docker copy script.\nThis is applicable for Openshift deployments, where we cannot perform the image copying ourselves." }, "ApiGenerateExternalVaultSetupArgs" : { "type" : "object", "title" : "ApiGenerateExternalVaultSetupArgs", "properties" : { "remoteRepoUrl" : { "description" : "The url of the remote repository where the private cloud artifacts to install are hosted", "type" : "string" }, "namespace" : { "description" : "The namespace of the CDP Private control plane", "type" : "string" }, "vaultAddr" : { "description" : "Optional. The address the of external vault", "type" : "string" } }, "example" : { "remoteRepoUrl" : "...", "namespace" : "...", "vaultAddr" : "..." }, "description" : "Arguments used for the command to generate the external vault setup template" }, "ApiGenerateHostCertsArguments" : { "type" : "object", "title" : "ApiGenerateHostCertsArguments", "allOf" : [ { "$ref" : "#/definitions/BaseApiSshCmdArguments" }, { "properties" : { "subjectAltName" : { "description" : "", "type" : "array", "items" : { "type" : "string" } } } } ], "example" : { "subjectAltName" : [ "...", "..." ], "sshPort" : 22, "userName" : "...", "password" : "...", "privateKey" : "...", "passphrase" : "..." }, "description" : "Arguments to install certificates on a host" }, "ApiHBaseAddReplicationPeerInput" : { "type" : "object", "title" : "ApiHBaseAddReplicationPeerInput", "required" : [ "enabled" ], "properties" : { "peerId" : { "description" : "", "type" : "string" }, "clusterKey" : { "description" : "", "type" : "string" }, "tableCFs" : { "description" : "", "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } }, "enabled" : { "description" : "", "type" : "boolean" } }, "example" : { "peerId" : "...", "clusterKey" : "...", "tableCFs" : { "property1" : [ "...", "..." ], "property2" : [ "...", "..." ] }, "enabled" : true }, "description" : "" }, "ApiHBaseCreateTable" : { "type" : "object", "title" : "ApiHBaseCreateTable", "properties" : { "tableName" : { "description" : "", "type" : "string" }, "columnFamily" : { "description" : "", "type" : "string" } }, "example" : { "tableName" : "...", "columnFamily" : "..." }, "description" : "" }, "ApiHBasePeerId" : { "type" : "object", "title" : "ApiHBasePeerId", "properties" : { "id" : { "description" : "", "type" : "string" } }, "example" : { "id" : "..." }, "description" : "Encapsulates the ID of an HBase peer." }, "ApiHBasePeerIdWithTableCFs" : { "type" : "object", "title" : "ApiHBasePeerIdWithTableCFs", "properties" : { "peerId" : { "description" : "", "type" : "string" }, "tableCFs" : { "description" : "", "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } } }, "example" : { "peerId" : "...", "tableCFs" : { "property1" : [ "...", "..." ], "property2" : [ "...", "..." ] } }, "description" : "" }, "ApiHBaseReplicationArguments" : { "type" : "object", "title" : "ApiHBaseReplicationArguments", "properties" : { "sourceHBaseService" : { "description" : "", "$ref" : "#/definitions/ApiServiceRef" }, "peerState" : { "description" : "", "$ref" : "#/definitions/HBasePeerState" }, "hbaseClusterKey" : { "description" : "", "type" : "string" }, "endPointClassName" : { "description" : "", "type" : "string" }, "tables" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/HBaseTableArgs" } }, "replicationProperties" : { "description" : "", "type" : "object", "additionalProperties" : { "type" : "string" } }, "sourceAccount" : { "description" : "", "type" : "string" }, "sourceSchedulerPool" : { "description" : "", "type" : "string" }, "numMappers" : { "description" : "", "type" : "integer" }, "snapshotScratchLocation" : { "description" : "", "type" : "string" }, "validateReplicationSetup" : { "description" : "", "type" : "boolean" } }, "example" : { "sourceHBaseService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "peerState" : "ENABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ { "tableName" : "...", "initialSnapshot" : true, "snapshotSucceeded" : true }, { "tableName" : "...", "initialSnapshot" : true, "snapshotSucceeded" : true } ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "description" : "Replication arguments for HBase service" }, "ApiHBaseReplicationInfo" : { "type" : "object", "title" : "ApiHBaseReplicationInfo", "properties" : { "replicationOperations" : { "description" : "", "type" : "array", "items" : { "type" : "string" } } }, "example" : { "replicationOperations" : [ "...", "..." ] }, "description" : "" }, "ApiHBaseReplicationSecurityTool" : { "type" : "object", "title" : "ApiHBaseReplicationSecurityTool", "properties" : { "password" : { "description" : "", "type" : "string" }, "keystoreFilePath" : { "description" : "", "type" : "string" } }, "example" : { "password" : "...", "keystoreFilePath" : "..." }, "description" : "HBase Replication Security Tool Management" }, "ApiHBaseReplicationSetupCleanAndResetArgs" : { "type" : "object", "title" : "ApiHBaseReplicationSetupCleanAndResetArgs", "properties" : { "sourceRef" : { "description" : "", "$ref" : "#/definitions/ApiServiceRef" }, "cmPeerNameOnRemote" : { "description" : "", "type" : "string" }, "sourceRestartType" : { "description" : "", "$ref" : "#/definitions/RestartType" }, "targetRestartType" : { "description" : "", "$ref" : "#/definitions/RestartType" } }, "example" : { "sourceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "cmPeerNameOnRemote" : "...", "sourceRestartType" : "RESTART", "targetRestartType" : "RESTART" }, "description" : "" }, "ApiHBaseReplicationSetupCommandArgs" : { "type" : "object", "title" : "ApiHBaseReplicationSetupCommandArgs", "properties" : { "keystorePassword" : { "description" : "", "type" : "string" }, "replicationUser" : { "description" : "", "type" : "string" }, "sourceRef" : { "description" : "", "$ref" : "#/definitions/ApiServiceRef" }, "cmPeerNameOnRemote" : { "description" : "The peer name of the local CM in the given sourceRef CM", "type" : "string" }, "sourceRestartType" : { "description" : "", "$ref" : "#/definitions/RestartType" }, "targetRestartType" : { "description" : "", "$ref" : "#/definitions/RestartType" } }, "example" : { "keystorePassword" : "...", "replicationUser" : "...", "sourceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "cmPeerNameOnRemote" : "...", "sourceRestartType" : "NO_RESTART", "targetRestartType" : "RESTART" }, "description" : "Command args for HBaseReplicationSetupCommand" }, "ApiHBaseReplicationSetupStatus" : { "type" : "object", "title" : "ApiHBaseReplicationSetupStatus", "properties" : { "status" : { "description" : "", "$ref" : "#/definitions/Status" }, "subStatus" : { "description" : "", "$ref" : "#/definitions/SubStatus" }, "mainCommandId" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "currentCommandId" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "error" : { "description" : "", "type" : "string" } }, "example" : { "status" : "ERROR", "subStatus" : "RESTARTING", "mainCommandId" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "currentCommandId" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "error" : "..." }, "description" : "Contains status info about the HBase replication first time setup" }, "ApiHBaseSetCFsReplicationScope" : { "type" : "object", "title" : "ApiHBaseSetCFsReplicationScope", "required" : [ "scope" ], "properties" : { "scope" : { "description" : "", "type" : "integer" }, "tableCFs" : { "description" : "", "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "type" : "string" } } } }, "example" : { "scope" : 12345, "tableCFs" : { "property1" : [ "...", "..." ], "property2" : [ "...", "..." ] } }, "description" : "" }, "ApiHBaseShellCommand" : { "type" : "object", "title" : "ApiHBaseShellCommand", "properties" : { "payload" : { "description" : "", "type" : "string" } }, "example" : { "payload" : "..." }, "description" : "API request to execute generic hbase shell command\n\nThe payload (command) is passed as it is to hbase shell, so the caller needs to know the\nexact syntax of the supported hbase shell command, based on underlying hbase version" }, "ApiHBaseSnapshot" : { "type" : "object", "title" : "ApiHBaseSnapshot", "properties" : { "snapshotName" : { "description" : "Snapshot name.", "type" : "string" }, "tableName" : { "description" : "Name of the table this snapshot is for.", "type" : "string" }, "creationTime" : { "description" : "Snapshot creation time.", "type" : "string" }, "storage" : { "description" : "Whether the snapshot is local or remote.", "$ref" : "#/definitions/Storage" }, "storageLocation" : { "description" : "The remote location where a snapshot is stored.\n/* Optional - location comes from HBase service config if this is not defined", "type" : "string" } }, "example" : { "snapshotName" : "...", "tableName" : "...", "creationTime" : "...", "storage" : "LOCAL", "storageLocation" : "..." }, "description" : "An HBase snapshot descriptor." }, "ApiHBaseSnapshotError" : { "type" : "object", "title" : "ApiHBaseSnapshotError", "properties" : { "tableName" : { "description" : "Name of the table.", "type" : "string" }, "snapshotName" : { "description" : "Name of the snapshot.", "type" : "string" }, "storage" : { "description" : "Whether the snapshot is local or remote.", "$ref" : "#/definitions/Storage" }, "storageLocation" : { "description" : "The remote location where a snapshot is stored.\n/* Optional - location comes from HBase service config if this is not defined", "type" : "string" }, "error" : { "description" : "Description of the error.", "type" : "string" } }, "example" : { "tableName" : "...", "snapshotName" : "...", "storage" : "REMOTE_S3", "storageLocation" : "...", "error" : "..." }, "description" : "A HBase snapshot operation error." }, "ApiHBaseSnapshotPolicyArguments" : { "type" : "object", "title" : "ApiHBaseSnapshotPolicyArguments", "properties" : { "tableRegExps" : { "description" : "The regular expressions specifying the tables. Tables matching any of them\nwill be eligible for snapshot creation.", "type" : "array", "items" : { "type" : "string" } }, "storage" : { "description" : "The location where the snapshots should be stored.", "$ref" : "#/definitions/Storage" } }, "example" : { "tableRegExps" : [ "...", "..." ], "storage" : "LOCAL" }, "description" : "HBase specific snapshot policy arguments." }, "ApiHBaseSnapshotResult" : { "type" : "object", "title" : "ApiHBaseSnapshotResult", "properties" : { "processedTableCount" : { "description" : "Number of processed tables.", "type" : "integer" }, "processedTables" : { "description" : "The list of processed tables.\n
\nThis is only available in the full view.", "type" : "array", "items" : { "type" : "string" } }, "unprocessedTableCount" : { "description" : "Number of unprocessed tables.", "type" : "integer" }, "unprocessedTables" : { "description" : "The list of unprocessed tables. Note that tables that are currently being\nprocessed will also be included in this list.\n\nThis is only available in the full view.", "type" : "array", "items" : { "type" : "string" } }, "createdSnapshotCount" : { "description" : "Number of snapshots created.", "type" : "integer" }, "createdSnapshots" : { "description" : "List of snapshots created.\n\nThis is only available in the full view.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHBaseSnapshot" } }, "deletedSnapshotCount" : { "description" : "Number of snapshots deleted.", "type" : "integer" }, "deletedSnapshots" : { "description" : "List of snapshots deleted.\n\nThis is only available in the full view.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHBaseSnapshot" } }, "creationErrorCount" : { "description" : "Number of errors detected when creating snapshots.", "type" : "integer" }, "creationErrors" : { "description" : "List of errors encountered when creating snapshots.\n\nThis is only available in the full view.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHBaseSnapshotError" } }, "deletionErrorCount" : { "description" : "Number of errors detected when deleting snapshots.", "type" : "integer" }, "deletionErrors" : { "description" : "List of errors encountered when deleting snapshots.\n\nThis is only available in the full view.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHBaseSnapshotError" } } }, "example" : { "processedTableCount" : 12345, "processedTables" : [ "...", "..." ], "unprocessedTableCount" : 12345, "unprocessedTables" : [ "...", "..." ], "createdSnapshotCount" : 12345, "createdSnapshots" : [ { "snapshotName" : "...", "tableName" : "...", "creationTime" : "...", "storage" : "REMOTE_S3", "storageLocation" : "..." }, { "snapshotName" : "...", "tableName" : "...", "creationTime" : "...", "storage" : "LOCAL", "storageLocation" : "..." } ], "deletedSnapshotCount" : 12345, "deletedSnapshots" : [ { "snapshotName" : "...", "tableName" : "...", "creationTime" : "...", "storage" : "LOCAL", "storageLocation" : "..." }, { "snapshotName" : "...", "tableName" : "...", "creationTime" : "...", "storage" : "REMOTE_S3", "storageLocation" : "..." } ], "creationErrorCount" : 12345, "creationErrors" : [ { "tableName" : "...", "snapshotName" : "...", "storage" : "LOCAL", "storageLocation" : "...", "error" : "..." }, { "tableName" : "...", "snapshotName" : "...", "storage" : "REMOTE_S3", "storageLocation" : "...", "error" : "..." } ], "deletionErrorCount" : 12345, "deletionErrors" : [ { "tableName" : "...", "snapshotName" : "...", "storage" : "REMOTE_S3", "storageLocation" : "...", "error" : "..." }, { "tableName" : "...", "snapshotName" : "...", "storage" : "LOCAL", "storageLocation" : "...", "error" : "..." } ] }, "description" : "Detailed information about an HBase snapshot command." }, "ApiHBaseTable" : { "type" : "object", "title" : "ApiHBaseTable", "required" : [ "deleted" ], "properties" : { "tableName" : { "description" : "Table name.", "type" : "string" }, "deleted" : { "description" : "Indicates whether the table has been deleted.", "type" : "boolean" } }, "example" : { "tableName" : "...", "deleted" : true }, "description" : "An HBase table descriptor." }, "ApiHBaseTableNames" : { "type" : "object", "title" : "ApiHBaseTableNames", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "type" : "string" } } } } ], "example" : { "items" : [ "...", "..." ] }, "description" : "Encapsulates table names from HBase." }, "ApiHBaseUpdateReplicationPeerState" : { "type" : "object", "title" : "ApiHBaseUpdateReplicationPeerState", "required" : [ "enabled" ], "properties" : { "hbasePeerId" : { "description" : "", "type" : "string" }, "enabled" : { "description" : "", "type" : "boolean" } }, "example" : { "hbasePeerId" : "...", "enabled" : true }, "description" : "" }, "ApiHdfsCloudReplicationArguments" : { "type" : "object", "title" : "ApiHdfsCloudReplicationArguments", "allOf" : [ { "$ref" : "#/definitions/ApiHdfsReplicationArguments" }, { "properties" : { "sourceAccount" : { "description" : "", "type" : "string" }, "destinationAccount" : { "description" : "", "type" : "string" } } } ], "example" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "description" : "Replication arguments for HDFS." }, "ApiHdfsDisableHaArguments" : { "type" : "object", "title" : "ApiHdfsDisableHaArguments", "properties" : { "activeName" : { "description" : "Name of the the NameNode to be kept.", "type" : "string" }, "secondaryName" : { "description" : "Name of the SecondaryNamenode to associate with the active NameNode.", "type" : "string" }, "startDependentServices" : { "description" : "Whether to re-start dependent services. Defaults to true.", "type" : "boolean" }, "deployClientConfigs" : { "description" : "Whether to re-deploy client configurations. Defaults to true.", "type" : "boolean" }, "disableQuorumStorage" : { "description" : "Whether to disable Quorum-based Storage. Defaults to false.\n\nAvailable since API v2.", "type" : "boolean" } }, "example" : { "activeName" : "...", "secondaryName" : "...", "startDependentServices" : true, "deployClientConfigs" : true, "disableQuorumStorage" : true }, "description" : "Arguments used for the HDFS disable HA command." }, "ApiHdfsFailoverArguments" : { "type" : "object", "title" : "ApiHdfsFailoverArguments", "properties" : { "nameservice" : { "description" : "Nameservice for which to enable automatic failover.", "type" : "string" }, "zooKeeperService" : { "description" : "The ZooKeeper service to use.", "$ref" : "#/definitions/ApiServiceRef" }, "activeFCName" : { "description" : "Name of the failover controller to create for the active NameNode.", "type" : "string" }, "standByFCName" : { "description" : "Name of the failover controller to create for the stand-by NameNode.", "type" : "string" } }, "example" : { "nameservice" : "...", "zooKeeperService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "activeFCName" : "...", "standByFCName" : "..." }, "description" : "Arguments used when enabling HDFS automatic failover." }, "ApiHdfsFile" : { "type" : "object", "title" : "ApiHdfsFile", "required" : [ "length", "dir", "replication", "blockSize", "permission" ], "properties" : { "absolutePath" : { "description" : "Fully qualified path of file.", "type" : "string" }, "length" : { "description" : "Size of file.", "type" : "integer" }, "dir" : { "description" : "Indicates whether the file is a directory.", "type" : "boolean" }, "replication" : { "description" : "Configured block replication factor of file.", "type" : "number" }, "blockSize" : { "description" : "Configured block size of file in bytes.", "type" : "integer" }, "modificationTime" : { "description" : "Last modification time of file in milliseconds since January 1, 1970 UTC.", "type" : "string" }, "accessTime" : { "description" : "Last access time of file in milliseconds since January 1, 1970 UTC.", "type" : "string" }, "permission" : { "description" : "Permission of the file where the digits in order represent:\nSticky bit, User action, Group action, Other action.", "type" : "number" }, "owner" : { "description" : "Owner of the file.", "type" : "string" }, "group" : { "description" : "Group of the file.", "type" : "string" } }, "example" : { "absolutePath" : "...", "length" : 12345, "dir" : true, "replication" : 12345, "blockSize" : 12345, "modificationTime" : "...", "accessTime" : "...", "permission" : 12345, "owner" : "...", "group" : "..." }, "description" : "An HDFS file descriptor." }, "ApiHdfsHaArguments" : { "type" : "object", "title" : "ApiHdfsHaArguments", "properties" : { "activeName" : { "description" : "Name of the active NameNode.", "type" : "string" }, "activeSharedEditsPath" : { "description" : "Path to the shared edits directory on the active NameNode's host.\nIgnored if Quorum-based Storage is being enabled.", "type" : "string" }, "standByName" : { "description" : "Name of the stand-by Namenode.", "type" : "string" }, "standBySharedEditsPath" : { "description" : "Path to the shared edits directory on the stand-by NameNode's host.\nIgnored if Quorum-based Storage is being enabled.", "type" : "string" }, "nameservice" : { "description" : "Nameservice that identifies the HA pair.", "type" : "string" }, "startDependentServices" : { "description" : "Whether to re-start dependent services. Defaults to true.", "type" : "boolean" }, "deployClientConfigs" : { "description" : "Whether to re-deploy client configurations. Defaults to true.", "type" : "boolean" }, "enableQuorumStorage" : { "description" : "This parameter has been deprecated as of CM 5.0, where HA\nis only supported using Quorum-based Storage.\n\nWhether to enable Quorum-based Storage.\n\nEnabling Quorum-based Storage requires a minimum of three and\nan odd number of JournalNodes to be created and configured\nbefore enabling HDFS HA.\n
\nAvailable since API v2.", "type" : "boolean" } }, "example" : { "activeName" : "...", "activeSharedEditsPath" : "...", "standByName" : "...", "standBySharedEditsPath" : "...", "nameservice" : "...", "startDependentServices" : true, "deployClientConfigs" : true }, "description" : "Arguments used for HDFS HA commands." }, "ApiHdfsReplicationArguments" : { "type" : "object", "title" : "ApiHdfsReplicationArguments", "properties" : { "sourceService" : { "description" : "The service to replicate from.", "$ref" : "#/definitions/ApiServiceRef" }, "sourcePath" : { "description" : "The path to replicate.", "type" : "string" }, "destinationPath" : { "description" : "The destination to replicate to.", "type" : "string" }, "mapreduceServiceName" : { "description" : "The mapreduce service to use for the replication job.", "type" : "string" }, "schedulerPoolName" : { "description" : "Name of the scheduler pool to use when submitting the MapReduce job.\nCurrently supports the capacity and fair schedulers. The option is\nignored if a different scheduler is configured.", "type" : "string" }, "userName" : { "description" : "The user which will execute the MapReduce job. Required if running with\nKerberos enabled.", "type" : "string" }, "sourceUser" : { "description" : "The user which will perform operations on source cluster. Required if\nrunning with Kerberos enabled.", "type" : "string" }, "numMaps" : { "description" : "The number of mappers to use for the mapreduce replication job.", "type" : "integer" }, "dryRun" : { "description" : "Whether to perform a dry run. Defaults to false.", "type" : "boolean" }, "bandwidthPerMap" : { "description" : "The maximum bandwidth (in MB) per mapper in the mapreduce replication\njob.", "type" : "integer" }, "abortOnError" : { "description" : "Whether to abort on a replication failure. Defaults to false.", "type" : "boolean" }, "removeMissingFiles" : { "description" : "Whether to delete destination files that are missing in source. Defaults\nto false.", "type" : "boolean" }, "preserveReplicationCount" : { "description" : "Whether to preserve the HDFS replication count. Defaults to false.", "type" : "boolean" }, "preserveBlockSize" : { "description" : "Whether to preserve the HDFS block size. Defaults to false.", "type" : "boolean" }, "preservePermissions" : { "description" : "Whether to preserve the HDFS owner, group and permissions. Defaults to\nfalse.\nStarting from V10, it also preserves ACLs. Defaults to null (no preserve).\nACLs is preserved if both clusters enable ACL support, and replication\nignores any ACL related failures.", "type" : "boolean" }, "logPath" : { "description" : "The HDFS path where the replication log files should be written to.", "type" : "string" }, "skipChecksumChecks" : { "description" : "Whether to skip checksum based file validation during\nreplication. Defaults to false.", "type" : "boolean" }, "skipListingChecksumChecks" : { "description" : "Whether to skip checksum based file comparison during\nreplication. Defaults to false.", "type" : "boolean" }, "skipTrash" : { "description" : "Whether to permanently delete destination files that are missing in source.\nDefaults to null.", "type" : "boolean" }, "replicationStrategy" : { "description" : "The strategy for distributing the file replication tasks among the mappers\nof the MR job associated with a replication. Default is\nReplicationStrategy#STATIC.", "$ref" : "#/definitions/ReplicationStrategy" }, "preserveXAttrs" : { "description" : "Whether to preserve XAttrs, default to false\nThis is introduced in V10. To preserve XAttrs, both CDH versions\nshould be >= 5.2. Replication fails if either cluster does not support\nXAttrs.", "type" : "boolean" }, "exclusionFilters" : { "description" : "Specify regular expression strings to match full paths of files and directories\nmatching source paths and exclude them from the replication. Optional.\nAvailable since V11.", "type" : "array", "items" : { "type" : "string" } }, "raiseSnapshotDiffFailures" : { "description" : "Flag indicating if failures during snapshotDiff should be ignored or not.\nWhen it is set to false then,\nreplication will fallback to full copy listing in case of any error in\nsnapshot diff handling and\nit will ignore snapshot delete/rename failures at the end of a replication.\nThe flag is by default set to false in distcp tool which means it will ignore\nsnapshot diff failures and mark replication as success for snapshot\ndelete/rename failures.\nIn UI, the flag is set to true by default when source CM Version is greater than 5.14.", "type" : "boolean" }, "deleteLatestSourceSnapshotOnJobFailure" : { "description" : "A flag configuring distcp behaviour for the case when the distcp mapreduce job fails. This failure is sometimes\ndue to some issues with the snapshot. By default, in case of mapreduce job failure the latest source side snapshot\nis deleted. Set this flag to false to make this replication not delete the last successfully replicated old\nsnapshot of the source dataset in case of job failure. The default value of this flag is true. Not setting this\nflag is equivalent to the value true.", "type" : "boolean" }, "destinationCloudAccount" : { "description" : "The cloud account name which is used in direct hive cloud replication, if specified.", "type" : "string" } }, "example" : { "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "description" : "Replication arguments for HDFS." }, "ApiHdfsReplicationCounter" : { "type" : "object", "title" : "ApiHdfsReplicationCounter", "properties" : { "group" : { "description" : "", "type" : "string" }, "name" : { "description" : "", "type" : "string" }, "value" : { "description" : "", "type" : "integer" } }, "example" : { "group" : "...", "name" : "...", "value" : 12345 }, "description" : "A counter in an HDFS replication job." }, "ApiHdfsReplicationResult" : { "type" : "object", "title" : "ApiHdfsReplicationResult", "properties" : { "progress" : { "description" : "The file copy progress percentage.", "type" : "integer" }, "throughput" : { "description" : "The data throughput in KB/s.", "type" : "number" }, "remainingTime" : { "description" : "The time remaining for mapper phase (seconds).", "type" : "integer" }, "estimatedCompletionTime" : { "description" : "The estimated completion time for the mapper phase.", "type" : "string" }, "counters" : { "description" : "The counters collected from the replication job.\n
\nStarting with API v4, the full list of counters is only available in the\nfull view.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHdfsReplicationCounter" } }, "numFilesDryRun" : { "description" : "The number of files found to copy.", "type" : "integer" }, "numBytesDryRun" : { "description" : "The number of bytes found to copy.", "type" : "integer" }, "numFilesExpected" : { "description" : "The number of files expected to be copied.", "type" : "integer" }, "numBytesExpected" : { "description" : "The number of bytes expected to be copied.", "type" : "integer" }, "numFilesCopied" : { "description" : "The number of files actually copied.", "type" : "integer" }, "numBytesCopied" : { "description" : "The number of bytes actually copied.", "type" : "integer" }, "numFilesSkipped" : { "description" : "The number of files that were unchanged and thus skipped during\ncopying.", "type" : "integer" }, "numBytesSkipped" : { "description" : "The aggregate number of bytes in the skipped files.", "type" : "integer" }, "numFilesDeleted" : { "description" : "The number of files deleted since they were present at destination, but\nmissing from source.", "type" : "integer" }, "numFilesCopyFailed" : { "description" : "The number of files for which copy failed.", "type" : "integer" }, "numBytesCopyFailed" : { "description" : "The aggregate number of bytes in the files for which copy failed.", "type" : "integer" }, "setupError" : { "description" : "The error that happened during job setup, if any.", "type" : "string" }, "jobId" : { "description" : "Read-only. The MapReduce job ID for the replication job.\nAvailable since API v4.\n\nThis can be used to query information about the replication job from the\nMapReduce server where it was executed. Refer to the \"/activities\"\nresource for services for further details.", "type" : "string" }, "jobDetailsUri" : { "description" : "Read-only. The URI (relative to the CM server's root) where to find the\nActivity Monitor page for the job. Available since API v4.", "type" : "string" }, "dryRun" : { "description" : "Whether this was a dry run.", "type" : "boolean" }, "snapshottedDirs" : { "description" : "The list of directories for which snapshots were taken and used as part of\nthis replication.", "type" : "array", "items" : { "type" : "string" } }, "runAsUser" : { "description" : "Returns run-as user name.\nAvailable since API v11.", "type" : "string" }, "runOnSourceAsUser" : { "description" : "Returns run-as user name for source cluster.\nAvailable since API v18.", "type" : "string" }, "logPath" : { "description" : "Returns HDFS path of DistCp execution log files.\nAvailable since API v33.", "type" : "string" }, "failedFiles" : { "description" : "The list of files that failed during replication.\nAvailable since API v11.", "type" : "array", "items" : { "type" : "string" } } }, "example" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ { "group" : "...", "name" : "...", "value" : 12345 }, { "group" : "...", "name" : "...", "value" : 12345 } ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "description" : "Detailed information about an HDFS replication job." }, "ApiHdfsRestoreSnapshotArgs" : { "type" : "object", "title" : "ApiHdfsRestoreSnapshotArgs", "properties" : { "snapshot" : { "description" : "", "$ref" : "#/definitions/ApiHdfsSnapshot" }, "destinationPath" : { "description" : "", "type" : "string" }, "distCpArgs" : { "description" : "", "$ref" : "#/definitions/ApiHdfsReplicationArguments" } }, "example" : { "snapshot" : { "path" : "...", "snapshotName" : "...", "snapshotPath" : "...", "creationTime" : "..." }, "destinationPath" : "...", "distCpArgs" : { "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." } }, "description" : "HDFS restore snapshot arguments descriptor" }, "ApiHdfsSnapshot" : { "type" : "object", "title" : "ApiHdfsSnapshot", "properties" : { "path" : { "description" : "Snapshotted path.", "type" : "string" }, "snapshotName" : { "description" : "Snapshot name.", "type" : "string" }, "snapshotPath" : { "description" : "Read-only. Fully qualified path for the snapshot version of \"path\".\n\nFor example, if a snapshot \"s1\" is present at \"/a/.snapshot/s1, then the\nsnapshot path corresponding to \"s1\" for path \"/a/b\" will be\n\"/a/.snapshot/s1/b\".", "type" : "string" }, "creationTime" : { "description" : "Snapshot creation time.", "type" : "string" } }, "example" : { "path" : "...", "snapshotName" : "...", "snapshotPath" : "...", "creationTime" : "..." }, "description" : "An HDFS snapshot descriptor." }, "ApiHdfsSnapshotError" : { "type" : "object", "title" : "ApiHdfsSnapshotError", "properties" : { "path" : { "description" : "Path for which the snapshot error occurred.", "type" : "string" }, "snapshotName" : { "description" : "Name of snapshot for which error occurred.", "type" : "string" }, "error" : { "description" : "Description of the error.", "type" : "string" } }, "example" : { "path" : "...", "snapshotName" : "...", "error" : "..." }, "description" : "An HDFS snapshot operation error." }, "ApiHdfsSnapshotPolicyArguments" : { "type" : "object", "title" : "ApiHdfsSnapshotPolicyArguments", "properties" : { "pathPatterns" : { "description" : "The path patterns specifying the paths. Paths matching any of them will be\neligible for snapshot creation.\n\nThe pattern matching characters that can be specific are those supported\nby HDFS. please see the documentation for HDFS globs for more details.", "type" : "array", "items" : { "type" : "string" } } }, "example" : { "pathPatterns" : [ "...", "..." ] }, "description" : "HDFS specific snapshot policy arguments." }, "ApiHdfsSnapshotResult" : { "type" : "object", "title" : "ApiHdfsSnapshotResult", "properties" : { "processedPathCount" : { "description" : "Number of processed paths.", "type" : "integer" }, "processedPaths" : { "description" : "The list of processed paths.\n\nThis is only available in the full view.", "type" : "array", "items" : { "type" : "string" } }, "unprocessedPathCount" : { "description" : "Number of unprocessed paths.", "type" : "integer" }, "unprocessedPaths" : { "description" : "The list of unprocessed paths. Note that paths that are currently being\nprocessed will also be included in this list.\n\nThis is only available in the full view.", "type" : "array", "items" : { "type" : "string" } }, "createdSnapshotCount" : { "description" : "Number of snapshots created.", "type" : "integer" }, "createdSnapshots" : { "description" : "List of snapshots created.\n\nThis is only available in the full view.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHdfsSnapshot" } }, "deletedSnapshotCount" : { "description" : "Number of snapshots deleted.", "type" : "integer" }, "deletedSnapshots" : { "description" : "List of snapshots deleted.\n\nThis is only available in the full view.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHdfsSnapshot" } }, "creationErrorCount" : { "description" : "Number of errors detected when creating snapshots.", "type" : "integer" }, "creationErrors" : { "description" : "List of errors encountered when creating snapshots.\n\nThis is only available in the full view.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHdfsSnapshotError" } }, "deletionErrorCount" : { "description" : "Number of errors detected when deleting snapshots.", "type" : "integer" }, "deletionErrors" : { "description" : "List of errors encountered when deleting snapshots.\n\nThis is only available in the full view.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHdfsSnapshotError" } } }, "example" : { "processedPathCount" : 12345, "processedPaths" : [ "...", "..." ], "unprocessedPathCount" : 12345, "unprocessedPaths" : [ "...", "..." ], "createdSnapshotCount" : 12345, "createdSnapshots" : [ { "path" : "...", "snapshotName" : "...", "snapshotPath" : "...", "creationTime" : "..." }, { "path" : "...", "snapshotName" : "...", "snapshotPath" : "...", "creationTime" : "..." } ], "deletedSnapshotCount" : 12345, "deletedSnapshots" : [ { "path" : "...", "snapshotName" : "...", "snapshotPath" : "...", "creationTime" : "..." }, { "path" : "...", "snapshotName" : "...", "snapshotPath" : "...", "creationTime" : "..." } ], "creationErrorCount" : 12345, "creationErrors" : [ { "path" : "...", "snapshotName" : "...", "error" : "..." }, { "path" : "...", "snapshotName" : "...", "error" : "..." } ], "deletionErrorCount" : 12345, "deletionErrors" : [ { "path" : "...", "snapshotName" : "...", "error" : "..." }, { "path" : "...", "snapshotName" : "...", "error" : "..." } ] }, "description" : "Detailed information about an HDFS snapshot command." }, "ApiHdfsSnapshottableDirectoryStatus" : { "type" : "object", "title" : "ApiHdfsSnapshottableDirectoryStatus", "required" : [ "snapshotNumber", "snapshotQuota" ], "properties" : { "snapshotNumber" : { "description" : "Count of snapshots that have been taken for the directory", "type" : "integer" }, "snapshotQuota" : { "description" : "Number of snapshots allowed for the directory", "type" : "integer" }, "parentFullPath" : { "description" : "Absolute path of the parent", "type" : "string" }, "dirStatus" : { "description" : "The basic information of the directory", "$ref" : "#/definitions/ApiHdfsFile" }, "absolutePath" : { "description" : "Absolute path of the file", "type" : "string" } }, "example" : { "snapshotNumber" : 12345, "snapshotQuota" : 12345, "parentFullPath" : "...", "dirStatus" : { "absolutePath" : "...", "length" : 12345, "dir" : true, "replication" : 12345, "blockSize" : 12345, "modificationTime" : "...", "accessTime" : "...", "permission" : 12345, "owner" : "...", "group" : "..." }, "absolutePath" : "..." }, "description" : "An HDFS Snapshottable Directory descriptor." }, "ApiHdfsUpgradeDomainList" : { "type" : "object", "title" : "ApiHdfsUpgradeDomainList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiMapEntryOfHostNameList" } } } } ], "example" : { "items" : [ { "key" : "...", "value" : { "items" : [ "...", "..." ] } }, { "key" : "...", "value" : { "items" : [ "...", "..." ] } } ] }, "description" : "A map from HDFS upgrade domains to host names, implemented as a list of\nApiMapEntryOfHostNameList objects, where the keys are upgrade domain strings and the values are\nApiHostNameList objects." }, "ApiHdfsUsageReport" : { "type" : "object", "title" : "ApiHdfsUsageReport", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "lastUpdateTime" : { "description" : "The time when HDFS usage info was last collected. No information\nbeyond this time can be provided.", "type" : "string" }, "items" : { "description" : "A list of per-user usage information at the requested\ntime granularity.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHdfsUsageReportRow" } } } } ], "example" : { "lastUpdateTime" : "...", "items" : [ { "date" : "...", "user" : "...", "size" : 12345, "rawSize" : 12345, "numFiles" : 12345 }, { "date" : "...", "user" : "...", "size" : 12345, "rawSize" : 12345, "numFiles" : 12345 } ] }, "description" : "A generic list." }, "ApiHdfsUsageReportRow" : { "type" : "object", "title" : "ApiHdfsUsageReportRow", "properties" : { "date" : { "description" : "The date of the report row data.", "type" : "string" }, "user" : { "description" : "The user being reported.", "type" : "string" }, "size" : { "description" : "Total size (in bytes) of the files owned by this user. This does not\ninclude replication in HDFS.", "type" : "integer" }, "rawSize" : { "description" : "Total size (in bytes) of all the replicas of all the files owned by\nthis user.", "type" : "integer" }, "numFiles" : { "description" : "Number of files owned by this user.", "type" : "integer" } }, "example" : { "date" : "...", "user" : "...", "size" : 12345, "rawSize" : 12345, "numFiles" : 12345 }, "description" : "" }, "ApiHealthCheck" : { "type" : "object", "title" : "ApiHealthCheck", "properties" : { "name" : { "description" : "Unique name of this health check.", "type" : "string" }, "summary" : { "description" : "The summary status of this check.", "$ref" : "#/definitions/ApiHealthSummary" }, "explanation" : { "description" : "The explanation of this health check.\nAvailable since v11.", "type" : "string" }, "suppressed" : { "description" : "Whether this health test is suppressed. A suppressed health test is not\nconsidered when computing an entity's overall health.\nAvailable since v11.", "type" : "boolean" } }, "example" : { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, "description" : "Represents a result from a health test performed by Cloudera Manager for an\nentity." }, "ApiHealthSummary" : { "type" : "string", "title" : "ApiHealthSummary", "enum" : [ "DISABLED", "HISTORY_NOT_AVAILABLE", "NOT_AVAILABLE", "GOOD", "CONCERNING", "BAD" ], "description" : "Represents of the high-level health status of a subject in the cluster." }, "ApiHive3CloudArguments" : { "type" : "object", "title" : "ApiHive3CloudArguments", "properties" : { "sourceAccount" : { "description" : "", "type" : "string" } }, "example" : { "sourceAccount" : "..." }, "description" : "API arguments for Hive3 cloud replication" }, "ApiHive3ReplicationArguments" : { "type" : "object", "title" : "ApiHive3ReplicationArguments", "properties" : { "sourceHiveService" : { "description" : "", "$ref" : "#/definitions/ApiServiceRef" }, "status" : { "description" : "", "$ref" : "#/definitions/PolicyStatus" }, "rangerReplication" : { "description" : "", "type" : "boolean" }, "atlasReplication" : { "description" : "", "type" : "boolean" }, "externalTableReplication" : { "description" : "", "type" : "boolean" }, "externalTableBaseDir" : { "description" : "", "type" : "string" }, "distcpOnTarget" : { "description" : "", "type" : "boolean" }, "numMaps" : { "description" : "", "type" : "integer" }, "bandwidthPerMap" : { "description" : "", "type" : "integer" }, "policyOptions" : { "description" : "", "type" : "object", "additionalProperties" : { "type" : "string" } }, "sourceDbName" : { "description" : "", "type" : "string" }, "targetDbName" : { "description" : "", "type" : "string" }, "policyName" : { "description" : "", "type" : "string" }, "scheduleClause" : { "description" : "", "type" : "string" }, "runAs" : { "description" : "", "type" : "string" }, "hiveOp" : { "description" : "", "type" : "string" }, "hiveUpdateOp" : { "description" : "", "type" : "string" }, "excludeSource" : { "description" : "", "type" : "boolean" }, "excludeTarget" : { "description" : "", "type" : "boolean" }, "failoverStatus" : { "description" : "", "type" : "string" }, "cloudArgs" : { "description" : "", "$ref" : "#/definitions/ApiHive3CloudArguments" } }, "example" : { "sourceHiveService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "status" : "FAILED_ADMIN", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : { "sourceAccount" : "..." } }, "description" : "Replication Arguments for Hive3 schedules / policies" }, "ApiHive3ReplicationMetric" : { "type" : "object", "title" : "ApiHive3ReplicationMetric", "properties" : { "name" : { "description" : "", "type" : "string" }, "currentCount" : { "description" : "", "type" : "integer" }, "totalCount" : { "description" : "", "type" : "integer" } }, "example" : { "name" : "...", "currentCount" : 12345, "totalCount" : 12345 }, "description" : "" }, "ApiHive3ReplicationMetricsMetadata" : { "type" : "object", "title" : "ApiHive3ReplicationMetricsMetadata", "properties" : { "dbName" : { "description" : "", "type" : "string" }, "replicationType" : { "description" : "", "$ref" : "#/definitions/ReplicationType" }, "stagingDir" : { "description" : "", "type" : "string" }, "lastReplId" : { "description" : "", "type" : "integer" } }, "example" : { "dbName" : "...", "replicationType" : "INCREMENTAL", "stagingDir" : "...", "lastReplId" : 12345 }, "description" : "" }, "ApiHive3ReplicationMetricsProgress" : { "type" : "object", "title" : "ApiHive3ReplicationMetricsProgress", "properties" : { "status" : { "description" : "", "$ref" : "#/definitions/ApiHive3ReplicationMetricsStatus" }, "stages" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHive3ReplicationMetricsStage" } } }, "example" : { "status" : "FAILED_ADMIN", "stages" : [ { "name" : "...", "status" : "SUCCESS", "startDate" : "...", "endDate" : "...", "metrics" : [ { "name" : "...", "currentCount" : 12345, "totalCount" : 12345 }, { "name" : "...", "currentCount" : 12345, "totalCount" : 12345 } ], "errorLogPath" : "..." }, { "name" : "...", "status" : "FAILED_ADMIN", "startDate" : "...", "endDate" : "...", "metrics" : [ { "name" : "...", "currentCount" : 12345, "totalCount" : 12345 }, { "name" : "...", "currentCount" : 12345, "totalCount" : 12345 } ], "errorLogPath" : "..." } ] }, "description" : "" }, "ApiHive3ReplicationMetricsResultRow" : { "type" : "object", "title" : "ApiHive3ReplicationMetricsResultRow", "properties" : { "scheduledExecutionId" : { "description" : "", "type" : "integer" }, "policy" : { "description" : "", "type" : "string" }, "dumpExecutionId" : { "description" : "", "type" : "integer" }, "metadata" : { "description" : "", "$ref" : "#/definitions/ApiHive3ReplicationMetricsMetadata" }, "progress" : { "description" : "", "$ref" : "#/definitions/ApiHive3ReplicationMetricsProgress" }, "startDate" : { "description" : "", "type" : "string" }, "endDate" : { "description" : "", "type" : "string" }, "errorMessage" : { "description" : "", "type" : "string" } }, "example" : { "scheduledExecutionId" : 12345, "policy" : "...", "dumpExecutionId" : 12345, "metadata" : { "dbName" : "...", "replicationType" : "BOOTSTRAP", "stagingDir" : "...", "lastReplId" : 12345 }, "progress" : { "status" : "IN_PROGRESS", "stages" : [ { "name" : "...", "status" : "FAILED_ADMIN", "startDate" : "...", "endDate" : "...", "metrics" : [ {}, {} ], "errorLogPath" : "..." }, { "name" : "...", "status" : "FAILED", "startDate" : "...", "endDate" : "...", "metrics" : [ {}, {} ], "errorLogPath" : "..." } ] }, "startDate" : "...", "endDate" : "...", "errorMessage" : "..." }, "description" : "" }, "ApiHive3ReplicationMetricsStage" : { "type" : "object", "title" : "ApiHive3ReplicationMetricsStage", "properties" : { "name" : { "description" : "", "type" : "string" }, "status" : { "description" : "", "$ref" : "#/definitions/ApiHive3ReplicationMetricsStatus" }, "startDate" : { "description" : "", "type" : "string" }, "endDate" : { "description" : "", "type" : "string" }, "metrics" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHive3ReplicationMetric" } }, "errorLogPath" : { "description" : "", "type" : "string" } }, "example" : { "name" : "...", "status" : "IN_PROGRESS", "startDate" : "...", "endDate" : "...", "metrics" : [ { "name" : "...", "currentCount" : 12345, "totalCount" : 12345 }, { "name" : "...", "currentCount" : 12345, "totalCount" : 12345 } ], "errorLogPath" : "..." }, "description" : "" }, "ApiHive3ReplicationMetricsStatus" : { "type" : "string", "title" : "ApiHive3ReplicationMetricsStatus", "enum" : [ "SUCCESS", "FAILED", "IN_PROGRESS", "FAILED_ADMIN", "FAILOVER_IN_PROGRESS", "SKIPPED", "FAILOVER_READY" ], "description" : "" }, "ApiHive3ReplicationQueryResult" : { "type" : "object", "title" : "ApiHive3ReplicationQueryResult", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHive3ReplicationQueryResultRow" } } } } ], "example" : { "items" : [ { "scheduledQueriesResultRow" : { "queryId" : 12345, "name" : "...", "enabled" : true, "nameSpace" : "...", "schedule" : "...", "user" : "...", "query" : "...", "nextExecution" : "...", "executionId" : 12345 }, "scheduledExecutionsResultRow" : { "executionId" : 12345, "name" : "...", "queryId" : "...", "state" : "...", "startTime" : "...", "endTime" : "...", "elapsed" : 12345, "errorMessage" : "...", "lastUpdateTime" : "..." }, "replicationMetricsResultRow" : { "scheduledExecutionId" : 12345, "policy" : "...", "dumpExecutionId" : 12345, "metadata" : {}, "progress" : {}, "startDate" : "...", "endDate" : "...", "errorMessage" : "..." } }, { "scheduledQueriesResultRow" : { "queryId" : 12345, "name" : "...", "enabled" : true, "nameSpace" : "...", "schedule" : "...", "user" : "...", "query" : "...", "nextExecution" : "...", "executionId" : 12345 }, "scheduledExecutionsResultRow" : { "executionId" : 12345, "name" : "...", "queryId" : "...", "state" : "...", "startTime" : "...", "endTime" : "...", "elapsed" : 12345, "errorMessage" : "...", "lastUpdateTime" : "..." }, "replicationMetricsResultRow" : { "scheduledExecutionId" : 12345, "policy" : "...", "dumpExecutionId" : 12345, "metadata" : {}, "progress" : {}, "startDate" : "...", "endDate" : "...", "errorMessage" : "..." } } ] }, "description" : "A generic list." }, "ApiHive3ReplicationQueryResultRow" : { "type" : "object", "title" : "ApiHive3ReplicationQueryResultRow", "properties" : { "scheduledQueriesResultRow" : { "description" : "", "$ref" : "#/definitions/ApiHive3ReplicationScheduledQueriesResultRow" }, "scheduledExecutionsResultRow" : { "description" : "", "$ref" : "#/definitions/ApiHive3ReplicationScheduledExecutionsResultRow" }, "replicationMetricsResultRow" : { "description" : "", "$ref" : "#/definitions/ApiHive3ReplicationMetricsResultRow" } }, "example" : { "scheduledQueriesResultRow" : { "queryId" : 12345, "name" : "...", "enabled" : true, "nameSpace" : "...", "schedule" : "...", "user" : "...", "query" : "...", "nextExecution" : "...", "executionId" : 12345 }, "scheduledExecutionsResultRow" : { "executionId" : 12345, "name" : "...", "queryId" : "...", "state" : "...", "startTime" : "...", "endTime" : "...", "elapsed" : 12345, "errorMessage" : "...", "lastUpdateTime" : "..." }, "replicationMetricsResultRow" : { "scheduledExecutionId" : 12345, "policy" : "...", "dumpExecutionId" : 12345, "metadata" : { "dbName" : "...", "replicationType" : "INCREMENTAL", "stagingDir" : "...", "lastReplId" : 12345 }, "progress" : { "status" : "SKIPPED", "stages" : [ {}, {} ] }, "startDate" : "...", "endDate" : "...", "errorMessage" : "..." } }, "description" : "" }, "ApiHive3ReplicationScheduledExecutionsResultRow" : { "type" : "object", "title" : "ApiHive3ReplicationScheduledExecutionsResultRow", "properties" : { "executionId" : { "description" : "", "type" : "integer" }, "name" : { "description" : "", "type" : "string" }, "queryId" : { "description" : "", "type" : "string" }, "state" : { "description" : "", "type" : "string" }, "startTime" : { "description" : "", "type" : "string" }, "endTime" : { "description" : "", "type" : "string" }, "elapsed" : { "description" : "", "type" : "integer" }, "errorMessage" : { "description" : "", "type" : "string" }, "lastUpdateTime" : { "description" : "", "type" : "string" } }, "example" : { "executionId" : 12345, "name" : "...", "queryId" : "...", "state" : "...", "startTime" : "...", "endTime" : "...", "elapsed" : 12345, "errorMessage" : "...", "lastUpdateTime" : "..." }, "description" : "" }, "ApiHive3ReplicationScheduledQueriesResultRow" : { "type" : "object", "title" : "ApiHive3ReplicationScheduledQueriesResultRow", "properties" : { "queryId" : { "description" : "", "type" : "integer" }, "name" : { "description" : "", "type" : "string" }, "enabled" : { "description" : "", "type" : "boolean" }, "nameSpace" : { "description" : "", "type" : "string" }, "schedule" : { "description" : "", "type" : "string" }, "user" : { "description" : "", "type" : "string" }, "query" : { "description" : "", "type" : "string" }, "nextExecution" : { "description" : "", "type" : "string" }, "executionId" : { "description" : "", "type" : "integer" } }, "example" : { "queryId" : 12345, "name" : "...", "enabled" : true, "nameSpace" : "...", "schedule" : "...", "user" : "...", "query" : "...", "nextExecution" : "...", "executionId" : 12345 }, "description" : "" }, "ApiHiveCloudReplicationArguments" : { "type" : "object", "title" : "ApiHiveCloudReplicationArguments", "allOf" : [ { "$ref" : "#/definitions/ApiHiveReplicationArguments" }, { "properties" : { "sourceAccount" : { "description" : "", "type" : "string" }, "destinationAccount" : { "description" : "", "type" : "string" }, "cloudRootPath" : { "description" : "", "type" : "string" }, "replicationOption" : { "description" : "", "$ref" : "#/definitions/ReplicationOption" } } } ], "example" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "KEEP_DATA_IN_CLOUD", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "tableFilters" : [ { "database" : "...", "tableName" : "..." }, { "database" : "...", "tableName" : "..." } ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : { "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "description" : "Replication arguments for Hive services." }, "ApiHiveOnTezReplicationResult" : { "type" : "object", "title" : "ApiHiveOnTezReplicationResult", "required" : [ "tablesCurrent", "tablesTotal", "functionsCurrent", "functionsTotal", "eventsCurrent", "eventsTotal", "policiesCurrent", "policiesTotal", "entitiesCurrent", "entitiesTotal" ], "properties" : { "type" : { "description" : "Type of replication.\n\nBOOTSTRAP or INCREMENTAL", "type" : "string" }, "status" : { "description" : "", "type" : "string" }, "error" : { "description" : "", "type" : "string" }, "tablesCurrent" : { "description" : "", "type" : "integer" }, "tablesTotal" : { "description" : "", "type" : "integer" }, "functionsCurrent" : { "description" : "", "type" : "integer" }, "functionsTotal" : { "description" : "", "type" : "integer" }, "eventsCurrent" : { "description" : "", "type" : "integer" }, "eventsTotal" : { "description" : "", "type" : "integer" }, "policiesCurrent" : { "description" : "", "type" : "integer" }, "policiesTotal" : { "description" : "", "type" : "integer" }, "entitiesCurrent" : { "description" : "", "type" : "integer" }, "entitiesTotal" : { "description" : "", "type" : "integer" }, "origin" : { "description" : "", "$ref" : "#/definitions/Origin" } }, "example" : { "type" : "...", "status" : "...", "error" : "...", "tablesCurrent" : 12345, "tablesTotal" : 12345, "functionsCurrent" : 12345, "functionsTotal" : 12345, "eventsCurrent" : 12345, "eventsTotal" : 12345, "policiesCurrent" : 12345, "policiesTotal" : 12345, "entitiesCurrent" : 12345, "entitiesTotal" : 12345, "origin" : "TARGET" }, "description" : "Detailed information about a Hive replication job." }, "ApiHiveReplicationArguments" : { "type" : "object", "title" : "ApiHiveReplicationArguments", "required" : [ "sentryMigration", "skipUrlPermissions" ], "properties" : { "sourceService" : { "description" : "The service to replicate from.", "$ref" : "#/definitions/ApiServiceRef" }, "tableFilters" : { "description" : "Filters for tables to include in the replication. Optional. If not\nprovided, include all tables in all databases.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHiveTable" } }, "exportDir" : { "description" : "Directory, in the HDFS service where the target Hive service's data is\nstored, where the export file will be saved. Optional. If not provided,\nCloudera Manager will pick a directory for storing the data.", "type" : "string" }, "force" : { "description" : "Whether to force overwriting of mismatched tables. Defaults to false.", "type" : "boolean" }, "replicateData" : { "description" : "Whether to replicate table data stored in HDFS. Defaults to false.\n\nIf set, the \"hdfsArguments\" property must be set to configure the\nHDFS replication job.", "type" : "boolean" }, "hdfsArguments" : { "description" : "Arguments for the HDFS replication job.\n\nThis must be provided when choosing to replicate table data stored in HDFS.\nThe \"sourceService\", \"sourcePath\" and \"dryRun\" properties of the HDFS\narguments are ignored; their values are derived from the Hive replication's\ninformation.\n\nThe \"destinationPath\" property is used slightly differently from the\nusual HDFS replication jobs. It is used to map the root path of the\nsource service into the target service. It may be omitted, in which\ncase the source and target paths will match.\n\nExample: if the destination path is set to \"/new_root\", a \"/foo/bar\" path\nin the source will be stored in \"/new_root/foo/bar\" in the target.", "$ref" : "#/definitions/ApiHdfsReplicationArguments" }, "replicateImpalaMetadata" : { "description" : "Whether to replicate the impala metadata. (i.e. the metadata for impala\nUDFs and their corresponding binaries in HDFS).", "type" : "boolean" }, "runInvalidateMetadata" : { "description" : "Whether to run invalidate metadata query or not", "type" : "boolean" }, "dryRun" : { "description" : "Whether to perform a dry run. Defaults to false", "type" : "boolean" }, "numThreads" : { "description" : "Number of threads to use in multi-threaded export/import phase", "type" : "integer" }, "sentryMigration" : { "description" : "", "type" : "boolean" }, "skipUrlPermissions" : { "description" : "Is skipUrlPermissions on.", "type" : "boolean" } }, "example" : { "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "tableFilters" : [ { "database" : "...", "tableName" : "..." }, { "database" : "...", "tableName" : "..." } ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : { "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "description" : "Replication arguments for Hive services." }, "ApiHiveReplicationError" : { "type" : "object", "title" : "ApiHiveReplicationError", "properties" : { "database" : { "description" : "Name of the database.", "type" : "string" }, "tableName" : { "description" : "Name of the table.", "type" : "string" }, "impalaUDF" : { "description" : "UDF signature, includes the UDF name and parameter types.", "type" : "string" }, "hiveUDF" : { "description" : "Hive UDF signature, includes the UDF name and parameter types.", "type" : "string" }, "error" : { "description" : "Description of the error.", "type" : "string" } }, "example" : { "database" : "...", "tableName" : "...", "impalaUDF" : "...", "hiveUDF" : "...", "error" : "..." }, "description" : "A Hive replication error." }, "ApiHiveReplicationResult" : { "type" : "object", "title" : "ApiHiveReplicationResult", "properties" : { "phase" : { "description" : "Phase the replication is in.\n\nIf the replication job is still active, this will contain a string\ndescribing the current phase. This will be one of: EXPORT, DATA or\nIMPORT, for, respectively, exporting the source metastore information,\nreplicating table data (if configured), and importing metastore\ninformation in the target.\n\nThis value will not be present if the replication is not active.\n\nAvailable since API v4.", "type" : "string" }, "tableCount" : { "description" : "Number of tables that were successfully replicated. Available since API v4.", "type" : "integer" }, "tables" : { "description" : "The list of tables successfully replicated.\n\nSince API v4, this is only available in the full view.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHiveTable" } }, "impalaUDFCount" : { "description" : "Number of impala UDFs that were successfully replicated. Available since\nAPI v6.", "type" : "integer" }, "hiveUDFCount" : { "description" : "Number of hive UDFs that were successfully replicated. Available since\nAPI v14.", "type" : "integer" }, "impalaUDFs" : { "description" : "The list of Impala UDFs successfully replicated. Available since API v6\nin the full view.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiImpalaUDF" } }, "hiveUDFs" : { "description" : "The list of Impala UDFs successfully replicated. Available since API v6\nin the full view.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHiveUDF" } }, "errorCount" : { "description" : "Number of errors detected during replication job.\nAvailable since API v4.", "type" : "integer" }, "errors" : { "description" : "List of errors encountered during replication.\n\nSince API v4, this is only available in the full view.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHiveReplicationError" } }, "dataReplicationResult" : { "description" : "Result of table data replication, if performed.", "$ref" : "#/definitions/ApiHdfsReplicationResult" }, "dryRun" : { "description" : "Whether this was a dry run.", "type" : "boolean" }, "runAsUser" : { "description" : "Name of the of proxy user, if any.\nAvailable since API v11.", "type" : "string" }, "runOnSourceAsUser" : { "description" : "Name of the source proxy user, if any.\nAvailable since API v18.", "type" : "string" }, "logPath" : { "description" : "Returns HDFS path of DistCp execution log files.\nAvailable since API v33.", "type" : "string" }, "directoryForMetadata" : { "description" : "Returns HDFS path of export file for Hive replication.\nAvailable since API v33.", "type" : "string" }, "statsAvailable" : { "description" : "Whether stats are available to display or not.\nAvailable since API v19.", "type" : "boolean" }, "dbProcessed" : { "description" : "Number of Db's Imported/Exported.\nAvailable since API v19.", "type" : "integer" }, "tableProcessed" : { "description" : "Number of Tables Imported/Exported.\nAvailable since API v19.", "type" : "integer" }, "partitionProcessed" : { "description" : "Number of Partitions Imported/Exported.\nAvailable since API v19.", "type" : "integer" }, "functionProcessed" : { "description" : "Number of Functions Imported/Exported.\nAvailable since API v19.", "type" : "integer" }, "indexProcessed" : { "description" : "Number of Indexes Imported/Exported.\nAvailable since API v19.", "type" : "integer" }, "statsProcessed" : { "description" : "Number of Table and Partitions Statistics Imported/Exported.\nAvailable since API v19.", "type" : "integer" }, "dbExpected" : { "description" : "Number of Db's Expected.\nAvailable since API v19.", "type" : "integer" }, "tableExpected" : { "description" : "Number of Tables Expected.\nAvailable since API v19.", "type" : "integer" }, "partitionExpected" : { "description" : "Number of Partitions Expected.\nAvailable since API v19.", "type" : "integer" }, "functionExpected" : { "description" : "Number of Functions Expected.\nAvailable since API v19.", "type" : "integer" }, "indexExpected" : { "description" : "Number of Indexes Expected.\nAvailable since API v19.", "type" : "integer" }, "statsExpected" : { "description" : "Number of Table and Partition Statistics Expected.\nAvailable since API v19.", "type" : "integer" } }, "example" : { "phase" : "...", "tableCount" : 12345, "tables" : [ { "database" : "...", "tableName" : "..." }, { "database" : "...", "tableName" : "..." } ], "impalaUDFCount" : 12345, "hiveUDFCount" : 12345, "impalaUDFs" : [ { "database" : "...", "signature" : "..." }, { "database" : "...", "signature" : "..." } ], "hiveUDFs" : [ { "database" : "...", "signature" : "..." }, { "database" : "...", "signature" : "..." } ], "errorCount" : 12345, "errors" : [ { "database" : "...", "tableName" : "...", "impalaUDF" : "...", "hiveUDF" : "...", "error" : "..." }, { "database" : "...", "tableName" : "...", "impalaUDF" : "...", "hiveUDF" : "...", "error" : "..." } ], "dataReplicationResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ { "group" : "...", "name" : "...", "value" : 12345 }, { "group" : "...", "name" : "...", "value" : 12345 } ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "dryRun" : true, "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "directoryForMetadata" : "...", "statsAvailable" : true, "dbProcessed" : 12345, "tableProcessed" : 12345, "partitionProcessed" : 12345, "functionProcessed" : 12345, "indexProcessed" : 12345, "statsProcessed" : 12345, "dbExpected" : 12345, "tableExpected" : 12345, "partitionExpected" : 12345, "functionExpected" : 12345, "indexExpected" : 12345, "statsExpected" : 12345 }, "description" : "Detailed information about a Hive replication job." }, "ApiHiveTable" : { "type" : "object", "title" : "ApiHiveTable", "properties" : { "database" : { "description" : "Name of the database to which this table belongs.", "type" : "string" }, "tableName" : { "description" : "Name of the table. When used as input for a replication job, this can\nbe a regular expression that matches several table names. Refer to the\nHive documentation for the syntax of regular expressions.", "type" : "string" } }, "example" : { "database" : "...", "tableName" : "..." }, "description" : "A Hive table identifier." }, "ApiHiveUDF" : { "type" : "object", "title" : "ApiHiveUDF", "properties" : { "database" : { "description" : "Name of the database to which this UDF belongs.", "type" : "string" }, "signature" : { "description" : "UDF signature, includes the UDF name and parameter types.", "type" : "string" } }, "example" : { "database" : "...", "signature" : "..." }, "description" : "An hive UDF identifier." }, "ApiHost" : { "type" : "object", "title" : "ApiHost", "properties" : { "hostId" : { "description" : "A unique host identifier.\nThis is not the same as the hostname (FQDN). It is a distinct\nvalue that remains the same even if the hostname changes.", "type" : "string" }, "ipAddress" : { "description" : "The host IP address. This field is not mutable after the initial creation.", "type" : "string" }, "hostname" : { "description" : "The hostname. This field is not mutable after the initial creation.", "type" : "string" }, "rackId" : { "description" : "The rack ID for this host.", "type" : "string" }, "lastHeartbeat" : { "description" : "Readonly. Requires \"full\" view.\nWhen the host agent sent the last heartbeat.", "type" : "string" }, "roleRefs" : { "description" : "Readonly. Requires \"full\" view.\nThe list of roles assigned to this host.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiRoleRef" } }, "healthSummary" : { "description" : "Readonly. Requires \"full\" view.\nThe high-level health status of this host.", "$ref" : "#/definitions/ApiHealthSummary" }, "healthChecks" : { "description" : "Readonly. Requires \"full\" view.\nThe list of health checks performed on the host, with their results.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHealthCheck" } }, "hostUrl" : { "description" : "Readonly.\nA URL into the Cloudera Manager web UI for this specific host.", "type" : "string" }, "maintenanceMode" : { "description" : "Readonly. Whether the host is in maintenance mode.\nAvailable since API v2.", "type" : "boolean" }, "commissionState" : { "description" : "Readonly. The commission state of this role.\nAvailable since API v2.", "$ref" : "#/definitions/ApiCommissionState" }, "maintenanceOwners" : { "description" : "Readonly. The list of objects that trigger this host to be in\nmaintenance mode.\nAvailable since API v2.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityType" } }, "config" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "numCores" : { "description" : "Readonly. The number of logical CPU cores on this host. Only populated\nafter the host has heartbeated to the server.\nAvailable since API v4.", "type" : "integer" }, "numPhysicalCores" : { "description" : "Readonly. The number of physical CPU cores on this host. Only populated\nafter the host has heartbeated to the server.\nAvailable since API v9.", "type" : "integer" }, "totalPhysMemBytes" : { "description" : "Readonly. The amount of physical RAM on this host, in bytes. Only\npopulated after the host has heartbeated to the server.\nAvailable since API v4.", "type" : "number" }, "entityStatus" : { "description" : "Readonly. The entity status for this host.\nAvailable since API v11.", "$ref" : "#/definitions/ApiEntityStatus" }, "clusterRef" : { "description" : "Readonly. A reference to the enclosing cluster. This might be null if the\nhost is not yet assigned to a cluster.\nAvailable since API v11.", "$ref" : "#/definitions/ApiClusterRef" }, "distribution" : { "description" : "Readonly. OS distribution available on the host.\nAvailable since API v40.", "$ref" : "#/definitions/ApiOsDistribution" }, "tags" : { "description" : "Tags associated with the host.\nAvailable since V41.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } } }, "example" : { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTED" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "HISTORY_NOT_AVAILABLE" } ], "healthSummary" : "DISABLED", "healthChecks" : [ { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "DECOMMISSIONED", "maintenanceOwners" : [ "HOST", "HOST" ], "config" : { "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "GOOD_HEALTH", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "UBUNTU_FOCAL", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, "description" : "This is the model for a host in the system." }, "ApiHostCertInfo" : { "type" : "object", "title" : "ApiHostCertInfo", "properties" : { "hostname" : { "description" : "The FQDN of a host in the deployment.", "type" : "string" }, "certificate" : { "example" : "host-cert.pem", "description" : "The certificate for this host in PEM format.", "type" : "string" }, "key" : { "example" : "host-key.pem", "description" : "The private key for this host in PEM format.", "type" : "string" }, "subjectAltNames" : { "example" : "DNS:example.cloudera.com", "description" : "A list of alt names for a host.", "type" : "array", "items" : { "type" : "string" } } }, "example" : { "hostname" : "...", "certificate" : "host-cert.pem", "key" : "host-key.pem", "subjectAltNames" : [ "DNS:example.cloudera.com", "..." ] }, "description" : "Associates a hostname with its corresponding certificate and private key" }, "ApiHostInstallArguments" : { "type" : "object", "title" : "ApiHostInstallArguments", "properties" : { "hostNames" : { "description" : "List of hosts to configure for use with Cloudera Manager.\nA host may be specified by a hostname (FQDN) or an\nIP address.", "type" : "array", "items" : { "type" : "string" } }, "sshPort" : { "description" : "SSH port. If unset, defaults to 22.", "type" : "integer" }, "userName" : { "description" : "The username used to authenticate with the hosts.\nRoot access to your hosts is required to install Cloudera packages.\nThe installer will connect to your hosts via SSH and log in either\ndirectly as root or as another user with password-less sudo\nprivileges to become root.", "type" : "string" }, "password" : { "description" : "The password used to authenticate with the hosts.\nSpecify either this or a private key.\nFor password-less login, use an empty string as\npassword.", "type" : "string" }, "privateKey" : { "description" : "The private key to authenticate with the hosts.\nSpecify either this or a password.\n\nUsage information is provided for individual clusters, as well as totals\nacross all clusters." }, "ApiListBase" : { "type" : "object", "title" : "ApiListBase", "example" : {}, "description" : "A generic list." }, "ApiMapEntry" : { "type" : "object", "title" : "ApiMapEntry", "properties" : { "key" : { "description" : "", "type" : "string" }, "value" : { "description" : "", "type" : "string" } }, "example" : { "key" : "...", "value" : "..." }, "description" : "Models a map entry, with a key and a value. By forming a list of these\nentries you can have the equivalent of Map<String, String> (since\nJAX-B doesn't support maps)." }, "ApiMapEntryOfHostNameList" : { "type" : "object", "title" : "ApiMapEntryOfHostNameList", "properties" : { "key" : { "description" : "", "type" : "string" }, "value" : { "description" : "", "$ref" : "#/definitions/ApiHostNameList" } }, "example" : { "key" : "...", "value" : { "items" : [ "...", "..." ] } }, "description" : "Similar to ApiMapEntry but the value is an ApiHostNameList." }, "ApiMetric" : { "type" : "object", "title" : "ApiMetric", "properties" : { "name" : { "description" : "Name of the metric.", "type" : "string" }, "context" : { "description" : "Context the metric is associated with.", "type" : "string" }, "unit" : { "description" : "Unit of the metric values.", "type" : "string" }, "data" : { "description" : "List of readings retrieved from the monitors.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiMetricData" } }, "displayName" : { "description" : "Requires \"full\" view. User-friendly display name for the metric.", "type" : "string" }, "description" : { "description" : "Requires \"full\" view. Description of the metric.", "type" : "string" } }, "example" : { "name" : "...", "context" : "...", "unit" : "...", "data" : [ { "timestamp" : "...", "value" : 12345.0 }, { "timestamp" : "...", "value" : 12345.0 } ], "displayName" : "...", "description" : "..." }, "description" : "A metric represents a specific metric monitored by the Cloudera Management\nServices, and a list of values matching a user query.\n
\nThese fields are available only in the \"full\" view:\n
\nNameservices can be either a stand-alone NameNode, a NameNode paired with\na SecondaryNameNode, or a high-availability pair formed by an active and\na stand-by NameNode.\n
\nThe following fields are only available in the object's full view:\n
\nThere are a number of stages a parcel can be in. There are two types of\nstages - stable and transient. A parcel is in a transient stage when it is\ntransitioning between two stable stages. The stages are listed below with\nsome additional information.\n\n
>\nThe available parcels are determined by which cluster they will be running on.\nFor example, a SLES parcel won't show up for a RHEL cluster.\n
" }, "ApiParcelList" : { "type" : "object", "title" : "ApiParcelList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiParcel" } } } } ], "example" : { "items" : [ { "product" : "...", "version" : "...", "stage" : "...", "state" : { "progress" : 12345, "totalProgress" : 12345, "count" : 12345, "totalCount" : 12345, "errors" : [ "...", "..." ], "warnings" : [ "...", "..." ] }, "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "displayName" : "...", "description" : "..." }, { "product" : "...", "version" : "...", "stage" : "...", "state" : { "progress" : 12345, "totalProgress" : 12345, "count" : 12345, "totalCount" : 12345, "errors" : [ "...", "..." ], "warnings" : [ "...", "..." ] }, "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "displayName" : "...", "description" : "..." } ] }, "description" : "A list of ApiParcel." }, "ApiParcelRef" : { "type" : "object", "title" : "ApiParcelRef", "properties" : { "clusterName" : { "description" : "The name of the cluster that the parcel is used by.", "type" : "string" }, "parcelName" : { "description" : "The name of the parcel.", "type" : "string" }, "parcelVersion" : { "description" : "The version of the parcel.", "type" : "string" }, "parcelDisplayName" : { "description" : "The display name of the parcel. If set, available since v40.", "type" : "string" } }, "example" : { "clusterName" : "...", "parcelName" : "...", "parcelVersion" : "...", "parcelDisplayName" : "..." }, "description" : "A parcelRef references a parcel. Each parcel is identified by its \"parcelName\"\nand \"parcelVersion\", and the \"clusterName\" of the cluster that is using it.\nTo operate on the parcel object, use the API with the those fields as\nparameters." }, "ApiParcelState" : { "type" : "object", "title" : "ApiParcelState", "properties" : { "progress" : { "description" : "The progress of the state transition.", "type" : "integer" }, "totalProgress" : { "description" : "The total amount that #getProgress() needs to get to.", "type" : "integer" }, "count" : { "description" : "The current hosts that have completed.", "type" : "integer" }, "totalCount" : { "description" : "The total amount that #getCount() needs to get to.", "type" : "integer" }, "errors" : { "description" : "The errors that exist for this parcel.", "type" : "array", "items" : { "type" : "string" } }, "warnings" : { "description" : "The warnings that exist for this parcel.", "type" : "array", "items" : { "type" : "string" } } }, "example" : { "progress" : 12345, "totalProgress" : 12345, "count" : 12345, "totalCount" : 12345, "errors" : [ "...", "..." ], "warnings" : [ "...", "..." ] }, "description" : "The ApiParcelState encapsulates the state of a parcel while it is in\ntransition and reports any errors that may have occurred..\n\nThe complete progress of a parcel is broken up into two different reporting\nindicators - progress and count. Progress is the primary indicator that reports\nthe global state of transitions. For example, when downloading,\nprogress and totalProgress will show the current number of bytes downloaded\nand the total number of bytes needed to be downloaded respectively.\n
\n\nThe count and totalCount indicator is used when a state transition affects\nmultiple hosts. The count and totalCount show the current number of hosts\ncompleted and the total number of hosts respectively. For example, during distribution,\nthe progress and totalProgress will show how many bytes have been transferred\nto each host and the count will indicate how many hosts of of totalCount\nhave had parcels unpacked.\n
\n\nAlong with the two progress indicators, the ApiParcelState shows both errors\nand warnings that may have turned up during a state transition.\n
" }, "ApiParcelUsage" : { "type" : "object", "title" : "ApiParcelUsage", "properties" : { "racks" : { "description" : "The racks that contain hosts that are part of this cluster.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiParcelUsageRack" } }, "parcels" : { "description" : "The parcel's that are activated and/or in-use on this cluster.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiParcelUsageParcel" } } }, "example" : { "racks" : [ { "hosts" : [ { "hostRef" : {}, "roles" : [ {}, {} ] }, { "hostRef" : {}, "roles" : [ {}, {} ] } ], "rackId" : "..." }, { "hosts" : [ { "hostRef" : {}, "roles" : [ {}, {} ] }, { "hostRef" : {}, "roles" : [ {}, {} ] } ], "rackId" : "..." } ], "parcels" : [ { "parcelRef" : { "clusterName" : "...", "parcelName" : "...", "parcelVersion" : "...", "parcelDisplayName" : "..." }, "processCount" : 12345, "activated" : true }, { "parcelRef" : { "clusterName" : "...", "parcelName" : "...", "parcelVersion" : "...", "parcelDisplayName" : "..." }, "processCount" : 12345, "activated" : true } ] }, "description" : "This object provides a complete view of the usage of parcels in a given\ncluster - particularly which parcels are in use for which roles." }, "ApiParcelUsageHost" : { "type" : "object", "title" : "ApiParcelUsageHost", "properties" : { "hostRef" : { "description" : "A reference to the corresponding Host object.", "$ref" : "#/definitions/ApiHostRef" }, "roles" : { "description" : "A collection of the roles present on the host.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiParcelUsageRole" } } }, "example" : { "hostRef" : { "hostId" : "...", "hostname" : "..." }, "roles" : [ { "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "BUSY" }, "parcelRefs" : [ { "clusterName" : "...", "parcelName" : "...", "parcelVersion" : "...", "parcelDisplayName" : "..." }, { "clusterName" : "...", "parcelName" : "...", "parcelVersion" : "...", "parcelDisplayName" : "..." } ] }, { "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "parcelRefs" : [ { "clusterName" : "...", "parcelName" : "...", "parcelVersion" : "...", "parcelDisplayName" : "..." }, { "clusterName" : "...", "parcelName" : "...", "parcelVersion" : "...", "parcelDisplayName" : "..." } ] } ] }, "description" : "This object is used to represent a host within an ApiParcelUsage." }, "ApiParcelUsageParcel" : { "type" : "object", "title" : "ApiParcelUsageParcel", "properties" : { "parcelRef" : { "description" : "Reference to the corresponding Parcel object.", "$ref" : "#/definitions/ApiParcelRef" }, "processCount" : { "description" : "How many running processes on the cluster are using the parcel.", "type" : "integer" }, "activated" : { "description" : "Is this parcel currently activated on the cluster.", "type" : "boolean" } }, "example" : { "parcelRef" : { "clusterName" : "...", "parcelName" : "...", "parcelVersion" : "...", "parcelDisplayName" : "..." }, "processCount" : 12345, "activated" : true }, "description" : "This object is used to represent a parcel within an ApiParcelUsage." }, "ApiParcelUsageRack" : { "type" : "object", "title" : "ApiParcelUsageRack", "properties" : { "hosts" : { "description" : "A collection of the hosts in the rack.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiParcelUsageHost" } }, "rackId" : { "description" : "The rack ID for the rack.", "type" : "string" } }, "example" : { "hosts" : [ { "hostRef" : { "hostId" : "...", "hostname" : "..." }, "roles" : [ { "roleRef" : {}, "parcelRefs" : [ {}, {} ] }, { "roleRef" : {}, "parcelRefs" : [ {}, {} ] } ] }, { "hostRef" : { "hostId" : "...", "hostname" : "..." }, "roles" : [ { "roleRef" : {}, "parcelRefs" : [ {}, {} ] }, { "roleRef" : {}, "parcelRefs" : [ {}, {} ] } ] } ], "rackId" : "..." }, "description" : "This object is used to represent a rack within an ApiParcelUsage." }, "ApiParcelUsageRole" : { "type" : "object", "title" : "ApiParcelUsageRole", "properties" : { "roleRef" : { "description" : "A reference to the corresponding Role object.", "$ref" : "#/definitions/ApiRoleRef" }, "parcelRefs" : { "description" : "A collection of references to the parcels being used by the role.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiParcelRef" } } }, "example" : { "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "parcelRefs" : [ { "clusterName" : "...", "parcelName" : "...", "parcelVersion" : "...", "parcelDisplayName" : "..." }, { "clusterName" : "...", "parcelName" : "...", "parcelVersion" : "...", "parcelDisplayName" : "..." } ] }, "description" : "This object is used to represent a role within an ApiParcelUsage." }, "ApiPerfInspectorBandwidthArgs" : { "type" : "object", "title" : "ApiPerfInspectorBandwidthArgs", "properties" : { "runBandwidthDiagnostics" : { "example" : false, "description" : "Optional flag to run bandwidth diagnostics test.\nExercise caution, running bandwidth test will have an impact on currently running\nworkloads.\nIf not specified, defaults to false.", "type" : "boolean" }, "bandwidthTimeoutSecs" : { "example" : 10, "description" : "Timeout in seconds for the bandwidth request to each target host.\nIf not specified, defaults to 10 seconds.", "type" : "integer" } }, "example" : { "runBandwidthDiagnostics" : false, "bandwidthTimeoutSecs" : 10 }, "description" : "Arguments to run bandwidth diagnostics as part of performance inspector.\nRequires iperf3 package installed on hosts." }, "ApiPerfInspectorPingArgs" : { "type" : "object", "title" : "ApiPerfInspectorPingArgs", "properties" : { "pingTimeoutSecs" : { "example" : 10, "description" : "Timeout in seconds for the ping request to each target host.\nIf not specified, defaults to 10 seconds.\nMust be a value between 1 and 3600 seconds, inclusive.", "type" : "integer" }, "pingCount" : { "example" : 10, "description" : "Number of iterations of the ping request to each target host.\nIf not specified, defaults to 10 count.", "type" : "integer" }, "pingPacketSizeBytes" : { "example" : 56, "description" : "Packet size in bytes for each ping request.\nIf not specified, defaults to 56 bytes.\nMust be a value between 1 and 65507 bytes, inclusive.", "type" : "integer" } }, "example" : { "pingTimeoutSecs" : 10, "pingCount" : 10, "pingPacketSizeBytes" : 56 }, "description" : "Arguments to run ping test." }, "ApiPrincipalList" : { "type" : "object", "title" : "ApiPrincipalList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "type" : "string" } } } } ], "example" : { "items" : [ "...", "..." ] }, "description" : "A list of kerberos principals." }, "ApiProcess" : { "type" : "object", "title" : "ApiProcess", "properties" : { "configFiles" : { "description" : "List of config files supplied to the process.", "type" : "array", "items" : { "type" : "string" } } }, "example" : { "configFiles" : [ "...", "..." ] }, "description" : "A process represents a unix process to be managed by the Cloudera\nManager agents. A process can be a daemon, e.g. if it is associated\nwith a running role. It can also be a one-off process which is expected\nto start, run and finish." }, "ApiProductVersion" : { "type" : "object", "title" : "ApiProductVersion", "properties" : { "version" : { "description" : "", "type" : "string" }, "product" : { "description" : "", "type" : "string" } }, "example" : { "version" : "...", "product" : "..." }, "description" : "" }, "ApiRemoteCommand" : { "type" : "object", "title" : "ApiRemoteCommand", "properties" : { "id" : { "description" : "Id of the remotely executed command.", "type" : "integer" }, "peerName" : { "description" : "The local peer name of the remote peer cluster.", "type" : "string" } }, "example" : { "id" : 12345, "peerName" : "..." }, "description" : "References a command executed on a peer cluster by a local command step." }, "ApiRemoteDataContext" : { "type" : "object", "title" : "ApiRemoteDataContext", "properties" : { "endPointId" : { "description" : "A string to uniquely identify the SDX cluster.", "type" : "string" }, "endPoints" : { "description" : "List of endPoints exported by this SDX cluster.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEndPoint" } }, "configs" : { "description" : "SDX cluster specifc options.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiMapEntry" } }, "clusterVersion" : { "description" : "Cluster version", "type" : "string" } }, "example" : { "endPointId" : "...", "endPoints" : [ { "name" : "...", "version" : "...", "serviceConfigs" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "endPointHostList" : [ { "uri" : "...", "endPointConfigs" : [ {}, {} ], "type" : "..." }, { "uri" : "...", "endPointConfigs" : [ {}, {} ], "type" : "..." } ], "serviceType" : "..." }, { "name" : "...", "version" : "...", "serviceConfigs" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "endPointHostList" : [ { "uri" : "...", "endPointConfigs" : [ {}, {} ], "type" : "..." }, { "uri" : "...", "endPointConfigs" : [ {}, {} ], "type" : "..." } ], "serviceType" : "..." } ], "configs" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "clusterVersion" : "..." }, "description" : "This object contains enough information for a Workload cluster to connect to an SDX cluster.\nThis object contains no secrets." }, "ApiRemoteRepoUrl" : { "type" : "object", "title" : "ApiRemoteRepoUrl", "properties" : { "remoteRepoUrl" : { "description" : "", "type" : "string" } }, "example" : { "remoteRepoUrl" : "..." }, "description" : "A remote repository URL. Cannot be provided as a path parameter because it may contain\nspecial characters." }, "ApiReplicationCommand" : { "type" : "object", "title" : "ApiReplicationCommand", "allOf" : [ { "$ref" : "#/definitions/ApiCommand" }, { "properties" : { "hdfsResult" : { "description" : "Results for replication commands on HDFS services.", "$ref" : "#/definitions/ApiHdfsReplicationResult" }, "ozoneResult" : { "description" : "Results for replication commands on OZONE services.", "$ref" : "#/definitions/ApiOzoneReplicationResult" }, "hiveResult" : { "description" : "Results for replication commands on Hive services.", "$ref" : "#/definitions/ApiHiveReplicationResult" }, "hiveOnTezResult" : { "description" : "Results for replication commands on HiveOnTez services.", "$ref" : "#/definitions/ApiHiveOnTezReplicationResult" }, "hbaseInfo" : { "description" : "", "$ref" : "#/definitions/ApiHBaseReplicationInfo" } } } ], "example" : { "hdfsResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ { "group" : "...", "name" : "...", "value" : 12345 }, { "group" : "...", "name" : "...", "value" : 12345 } ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "ozoneResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ { "group" : "...", "name" : "...", "value" : 12345 }, { "group" : "...", "name" : "...", "value" : 12345 } ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "hiveResult" : { "phase" : "...", "tableCount" : 12345, "tables" : [ { "database" : "...", "tableName" : "..." }, { "database" : "...", "tableName" : "..." } ], "impalaUDFCount" : 12345, "hiveUDFCount" : 12345, "impalaUDFs" : [ { "database" : "...", "signature" : "..." }, { "database" : "...", "signature" : "..." } ], "hiveUDFs" : [ { "database" : "...", "signature" : "..." }, { "database" : "...", "signature" : "..." } ], "errorCount" : 12345, "errors" : [ { "database" : "...", "tableName" : "...", "impalaUDF" : "...", "hiveUDF" : "...", "error" : "..." }, { "database" : "...", "tableName" : "...", "impalaUDF" : "...", "hiveUDF" : "...", "error" : "..." } ], "dataReplicationResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "dryRun" : true, "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "directoryForMetadata" : "...", "statsAvailable" : true, "dbProcessed" : 12345, "tableProcessed" : 12345, "partitionProcessed" : 12345, "functionProcessed" : 12345, "indexProcessed" : 12345, "statsProcessed" : 12345, "dbExpected" : 12345, "tableExpected" : 12345, "partitionExpected" : 12345, "functionExpected" : 12345, "indexExpected" : 12345, "statsExpected" : 12345 }, "hiveOnTezResult" : { "type" : "...", "status" : "...", "error" : "...", "tablesCurrent" : 12345, "tablesTotal" : 12345, "functionsCurrent" : 12345, "functionsTotal" : 12345, "eventsCurrent" : 12345, "eventsTotal" : 12345, "policiesCurrent" : 12345, "policiesTotal" : 12345, "entitiesCurrent" : 12345, "entitiesTotal" : 12345, "origin" : "SOURCE" }, "hbaseInfo" : { "replicationOperations" : [ "...", "..." ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true }, "description" : "Information about a replication command.\n\nThis object holds all the information a regular ApiCommand object provides,\nand adds specific information about the results of a replication command.\n\nDepending on the type of the service where the replication was run, a\ndifferent result property will be populated." }, "ApiReplicationCommandList" : { "type" : "object", "title" : "ApiReplicationCommandList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiReplicationCommand" } } } } ], "example" : { "items" : [ { "hdfsResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "ozoneResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "hiveResult" : { "phase" : "...", "tableCount" : 12345, "tables" : [ {}, {} ], "impalaUDFCount" : 12345, "hiveUDFCount" : 12345, "impalaUDFs" : [ {}, {} ], "hiveUDFs" : [ {}, {} ], "errorCount" : 12345, "errors" : [ {}, {} ], "dataReplicationResult" : {}, "dryRun" : true, "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "directoryForMetadata" : "...", "statsAvailable" : true, "dbProcessed" : 12345, "tableProcessed" : 12345, "partitionProcessed" : 12345, "functionProcessed" : 12345, "indexProcessed" : 12345, "statsProcessed" : 12345, "dbExpected" : 12345, "tableExpected" : 12345, "partitionExpected" : 12345, "functionExpected" : 12345, "indexExpected" : 12345, "statsExpected" : 12345 }, "hiveOnTezResult" : { "type" : "...", "status" : "...", "error" : "...", "tablesCurrent" : 12345, "tablesTotal" : 12345, "functionsCurrent" : 12345, "functionsTotal" : 12345, "eventsCurrent" : 12345, "eventsTotal" : 12345, "policiesCurrent" : 12345, "policiesTotal" : 12345, "entitiesCurrent" : 12345, "entitiesTotal" : 12345, "origin" : "SOURCE" }, "hbaseInfo" : { "replicationOperations" : [ "...", "..." ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "hdfsResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "ozoneResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "hiveResult" : { "phase" : "...", "tableCount" : 12345, "tables" : [ {}, {} ], "impalaUDFCount" : 12345, "hiveUDFCount" : 12345, "impalaUDFs" : [ {}, {} ], "hiveUDFs" : [ {}, {} ], "errorCount" : 12345, "errors" : [ {}, {} ], "dataReplicationResult" : {}, "dryRun" : true, "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "directoryForMetadata" : "...", "statsAvailable" : true, "dbProcessed" : 12345, "tableProcessed" : 12345, "partitionProcessed" : 12345, "functionProcessed" : 12345, "indexProcessed" : 12345, "statsProcessed" : 12345, "dbExpected" : 12345, "tableExpected" : 12345, "partitionExpected" : 12345, "functionExpected" : 12345, "indexExpected" : 12345, "statsExpected" : 12345 }, "hiveOnTezResult" : { "type" : "...", "status" : "...", "error" : "...", "tablesCurrent" : 12345, "tablesTotal" : 12345, "functionsCurrent" : 12345, "functionsTotal" : 12345, "eventsCurrent" : 12345, "eventsTotal" : 12345, "policiesCurrent" : 12345, "policiesTotal" : 12345, "entitiesCurrent" : 12345, "entitiesTotal" : 12345, "origin" : "SOURCE" }, "hbaseInfo" : { "replicationOperations" : [ "...", "..." ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] }, "description" : "A list of replication commands." }, "ApiReplicationDiagnosticsCollectionArgs" : { "type" : "object", "title" : "ApiReplicationDiagnosticsCollectionArgs", "properties" : { "commands" : { "description" : "Commands to limit diagnostics to.\nBy default, the most recent 10 commands on the schedule will be used.", "$ref" : "#/definitions/ApiCommandList" }, "ticketNumber" : { "description" : "Ticket number to which this bundle must be associated with.", "type" : "string" }, "comments" : { "description" : "Additional comments for the bundle.", "type" : "string" }, "phoneHome" : { "description" : "Whether the diagnostics bundle must be uploaded to Cloudera.", "type" : "boolean" } }, "example" : { "commands" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "ticketNumber" : "...", "comments" : "...", "phoneHome" : true }, "description" : "Optional arguments for diagnostics collection." }, "ApiReplicationSchedule" : { "type" : "object", "title" : "ApiReplicationSchedule", "allOf" : [ { "$ref" : "#/definitions/ApiSchedule" }, { "properties" : { "hdfsArguments" : { "description" : "Optional arguments for HDFS replication commands.", "$ref" : "#/definitions/ApiHdfsReplicationArguments" }, "hiveArguments" : { "description" : "Optional arguments for Hive replication commands.", "$ref" : "#/definitions/ApiHiveReplicationArguments" }, "hdfsCloudArguments" : { "description" : "Optional arguments for HDFS cloud replication commands.", "$ref" : "#/definitions/ApiHdfsCloudReplicationArguments" }, "ozoneReplicationArguments" : { "description" : "Optional arguments for HDFS cloud replication commands.", "$ref" : "#/definitions/ApiOzoneReplicationArguments" }, "history" : { "description" : "List of active and/or finished commands for this schedule.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiReplicationCommand" } }, "active" : { "description" : "Read-only field that is true if this schedule is currently active, false if not.\nAvailable since API v11.", "type" : "boolean" }, "hiveCloudArguments" : { "description" : "Optional arguments for Hive cloud replication commands.", "$ref" : "#/definitions/ApiHiveCloudReplicationArguments" }, "hbaseArguments" : { "description" : "Optional arguments for HBase replication commands.", "$ref" : "#/definitions/ApiHBaseReplicationArguments" }, "hive3Arguments" : { "description" : "arguments for Hive3 schedules", "$ref" : "#/definitions/ApiHive3ReplicationArguments" } } } ], "example" : { "hdfsArguments" : { "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "tableFilters" : [ { "database" : "...", "tableName" : "..." }, { "database" : "...", "tableName" : "..." } ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "ozoneResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "hiveResult" : { "phase" : "...", "tableCount" : 12345, "tables" : [ {}, {} ], "impalaUDFCount" : 12345, "hiveUDFCount" : 12345, "impalaUDFs" : [ {}, {} ], "hiveUDFs" : [ {}, {} ], "errorCount" : 12345, "errors" : [ {}, {} ], "dataReplicationResult" : {}, "dryRun" : true, "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "directoryForMetadata" : "...", "statsAvailable" : true, "dbProcessed" : 12345, "tableProcessed" : 12345, "partitionProcessed" : 12345, "functionProcessed" : 12345, "indexProcessed" : 12345, "statsProcessed" : 12345, "dbExpected" : 12345, "tableExpected" : 12345, "partitionExpected" : 12345, "functionExpected" : 12345, "indexExpected" : 12345, "statsExpected" : 12345 }, "hiveOnTezResult" : { "type" : "...", "status" : "...", "error" : "...", "tablesCurrent" : 12345, "tablesTotal" : 12345, "functionsCurrent" : 12345, "functionsTotal" : 12345, "eventsCurrent" : 12345, "eventsTotal" : 12345, "policiesCurrent" : 12345, "policiesTotal" : 12345, "entitiesCurrent" : 12345, "entitiesTotal" : 12345, "origin" : "SOURCE" }, "hbaseInfo" : { "replicationOperations" : [ "...", "..." ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "hdfsResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "ozoneResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "hiveResult" : { "phase" : "...", "tableCount" : 12345, "tables" : [ {}, {} ], "impalaUDFCount" : 12345, "hiveUDFCount" : 12345, "impalaUDFs" : [ {}, {} ], "hiveUDFs" : [ {}, {} ], "errorCount" : 12345, "errors" : [ {}, {} ], "dataReplicationResult" : {}, "dryRun" : true, "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "directoryForMetadata" : "...", "statsAvailable" : true, "dbProcessed" : 12345, "tableProcessed" : 12345, "partitionProcessed" : 12345, "functionProcessed" : 12345, "indexProcessed" : 12345, "statsProcessed" : 12345, "dbExpected" : 12345, "tableExpected" : 12345, "partitionExpected" : 12345, "functionExpected" : 12345, "indexExpected" : 12345, "statsExpected" : 12345 }, "hiveOnTezResult" : { "type" : "...", "status" : "...", "error" : "...", "tablesCurrent" : 12345, "tablesTotal" : 12345, "functionsCurrent" : 12345, "functionsTotal" : 12345, "eventsCurrent" : 12345, "eventsTotal" : 12345, "policiesCurrent" : 12345, "policiesTotal" : 12345, "entitiesCurrent" : 12345, "entitiesTotal" : 12345, "origin" : "TARGET" }, "hbaseInfo" : { "replicationOperations" : [ "...", "..." ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "METADATA_AND_DATA", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "tableFilters" : [ { "database" : "...", "tableName" : "..." }, { "database" : "...", "tableName" : "..." } ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "peerState" : "ENABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ { "tableName" : "...", "initialSnapshot" : true, "snapshotSucceeded" : true }, { "tableName" : "...", "initialSnapshot" : true, "snapshotSucceeded" : true } ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "status" : "ENABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : { "sourceAccount" : "..." } }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, "description" : "A replication job schedule.\n\nReplication jobs have service-specific arguments. This object has methods\nto retrieve arguments for all supported types of replication, but only\none argument type is allowed to be set; the backend will check that the\nprovided argument matches the service type where the replication is\nbeing scheduled.\n\nThe replication job's arguments should match the underlying service. Refer\nto each property's documentation to find out which properties correspond to\nwhich services." }, "ApiReplicationScheduleDataLimits" : { "type" : "object", "title" : "ApiReplicationScheduleDataLimits", "required" : [ "maxCommandsPerSchedule", "maxTablesPerResult", "maxErrorsPerResult" ], "properties" : { "maxCommandsPerSchedule" : { "description" : "", "type" : "integer" }, "maxTablesPerResult" : { "description" : "", "type" : "integer" }, "maxErrorsPerResult" : { "description" : "", "type" : "integer" } }, "example" : { "maxCommandsPerSchedule" : 12345, "maxTablesPerResult" : 12345, "maxErrorsPerResult" : 12345 }, "description" : "This class encapsulates the data limits that we want to put on ApiReplicationSchedule to\navoid potential OOME. It is currently used when archiving replication history.\nAvailable since v11." }, "ApiReplicationScheduleList" : { "type" : "object", "title" : "ApiReplicationScheduleList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiReplicationSchedule" } } } } ], "example" : { "items" : [ { "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "KEEP_DATA_IN_CLOUD", "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : {}, "peerState" : "ENABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ {}, {} ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : {}, "status" : "DISABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : {} }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "MINUTE", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "KEEP_DATA_IN_CLOUD", "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : {}, "peerState" : "ENABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ {}, {} ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : {}, "status" : "FAILED_ADMIN", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : {} }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "DAY", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true } ] }, "description" : "A list of replication schedules." }, "ApiReplicationScheduleListLimits" : { "type" : "object", "title" : "ApiReplicationScheduleListLimits", "required" : [ "maxSchedulesPerList" ], "allOf" : [ { "$ref" : "#/definitions/ApiReplicationScheduleDataLimits" }, { "properties" : { "maxSchedulesPerList" : { "description" : "", "type" : "integer" } } } ], "example" : { "maxSchedulesPerList" : 12345, "maxCommandsPerSchedule" : 12345, "maxTablesPerResult" : 12345, "maxErrorsPerResult" : 12345 }, "description" : "This class encapsulates the data limits that we want to put on ApiReplicationSchedule to\navoid potential OOME. It is currently used when archiving replication history.\nAvailable since v11." }, "ApiReplicationState" : { "type" : "object", "title" : "ApiReplicationState", "properties" : { "incrementalExportEnabled" : { "description" : "returns if incremental export is enabled for the given Hive service.\nNot applicable for HDFS service.", "type" : "boolean" } }, "example" : { "incrementalExportEnabled" : true }, "description" : "The state of Hive/HDFS Replication." }, "ApiRestartClusterArgs" : { "type" : "object", "title" : "ApiRestartClusterArgs", "properties" : { "restartOnlyStaleServices" : { "description" : "Only restart services that have stale configuration and their dependent\nservices.", "type" : "boolean" }, "redeployClientConfiguration" : { "description" : "Re-deploy client configuration for all services in the cluster.", "type" : "boolean" }, "restartServiceNames" : { "description" : "Only restart services that are specified and their dependent services.\nAvailable since V11.", "type" : "array", "items" : { "type" : "string" } } }, "example" : { "restartOnlyStaleServices" : true, "redeployClientConfiguration" : true, "restartServiceNames" : [ "...", "..." ] }, "description" : "Arguments used for Cluster Restart command.\n\nSince V11:\nIf both restartOnlyStaleServices and restartServiceNames are specified,\na service must be specified in restartServiceNames and also be stale,\nin order to be restarted." }, "ApiRole" : { "type" : "object", "title" : "ApiRole", "properties" : { "name" : { "description" : "The name of the role.\nOptional when creating a role since API v6. If not specified, a name will\nbe automatically generated for the role.", "type" : "string" }, "type" : { "description" : "The type of the role, e.g. NAMENODE, DATANODE, TASKTRACKER.", "type" : "string" }, "hostRef" : { "description" : "A reference to the host where this role runs.", "$ref" : "#/definitions/ApiHostRef" }, "serviceRef" : { "description" : "Readonly. A reference to the parent service.", "$ref" : "#/definitions/ApiServiceRef" }, "roleState" : { "description" : "Readonly. The configured run state of this role. Whether it's running, etc.", "$ref" : "#/definitions/ApiRoleState" }, "commissionState" : { "description" : "Readonly. The commission state of this role.\nAvailable since API v2.", "$ref" : "#/definitions/ApiCommissionState" }, "healthSummary" : { "description" : "Readonly. The high-level health status of this role.", "$ref" : "#/definitions/ApiHealthSummary" }, "configStale" : { "description" : "Readonly. Expresses whether the role configuration is stale.", "type" : "boolean" }, "configStalenessStatus" : { "description" : "Readonly. Expresses the role's configuration staleness status.\nAvailable since API v6.", "$ref" : "#/definitions/ApiConfigStalenessStatus" }, "healthChecks" : { "description" : "Readonly. The list of health checks of this service.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHealthCheck" } }, "haStatus" : { "description" : "Readonly. The HA status of this role.", "$ref" : "#/definitions/HaStatus" }, "roleUrl" : { "description" : "Readonly.\nLink into the Cloudera Manager web UI for this specific role.", "type" : "string" }, "maintenanceMode" : { "description" : "Readonly. Whether the role is in maintenance mode.\nAvailable since API v2.", "type" : "boolean" }, "maintenanceOwners" : { "description" : "Readonly. The list of objects that trigger this role to be in\nmaintenance mode.\nAvailable since API v2.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityType" } }, "config" : { "description" : "The role configuration. Optional.", "$ref" : "#/definitions/ApiConfigList" }, "roleConfigGroupRef" : { "description" : "Readonly. The reference to the role configuration group of this role.\nAvailable since API v3.", "$ref" : "#/definitions/ApiRoleConfigGroupRef" }, "zooKeeperServerMode" : { "description" : "Readonly. The ZooKeeper server mode for this role. Note that for\nnon-ZooKeeper Server roles this will be null.\nAvailable since API v6.", "$ref" : "#/definitions/ZooKeeperServerMode" }, "entityStatus" : { "description" : "Readonly. The entity status for this role.\nAvailable since API v11.", "$ref" : "#/definitions/ApiEntityStatus" }, "tags" : { "description" : "Tags associated with the role.\nAvailable since V41.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } } }, "example" : { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "UNKNOWN", "commissionState" : "OFFLINED", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true } ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "ROLE" ], "config" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "STOPPED", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, "description" : "A role represents a specific entity that participate in a service. Examples\nare JobTrackers, DataNodes, HBase Masters. Each role is assigned a host\nwhere it runs on." }, "ApiRoleConfigGroup" : { "type" : "object", "title" : "ApiRoleConfigGroup", "properties" : { "name" : { "description" : "Readonly. The unique name of this role config group.", "type" : "string" }, "roleType" : { "description" : "Readonly. The type of the roles in this group.", "type" : "string" }, "base" : { "description" : "Readonly. Indicates whether this is a base group.", "type" : "boolean" }, "config" : { "description" : "The configuration for this group. Optional.", "$ref" : "#/definitions/ApiConfigList" }, "displayName" : { "description" : "The display name of this group.", "type" : "string" }, "serviceRef" : { "description" : "Readonly. The service reference (service name and cluster name)\nof this group.", "$ref" : "#/definitions/ApiServiceRef" } }, "example" : { "name" : "...", "roleType" : "...", "base" : true, "config" : { "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } }, "description" : "A role config group contains roles of the same role type\nsharing the same configuration. While each role has to belong\nto a group, a role config group may be empty.\n\nThere exists a default role config group for each role type.\nDefault groups cannot be removed nor created.\n\nThe name of a role config group is unique and cannot be changed.\n\nThe configuration of individual roles may be overridden on\nrole level." }, "ApiRoleConfigGroupList" : { "type" : "object", "title" : "ApiRoleConfigGroupList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiRoleConfigGroup" } } } } ], "example" : { "items" : [ { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } }, { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } ] }, "description" : "A list of role config groups." }, "ApiRoleConfigGroupRef" : { "type" : "object", "title" : "ApiRoleConfigGroupRef", "properties" : { "roleConfigGroupName" : { "description" : "The name of the role config group, which uniquely identifies it in a CM\ninstallation.", "type" : "string" } }, "example" : { "roleConfigGroupName" : "..." }, "description" : "" }, "ApiRoleList" : { "type" : "object", "title" : "ApiRoleList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiRole" } } } } ], "example" : { "items" : [ { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STOPPED", "commissionState" : "OFFLINED", "healthSummary" : "BAD", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "CONTROL_PLANE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "HISTORY_NOT_AVAILABLE", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STOPPED", "commissionState" : "OFFLINED", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "CLUSTER" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_LEADER", "entityStatus" : "NONE", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] }, "description" : "A list of roles." }, "ApiRoleNameList" : { "type" : "object", "title" : "ApiRoleNameList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "type" : "string" } } } } ], "example" : { "items" : [ "...", "..." ] }, "description" : "A list of role names." }, "ApiRoleRef" : { "type" : "object", "title" : "ApiRoleRef", "properties" : { "clusterName" : { "description" : "", "type" : "string" }, "serviceName" : { "description" : "", "type" : "string" }, "roleName" : { "description" : "", "type" : "string" }, "healthSummary" : { "description" : "The high-level health status of this role.", "$ref" : "#/definitions/ApiHealthSummary" }, "roleStatus" : { "description" : "Readonly. The entity status for this role.\nAvailable since API v11.", "$ref" : "#/definitions/ApiRoleState" } }, "example" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "description" : "A roleRef references a role. Each role is identified by its \"roleName\",\nthe \"serviceName\" for the service it belongs to, and the \"clusterName\" in\nwhich the service resides. To operate on the role object,\nuse the API with the those fields as parameters." }, "ApiRoleState" : { "type" : "string", "title" : "ApiRoleState", "enum" : [ "HISTORY_NOT_AVAILABLE", "UNKNOWN", "STARTING", "STARTED", "BUSY", "STOPPING", "STOPPED", "NA" ], "description" : "Represents the configured run state of a role." }, "ApiRoleTypeConfig" : { "type" : "object", "title" : "ApiRoleTypeConfig", "allOf" : [ { "$ref" : "#/definitions/ApiConfigList" }, { "properties" : { "roleType" : { "description" : "The role type.", "type" : "string" } } } ], "example" : { "roleType" : "...", "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 } ] }, "description" : "Role type configuration information." }, "ApiRoleTypeList" : { "type" : "object", "title" : "ApiRoleTypeList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "type" : "string" } } } } ], "example" : { "items" : [ "...", "..." ] }, "description" : "A list of roles types that exists for a given service." }, "ApiRolesToInclude" : { "type" : "string", "title" : "ApiRolesToInclude", "enum" : [ "SLAVES_ONLY", "NON_SLAVES_ONLY", "ALL_ROLES" ], "description" : "Roles to include during a cluster rolling restart." }, "ApiRollEditsArgs" : { "type" : "object", "title" : "ApiRollEditsArgs", "properties" : { "nameservice" : { "description" : "Nameservice whose edits need to be rolled.\nRequired only if HDFS service is federated.", "type" : "string" } }, "example" : { "nameservice" : "..." }, "description" : "Arguments used for the Roll Edits command." }, "ApiRollingRestartArgs" : { "type" : "object", "title" : "ApiRollingRestartArgs", "properties" : { "slaveBatchSize" : { "description" : "Number of slave roles to restart at a time.\nMust be greater than zero. Default is 1.\n\nPlease note that for HDFS, this number should be less than\nthe replication factor (default 3) to ensure data availability\nduring rolling restart.", "type" : "integer" }, "sleepSeconds" : { "description" : "Number of seconds to sleep between restarts of slave role batches.\n\nMust be greater than or equal to 0. Default is 0.", "type" : "integer" }, "slaveFailCountThreshold" : { "description" : "The threshold for number of slave batches that are allowed to fail\nto restart before the entire command is considered failed.\n\nMust be greather than or equal to 0. Default is 0.\n\nThis argument is for ADVANCED users only.\n
", "type" : "integer" }, "staleConfigsOnly" : { "description" : "Restart roles with stale configs only.", "type" : "boolean" }, "unUpgradedOnly" : { "description" : "Restart roles that haven't been upgraded yet.", "type" : "boolean" }, "restartRoleTypes" : { "description" : "Role types to restart. If not specified, all startable roles are restarted.\n\nBoth role types and role names should not be specified.", "type" : "array", "items" : { "type" : "string" } }, "restartRoleNames" : { "description" : "List of specific roles to restart.\nIf none are specified, then all roles of specified role types are restarted.\n\nBoth role types and role names should not be specified.", "type" : "array", "items" : { "type" : "string" } } }, "example" : { "slaveBatchSize" : 12345, "sleepSeconds" : 12345, "slaveFailCountThreshold" : 12345, "staleConfigsOnly" : true, "unUpgradedOnly" : true, "restartRoleTypes" : [ "...", "..." ], "restartRoleNames" : [ "...", "..." ] }, "description" : "Arguments used for Rolling Restart commands." }, "ApiRollingRestartClusterArgs" : { "type" : "object", "title" : "ApiRollingRestartClusterArgs", "properties" : { "slaveBatchSize" : { "description" : "Number of hosts with slave roles to restart at a time.\nMust be greater than zero. Default is 1.", "type" : "integer" }, "sleepSeconds" : { "description" : "Number of seconds to sleep between restarts of slave host batches.\n\nMust be greater than or equal to 0. Default is 0.", "type" : "integer" }, "slaveFailCountThreshold" : { "description" : "The threshold for number of slave host batches that are allowed to fail\nto restart before the entire command is considered failed.\n
\nMust be greater than or equal to 0. Default is 0.\n
\nThis argument is for ADVANCED users only.\n
", "type" : "integer" }, "staleConfigsOnly" : { "description" : "Restart roles with stale configs only.", "type" : "boolean" }, "unUpgradedOnly" : { "description" : "Restart roles that haven't been upgraded yet.", "type" : "boolean" }, "redeployClientConfiguration" : { "description" : "Re-deploy client configuration. Available since API v6.", "type" : "boolean" }, "rolesToInclude" : { "description" : "Role types to restart. Default is slave roles only.", "$ref" : "#/definitions/ApiRolesToInclude" }, "restartServiceNames" : { "description" : "List of services to restart.", "type" : "array", "items" : { "type" : "string" } } }, "example" : { "slaveBatchSize" : 12345, "sleepSeconds" : 12345, "slaveFailCountThreshold" : 12345, "staleConfigsOnly" : true, "unUpgradedOnly" : true, "redeployClientConfiguration" : true, "rolesToInclude" : "ALL_ROLES", "restartServiceNames" : [ "...", "..." ] }, "description" : "Arguments used for Rolling Restart Cluster command." }, "ApiRollingUpgradeClusterArgs" : { "type" : "object", "title" : "ApiRollingUpgradeClusterArgs", "properties" : { "slaveBatchSize" : { "description" : "Number of slave roles to restart at a time.\nMust be greater than zero. Default is 1.\n\nPlease note that for HDFS, this number should be less than\nthe replication factor (default 3) to ensure data availability\nduring rolling restart.", "type" : "integer" }, "sleepSeconds" : { "description" : "Number of seconds to sleep between restarts of slave role batches.\n\nMust be greater than or equal to 0. Default is 0.", "type" : "integer" }, "slaveFailCountThreshold" : { "description" : "The threshold for number of slave batches that are allowed to fail\nto restart before the entire command is considered failed.\n\nMust be greather than or equal to 0. Default is 0.\n\nThis argument is for ADVANCED users only.\n
", "type" : "integer" } }, "example" : { "slaveBatchSize" : 12345, "sleepSeconds" : 12345, "slaveFailCountThreshold" : 12345 }, "description" : "Rolling upgrade arguments used in the CDH Upgrade Command. Part of\nApiCdhUpgradeArgs." }, "ApiRollingUpgradeServicesArgs" : { "type" : "object", "title" : "ApiRollingUpgradeServicesArgs", "properties" : { "upgradeFromCdhVersion" : { "description" : "Current CDH Version of the services. Example versions are:\n\"5.1.0\", \"5.2.2\" or \"5.4.0\"", "type" : "string" }, "upgradeToCdhVersion" : { "description" : "Target CDH Version for the services. The CDH version should already\nbe present and activated on the nodes. Example versions are:\n\"5.1.0\", \"5.2.2\" or \"5.4.0\"", "type" : "string" }, "slaveBatchSize" : { "description" : "Number of hosts with slave roles to upgrade at a time.\nMust be greater than zero. Default is 1.", "type" : "integer" }, "sleepSeconds" : { "description" : "Number of seconds to sleep between restarts of slave host batches.\n\nMust be greater than or equal to 0. Default is 0.", "type" : "integer" }, "slaveFailCountThreshold" : { "description" : "The threshold for number of slave host batches that are allowed to fail\nto restart before the entire command is considered failed.\n\nMust be greater than or equal to 0. Default is 0.\n\nThis argument is for ADVANCED users only.\n
", "type" : "integer" }, "upgradeServiceNames" : { "description" : "List of services to upgrade.\nOnly the services that support rolling upgrade should be included.", "type" : "array", "items" : { "type" : "string" } } }, "example" : { "upgradeFromCdhVersion" : "...", "upgradeToCdhVersion" : "...", "slaveBatchSize" : 12345, "sleepSeconds" : 12345, "slaveFailCountThreshold" : 12345, "upgradeServiceNames" : [ "...", "..." ] }, "description" : "Arguments used for Rolling Upgrade command." }, "ApiSchedule" : { "type" : "object", "title" : "ApiSchedule", "properties" : { "id" : { "description" : "The schedule id.", "type" : "integer" }, "displayName" : { "description" : "The schedule display name.", "type" : "string" }, "description" : { "description" : "The schedule description.", "type" : "string" }, "startTime" : { "description" : "The time at which the scheduled activity is triggered for the first\ntime.", "type" : "string" }, "endTime" : { "description" : "The time after which the scheduled activity will no longer be triggered.", "type" : "string" }, "interval" : { "description" : "The duration between consecutive triggers of a scheduled activity. Defaults to 0.", "type" : "integer" }, "intervalUnit" : { "description" : "The unit for the repeat interval.", "$ref" : "#/definitions/ApiScheduleInterval" }, "nextRun" : { "description" : "Readonly. The time the scheduled command will run next.", "type" : "string" }, "paused" : { "description" : "The paused state for the schedule. The scheduled activity will not be\ntriggered as long as the scheduled is paused. Defaults to false.", "type" : "boolean" }, "alertOnStart" : { "description" : "Whether to alert on start of the scheduled activity. Defaults to false.", "type" : "boolean" }, "alertOnSuccess" : { "description" : "Whether to alert on successful completion of the scheduled activity. Defaults to false.", "type" : "boolean" }, "alertOnFail" : { "description" : "Whether to alert on failure of the scheduled activity. Defaults to false.", "type" : "boolean" }, "alertOnAbort" : { "description" : "Whether to alert on abort of the scheduled activity. Defaults to false.", "type" : "boolean" } }, "example" : { "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, "description" : "Base class for commands that can be scheduled in Cloudera Manager.\n\nNote that schedule IDs are not preserved upon import.\n" }, "ApiScheduleInterval" : { "type" : "string", "title" : "ApiScheduleInterval", "enum" : [ "MINUTE", "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ], "description" : "Represents the unit for the repeat interval for schedules." }, "ApiScmDbInfo" : { "type" : "object", "title" : "ApiScmDbInfo", "properties" : { "scmDbType" : { "description" : "Cloudera Manager server's db type", "$ref" : "#/definitions/ScmDbType" }, "embeddedDbUsed" : { "description" : "Whether Cloudera Manager server is using embedded DB", "type" : "boolean" } }, "example" : { "scmDbType" : "HSQL", "embeddedDbUsed" : true }, "description" : "Cloudera Manager server's database information" }, "ApiService" : { "type" : "object", "title" : "ApiService", "properties" : { "name" : { "description" : "The name of the service.", "type" : "string" }, "type" : { "description" : "The type of the service, e.g. HDFS, MAPREDUCE, HBASE.", "type" : "string" }, "clusterRef" : { "description" : "Readonly. A reference to the enclosing cluster.", "$ref" : "#/definitions/ApiClusterRef" }, "serviceState" : { "description" : "Readonly. The configured run state of this service.\nWhether it's running, etc.", "$ref" : "#/definitions/ApiServiceState" }, "healthSummary" : { "description" : "Readonly. The high-level health status of this service.", "$ref" : "#/definitions/ApiHealthSummary" }, "configStale" : { "description" : "Readonly. Expresses whether the service configuration is stale.", "type" : "boolean" }, "configStalenessStatus" : { "description" : "Readonly. Expresses the service's configuration staleness status which is\nbased on the staleness status of its roles.\nAvailable since API v6.", "$ref" : "#/definitions/ApiConfigStalenessStatus" }, "clientConfigStalenessStatus" : { "description" : "Readonly. Expresses the service's client configuration staleness status\nwhich is marked as stale if any of the service's hosts have missing client\nconfigurations or if any of the deployed client configurations are stale.\nAvailable since API v6.", "$ref" : "#/definitions/ApiConfigStalenessStatus" }, "healthChecks" : { "description" : "Readonly. The list of health checks of this service.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHealthCheck" } }, "serviceUrl" : { "description" : "Readonly. Link into the Cloudera Manager web UI for this specific service.", "type" : "string" }, "roleInstancesUrl" : { "description" : "Readonly. Link into the Cloudera Manager web UI for role instances table for\nthis specific service.\nAvailable since API v11.", "type" : "string" }, "maintenanceMode" : { "description" : "Readonly. Whether the service is in maintenance mode.\nAvailable since API v2.", "type" : "boolean" }, "maintenanceOwners" : { "description" : "Readonly. The list of objects that trigger this service to be in\nmaintenance mode.\nAvailable since API v2.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityType" } }, "config" : { "description" : "Configuration of the service being created. Optional.", "$ref" : "#/definitions/ApiServiceConfig" }, "roles" : { "description" : "The list of service roles. Optional.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiRole" } }, "displayName" : { "description" : "The display name for the service that is shown in the UI.\nAvailable since API v2.", "type" : "string" }, "roleConfigGroups" : { "description" : "The list of role configuration groups in this service. Optional.\nAvailable since API v3.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiRoleConfigGroup" } }, "replicationSchedules" : { "description" : "The list of replication schedules for this service. Optional.\nAvailable since API v6.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiReplicationSchedule" } }, "snapshotPolicies" : { "description" : "The list of snapshot policies for this service. Optional.\nAvailable since API v6.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiSnapshotPolicy" } }, "entityStatus" : { "description" : "Readonly. The entity status for this service.\nAvailable since API v11.", "$ref" : "#/definitions/ApiEntityStatus" }, "tags" : { "description" : "Tags associated with the service.\nAvailable since V41.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "serviceVersion" : { "description" : "Service version (optional)\nAvailable since V41.", "type" : "string" } }, "example" : { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "HISTORY_NOT_AVAILABLE", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "CONTROL_PLANE" ], "config" : { "roleTypeConfigs" : [ { "roleType" : "...", "items" : [ {}, {} ] }, { "roleType" : "...", "items" : [ {}, {} ] } ], "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "HISTORY_NOT_AVAILABLE", "commissionState" : "OFFLINED", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "CONTROL_PLANE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "HISTORY_NOT_AVAILABLE", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STOPPING", "commissionState" : "DECOMMISSIONING", "healthSummary" : "BAD", "configStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true } ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "CLUSTER" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "NONE", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ], "displayName" : "...", "roleConfigGroups" : [ { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } }, { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } ], "replicationSchedules" : [ { "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "METADATA_AND_DATA", "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : {}, "peerState" : "DISABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ {}, {} ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : {}, "status" : "DISABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : {} }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "MONTH", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "METADATA_AND_DATA", "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : {}, "peerState" : "ENABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ {}, {} ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : {}, "status" : "ENABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : {} }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "WEEK", "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" : { "tableRegExps" : [ "...", "..." ], "storage" : "REMOTE_S3" }, "hdfsArguments" : { "pathPatterns" : [ "...", "..." ] }, "lastCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "lastSuccessfulCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "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" : { "tableRegExps" : [ "...", "..." ], "storage" : "LOCAL" }, "hdfsArguments" : { "pathPatterns" : [ "...", "..." ] }, "lastCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "lastSuccessfulCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "paused" : true } ], "entityStatus" : "DISABLED_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." }, "description" : "A service (such as HDFS, MapReduce, HBase) runs in a cluster. It has roles,\nwhich are the actual entities (NameNode, DataNodes, etc.) that perform the\nservice's functions.\n\n\nThe health summary is still available, and reflects a service-wide summary." }, "ApiServiceConfig" : { "type" : "object", "title" : "ApiServiceConfig", "allOf" : [ { "$ref" : "#/definitions/ApiConfigList" }, { "properties" : { "roleTypeConfigs" : { "description" : "List of role type configurations.\nOnly available up to API v2.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiRoleTypeConfig" } } } } ], "example" : { "roleTypeConfigs" : [ { "roleType" : "...", "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, { "roleType" : "...", "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } ], "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "description" : "Service and role type configuration." }, "ApiServiceList" : { "type" : "object", "title" : "ApiServiceList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiService" } } } } ], "example" : { "items" : [ { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STOPPED", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "ROLE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPING", "commissionState" : "OFFLINED", "healthSummary" : "BAD", "configStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "CLUSTER" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_OBSERVER", "entityStatus" : "GOOD_HEALTH", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPED", "commissionState" : "UNKNOWN", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "CONTROL_PLANE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "NONE", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "WEEK", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "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", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STOPPING", "healthSummary" : "CONCERNING", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "SERVICE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPING", "commissionState" : "OFFLINED", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "ROLE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER", "entityStatus" : "NONE", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "UNKNOWN", "commissionState" : "DECOMMISSIONED", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "CLUSTER" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION", "entityStatus" : "UNKNOWN_HEALTH", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "MONTH", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "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" : "CONCERNING_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." } ] }, "description" : "A list of services." }, "ApiServiceRef" : { "type" : "object", "title" : "ApiServiceRef", "properties" : { "peerName" : { "description" : "The name of the CM peer corresponding to the remote CM that manages the\nreferenced service. This should only be set when referencing a remote\nservice.", "type" : "string" }, "clusterName" : { "description" : "The enclosing cluster for this service.", "type" : "string" }, "serviceName" : { "description" : "The service name.", "type" : "string" }, "serviceDisplayName" : { "description" : "", "type" : "string" }, "serviceType" : { "description" : "The service type. This is available since version 32", "type" : "string" } }, "example" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "description" : "A serviceRef references a service. It is identified by the \"serviceName\",\n\"clusterName\" (name of the cluster which the service belongs to) and\nan optional \"peerName\" (to reference a remote service i.e. services managed\nby other CM instances). To operate on the service object, use the API with\nthose fields as parameters." }, "ApiServiceState" : { "type" : "string", "title" : "ApiServiceState", "enum" : [ "HISTORY_NOT_AVAILABLE", "UNKNOWN", "STARTING", "STARTED", "STOPPING", "STOPPED", "NA" ], "description" : "Represents the configured run state of a service." }, "ApiServiceTypeList" : { "type" : "object", "title" : "ApiServiceTypeList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "type" : "string" } } } } ], "example" : { "items" : [ "...", "..." ] }, "description" : "A list of service types that exists for a given cluster." }, "ApiShutdownReadiness" : { "type" : "object", "title" : "ApiShutdownReadiness", "properties" : { "state" : { "description" : "Shutdown readiness state", "$ref" : "#/definitions/ShutdownReadinessState" } }, "example" : { "state" : "NOT_READY" }, "description" : "Cloudera Manager server's shutdown readiness" }, "ApiSimpleRollingRestartClusterArgs" : { "type" : "object", "title" : "ApiSimpleRollingRestartClusterArgs", "properties" : { "slaveBatchSize" : { "description" : "Number of hosts with slave roles to restart at a time.\nMust be greater than zero. Default is 1.", "type" : "integer" }, "sleepSeconds" : { "description" : "Number of seconds to sleep between restarts of slave host batches.\n
\nMust be greater than or equal to 0. Default is 0.", "type" : "integer" }, "slaveFailCountThreshold" : { "description" : "The threshold for number of slave host batches that are allowed to fail\nto restart before the entire command is considered failed.\n
\nMust be greater than or equal to 0. Default is 0.\n
\nThis argument is for ADVANCED users only.\n
", "type" : "integer" } }, "example" : { "slaveBatchSize" : 12345, "sleepSeconds" : 12345, "slaveFailCountThreshold" : 12345 }, "description" : "Basic arguments used for Rolling Restart Cluster commands." }, "ApiSnapshotCommand" : { "type" : "object", "title" : "ApiSnapshotCommand", "allOf" : [ { "$ref" : "#/definitions/ApiCommand" }, { "properties" : { "hbaseResult" : { "description" : "Results for snapshot commands on HBase services.", "$ref" : "#/definitions/ApiHBaseSnapshotResult" }, "hdfsResult" : { "description" : "Results for snapshot commands on Hdfs services.", "$ref" : "#/definitions/ApiHdfsSnapshotResult" } } } ], "example" : { "hbaseResult" : { "processedTableCount" : 12345, "processedTables" : [ "...", "..." ], "unprocessedTableCount" : 12345, "unprocessedTables" : [ "...", "..." ], "createdSnapshotCount" : 12345, "createdSnapshots" : [ { "snapshotName" : "...", "tableName" : "...", "creationTime" : "...", "storage" : "LOCAL", "storageLocation" : "..." }, { "snapshotName" : "...", "tableName" : "...", "creationTime" : "...", "storage" : "REMOTE_S3", "storageLocation" : "..." } ], "deletedSnapshotCount" : 12345, "deletedSnapshots" : [ { "snapshotName" : "...", "tableName" : "...", "creationTime" : "...", "storage" : "REMOTE_S3", "storageLocation" : "..." }, { "snapshotName" : "...", "tableName" : "...", "creationTime" : "...", "storage" : "REMOTE_S3", "storageLocation" : "..." } ], "creationErrorCount" : 12345, "creationErrors" : [ { "tableName" : "...", "snapshotName" : "...", "storage" : "REMOTE_S3", "storageLocation" : "...", "error" : "..." }, { "tableName" : "...", "snapshotName" : "...", "storage" : "LOCAL", "storageLocation" : "...", "error" : "..." } ], "deletionErrorCount" : 12345, "deletionErrors" : [ { "tableName" : "...", "snapshotName" : "...", "storage" : "LOCAL", "storageLocation" : "...", "error" : "..." }, { "tableName" : "...", "snapshotName" : "...", "storage" : "REMOTE_S3", "storageLocation" : "...", "error" : "..." } ] }, "hdfsResult" : { "processedPathCount" : 12345, "processedPaths" : [ "...", "..." ], "unprocessedPathCount" : 12345, "unprocessedPaths" : [ "...", "..." ], "createdSnapshotCount" : 12345, "createdSnapshots" : [ { "path" : "...", "snapshotName" : "...", "snapshotPath" : "...", "creationTime" : "..." }, { "path" : "...", "snapshotName" : "...", "snapshotPath" : "...", "creationTime" : "..." } ], "deletedSnapshotCount" : 12345, "deletedSnapshots" : [ { "path" : "...", "snapshotName" : "...", "snapshotPath" : "...", "creationTime" : "..." }, { "path" : "...", "snapshotName" : "...", "snapshotPath" : "...", "creationTime" : "..." } ], "creationErrorCount" : 12345, "creationErrors" : [ { "path" : "...", "snapshotName" : "...", "error" : "..." }, { "path" : "...", "snapshotName" : "...", "error" : "..." } ], "deletionErrorCount" : 12345, "deletionErrors" : [ { "path" : "...", "snapshotName" : "...", "error" : "..." }, { "path" : "...", "snapshotName" : "...", "error" : "..." } ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true }, "description" : "Information about snapshot commands.\n\nThis object holds all the information a regular ApiCommand object provides,\nand adds specific information about the results of a snapshot command.\n\nDepending on the type of the service where the snapshot command was run, a\ndifferent result property will be populated." }, "ApiSnapshotCommandList" : { "type" : "object", "title" : "ApiSnapshotCommandList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiSnapshotCommand" } } } } ], "example" : { "items" : [ { "hbaseResult" : { "processedTableCount" : 12345, "processedTables" : [ "...", "..." ], "unprocessedTableCount" : 12345, "unprocessedTables" : [ "...", "..." ], "createdSnapshotCount" : 12345, "createdSnapshots" : [ {}, {} ], "deletedSnapshotCount" : 12345, "deletedSnapshots" : [ {}, {} ], "creationErrorCount" : 12345, "creationErrors" : [ {}, {} ], "deletionErrorCount" : 12345, "deletionErrors" : [ {}, {} ] }, "hdfsResult" : { "processedPathCount" : 12345, "processedPaths" : [ "...", "..." ], "unprocessedPathCount" : 12345, "unprocessedPaths" : [ "...", "..." ], "createdSnapshotCount" : 12345, "createdSnapshots" : [ {}, {} ], "deletedSnapshotCount" : 12345, "deletedSnapshots" : [ {}, {} ], "creationErrorCount" : 12345, "creationErrors" : [ {}, {} ], "deletionErrorCount" : 12345, "deletionErrors" : [ {}, {} ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "hbaseResult" : { "processedTableCount" : 12345, "processedTables" : [ "...", "..." ], "unprocessedTableCount" : 12345, "unprocessedTables" : [ "...", "..." ], "createdSnapshotCount" : 12345, "createdSnapshots" : [ {}, {} ], "deletedSnapshotCount" : 12345, "deletedSnapshots" : [ {}, {} ], "creationErrorCount" : 12345, "creationErrors" : [ {}, {} ], "deletionErrorCount" : 12345, "deletionErrors" : [ {}, {} ] }, "hdfsResult" : { "processedPathCount" : 12345, "processedPaths" : [ "...", "..." ], "unprocessedPathCount" : 12345, "unprocessedPaths" : [ "...", "..." ], "createdSnapshotCount" : 12345, "createdSnapshots" : [ {}, {} ], "deletedSnapshotCount" : 12345, "deletedSnapshots" : [ {}, {} ], "creationErrorCount" : 12345, "creationErrors" : [ {}, {} ], "deletionErrorCount" : 12345, "deletionErrors" : [ {}, {} ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] }, "description" : "A list of snapshot commands." }, "ApiSnapshotPolicy" : { "type" : "object", "title" : "ApiSnapshotPolicy", "properties" : { "name" : { "description" : "Name of the snapshot policy.", "type" : "string" }, "description" : { "description" : "Description of the snapshot policy.", "type" : "string" }, "hourlySnapshots" : { "description" : "Number of hourly snapshots to be retained. Defaults to 0", "type" : "integer" }, "dailySnapshots" : { "description" : "Number of daily snapshots to be retained. Defaults to 0", "type" : "integer" }, "weeklySnapshots" : { "description" : "Number of weekly snapshots to be retained. Defaults to 0", "type" : "integer" }, "monthlySnapshots" : { "description" : "Number of monthly snapshots to be retained. Defaults to 0", "type" : "integer" }, "yearlySnapshots" : { "description" : "Number of yearly snapshots to be retained. Defaults to 0", "type" : "integer" }, "minuteOfHour" : { "description" : "Minute in the hour that hourly, daily, weekly, monthly and yearly\nsnapshots should be created. Valid values are 0 to 59. Default value is 0.", "type" : "integer" }, "hoursForHourlySnapshots" : { "description" : "Hours of the day that hourly snapshots should be created. Valid values\nare 0 to 23. If this list is null or empty, then hourly snapshots are\ncreated for every hour.", "type" : "array", "items" : { "type" : "integer" } }, "hourOfDay" : { "description" : "Hour in the day that daily, weekly, monthly and yearly snapshots should be\ncreated. Valid values are 0 to 23. Default value is 0.", "type" : "integer" }, "dayOfWeek" : { "description" : "Day of the week that weekly snapshots should be created. Valid values are\n1 to 7, 1 representing Sunday. Default value is 1.", "type" : "integer" }, "dayOfMonth" : { "description" : "Day of the month that monthly and yearly snapshots should be created.\nValues from 1 to 31 are allowed. Additionally 0 to -30 can be used to\nspecify offsets from the last day of the month. Default value is 1.\n\nIf this value is invalid for any month for which snapshots are required,\nthe backend will throw an exception.", "type" : "integer" }, "monthOfYear" : { "description" : "Month of the year that yearly snapshots should be created. Valid values\nare 1 to 12, 1 representing January. Default value is 1.", "type" : "integer" }, "alertOnStart" : { "description" : "Whether to alert on start of snapshot creation/deletion activity. Defaults to false", "type" : "boolean" }, "alertOnSuccess" : { "description" : "Whether to alert on successful completion of snapshot creation/deletion\nactivity. Defaults to false.", "type" : "boolean" }, "alertOnFail" : { "description" : "Whether to alert on failure of snapshot creation/deletion activity. Defaults to false.", "type" : "boolean" }, "alertOnAbort" : { "description" : "Whether to alert on abort of snapshot creation/deletion activity. Defaults to false.", "type" : "boolean" }, "hbaseArguments" : { "description" : "Arguments specific to HBase snapshot policies.", "$ref" : "#/definitions/ApiHBaseSnapshotPolicyArguments" }, "hdfsArguments" : { "description" : "Arguments specific to Hdfs snapshot policies.", "$ref" : "#/definitions/ApiHdfsSnapshotPolicyArguments" }, "lastCommand" : { "description" : "Latest command of this policy.\nThe command might still be active.", "$ref" : "#/definitions/ApiSnapshotCommand" }, "lastSuccessfulCommand" : { "description" : "Last successful command of this policy.\nReturns null if there has been no successful command.", "$ref" : "#/definitions/ApiSnapshotCommand" }, "paused" : { "description" : "Whether to pause a snapshot policy, available since V11.", "type" : "boolean" } }, "example" : { "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" : { "tableRegExps" : [ "...", "..." ], "storage" : "REMOTE_S3" }, "hdfsArguments" : { "pathPatterns" : [ "...", "..." ] }, "lastCommand" : { "hbaseResult" : { "processedTableCount" : 12345, "processedTables" : [ "...", "..." ], "unprocessedTableCount" : 12345, "unprocessedTables" : [ "...", "..." ], "createdSnapshotCount" : 12345, "createdSnapshots" : [ {}, {} ], "deletedSnapshotCount" : 12345, "deletedSnapshots" : [ {}, {} ], "creationErrorCount" : 12345, "creationErrors" : [ {}, {} ], "deletionErrorCount" : 12345, "deletionErrors" : [ {}, {} ] }, "hdfsResult" : { "processedPathCount" : 12345, "processedPaths" : [ "...", "..." ], "unprocessedPathCount" : 12345, "unprocessedPaths" : [ "...", "..." ], "createdSnapshotCount" : 12345, "createdSnapshots" : [ {}, {} ], "deletedSnapshotCount" : 12345, "deletedSnapshots" : [ {}, {} ], "creationErrorCount" : 12345, "creationErrors" : [ {}, {} ], "deletionErrorCount" : 12345, "deletionErrors" : [ {}, {} ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "lastSuccessfulCommand" : { "hbaseResult" : { "processedTableCount" : 12345, "processedTables" : [ "...", "..." ], "unprocessedTableCount" : 12345, "unprocessedTables" : [ "...", "..." ], "createdSnapshotCount" : 12345, "createdSnapshots" : [ {}, {} ], "deletedSnapshotCount" : 12345, "deletedSnapshots" : [ {}, {} ], "creationErrorCount" : 12345, "creationErrors" : [ {}, {} ], "deletionErrorCount" : 12345, "deletionErrors" : [ {}, {} ] }, "hdfsResult" : { "processedPathCount" : 12345, "processedPaths" : [ "...", "..." ], "unprocessedPathCount" : 12345, "unprocessedPaths" : [ "...", "..." ], "createdSnapshotCount" : 12345, "createdSnapshots" : [ {}, {} ], "deletedSnapshotCount" : 12345, "deletedSnapshots" : [ {}, {} ], "creationErrorCount" : 12345, "creationErrors" : [ {}, {} ], "deletionErrorCount" : 12345, "deletionErrors" : [ {}, {} ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "paused" : true }, "description" : "A snapshot policy.\n\nSnapshot policies have service specific arguments. This object has methods\nto retrieve arguments for all supported types of snapshots, but only one\nargument type is allowed to be set; the backend will check that the provided\nargument matches the type of the service with which the snapshot policy is\nassociated." }, "ApiSnapshotPolicyList" : { "type" : "object", "title" : "ApiSnapshotPolicyList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiSnapshotPolicy" } } } } ], "example" : { "items" : [ { "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" : { "tableRegExps" : [ "...", "..." ], "storage" : "REMOTE_S3" }, "hdfsArguments" : { "pathPatterns" : [ "...", "..." ] }, "lastCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "lastSuccessfulCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "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" : { "tableRegExps" : [ "...", "..." ], "storage" : "LOCAL" }, "hdfsArguments" : { "pathPatterns" : [ "...", "..." ] }, "lastCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "lastSuccessfulCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "paused" : true } ] }, "description" : "A list of snapshot policies." }, "ApiStringList" : { "type" : "object", "title" : "ApiStringList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "List of items.", "type" : "array", "items" : { "type" : "string" } } } } ], "example" : { "items" : [ "...", "..." ] }, "description" : "A list of strings." }, "ApiTagToEntities" : { "type" : "object", "title" : "ApiTagToEntities", "properties" : { "name" : { "description" : "", "type" : "string" }, "value" : { "description" : "", "type" : "string" }, "apiClusterRefs" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiClusterRef" } }, "apiServiceRefs" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiServiceRef" } }, "apiRoleRefs" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiRoleRef" } }, "apiHostRefs" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiHostRef" } }, "apiControlPlaneRefs" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiControlPlaneRef" } } }, "example" : { "name" : "...", "value" : "...", "apiClusterRefs" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "apiServiceRefs" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "apiRoleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTED" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPING" } ], "apiHostRefs" : [ { "hostId" : "...", "hostname" : "..." }, { "hostId" : "...", "hostname" : "..." } ], "apiControlPlaneRefs" : [ { "uuid" : "..." }, { "uuid" : "..." } ] }, "description" : "API object which groups types of entities as per the associated tag" }, "ApiTagToEntitiesList" : { "type" : "object", "title" : "ApiTagToEntitiesList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiTagToEntities" } } } } ], "example" : { "items" : [ { "name" : "...", "value" : "...", "apiClusterRefs" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "apiServiceRefs" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "apiRoleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "BUSY" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPED" } ], "apiHostRefs" : [ { "hostId" : "...", "hostname" : "..." }, { "hostId" : "...", "hostname" : "..." } ], "apiControlPlaneRefs" : [ { "uuid" : "..." }, { "uuid" : "..." } ] }, { "name" : "...", "value" : "...", "apiClusterRefs" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "apiServiceRefs" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "apiRoleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "BUSY" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTING" } ], "apiHostRefs" : [ { "hostId" : "...", "hostname" : "..." }, { "hostId" : "...", "hostname" : "..." } ], "apiControlPlaneRefs" : [ { "uuid" : "..." }, { "uuid" : "..." } ] } ] }, "description" : "A list of ApiTagEntities" }, "ApiTenantUtilization" : { "type" : "object", "title" : "ApiTenantUtilization", "properties" : { "tenantName" : { "description" : "Name of the tenant.", "type" : "string" }, "cpuUtilizationPercentage" : { "description" : "Percentage of CPU resource used by workloads.", "type" : "number" }, "memoryUtilizationPercentage" : { "description" : "Percentage of memory used by workloads.", "type" : "number" } }, "example" : { "tenantName" : "...", "cpuUtilizationPercentage" : 12345.0, "memoryUtilizationPercentage" : 12345.0 }, "description" : "Utilization report information of a tenant." }, "ApiTenantUtilizationList" : { "type" : "object", "title" : "ApiTenantUtilizationList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiTenantUtilization" } } } } ], "example" : { "items" : [ { "tenantName" : "...", "cpuUtilizationPercentage" : 12345.0, "memoryUtilizationPercentage" : 12345.0 }, { "tenantName" : "...", "cpuUtilizationPercentage" : 12345.0, "memoryUtilizationPercentage" : 12345.0 } ] }, "description" : "A list of tenant utilization reports." }, "ApiTestCmExternalAuthArguments" : { "type" : "object", "title" : "ApiTestCmExternalAuthArguments", "properties" : { "username" : { "description" : "The username used to test authentication.", "type" : "string" }, "password" : { "description" : "The password for the provided user.", "type" : "string" } }, "example" : { "username" : "...", "password" : "..." }, "description" : "" }, "ApiTimeSeries" : { "type" : "object", "title" : "ApiTimeSeries", "properties" : { "metadata" : { "description" : "Metadata for the metric.", "$ref" : "#/definitions/ApiTimeSeriesMetadata" }, "data" : { "description" : "List of metric data points.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiTimeSeriesData" } } }, "example" : { "metadata" : { "metricName" : "...", "entityName" : "...", "startTime" : "...", "endTime" : "...", "attributes" : { "property1" : "...", "property2" : "..." }, "unitNumerators" : [ "...", "..." ], "unitDenominators" : [ "...", "..." ], "expression" : "...", "alias" : "...", "metricCollectionFrequencyMs" : 12345, "rollupUsed" : "..." }, "data" : [ { "timestamp" : "...", "value" : 12345.0, "type" : "...", "aggregateStatistics" : { "sampleTime" : "...", "sampleValue" : 12345.0, "count" : 12345, "min" : 12345.0, "minTime" : "...", "max" : 12345.0, "maxTime" : "...", "mean" : 12345.0, "stdDev" : 12345.0, "crossEntityMetadata" : {} } }, { "timestamp" : "...", "value" : 12345.0, "type" : "...", "aggregateStatistics" : { "sampleTime" : "...", "sampleValue" : 12345.0, "count" : 12345, "min" : 12345.0, "minTime" : "...", "max" : 12345.0, "maxTime" : "...", "mean" : 12345.0, "stdDev" : 12345.0, "crossEntityMetadata" : {} } } ] }, "description" : "A time series represents a stream of data points.\nEach data point contains a time and a value.\nTime series are returned by executing a tsquery." }, "ApiTimeSeriesAggregateStatistics" : { "type" : "object", "title" : "ApiTimeSeriesAggregateStatistics", "properties" : { "sampleTime" : { "description" : "The timestamp of the sample data point. Note that the timestamp\nreflects coordinated universal time (UTC) and not necessarily the server's\ntime zone. The rest API formats the UTC timestamp as an ISO-8061 string.", "type" : "string" }, "sampleValue" : { "description" : "The sample data point value representing an actual sample value picked\nfrom the underlying data that is being aggregated.", "type" : "number" }, "count" : { "description" : "The number of individual data points aggregated in this data point.", "type" : "integer" }, "min" : { "description" : "This minimum value encountered while producing this aggregate data point.\nIf this is a cross-time aggregate then this is the minimum value\nencountered during the aggregation period. If this is a cross-entity\naggregate then this is the minimum value encountered across all entities.\nIf this is a cross-time, cross-entity aggregate, then this is the minimum\nvalue for any entity across the aggregation period.", "type" : "number" }, "minTime" : { "description" : "The timestamp of the minimum data point. Note that the timestamp\nreflects coordinated universal time (UTC) and not necessarily the server's\ntime zone. The rest API formats the UTC timestamp as an ISO-8061 string.", "type" : "string" }, "max" : { "description" : "This maximum value encountered while producing this aggregate data point.\nIf this is a cross-time aggregate then this is the maximum value\nencountered during the aggregation period. If this is a cross-entity\naggregate then this is the maximum value encountered across all entities.\nIf this is a cross-time, cross-entity aggregate, then this is the maximum\nvalue for any entity across the aggregation period.", "type" : "number" }, "maxTime" : { "description" : "The timestamp of the maximum data point. Note that the timestamp\nreflects coordinated universal time (UTC) and not necessarily the server's\ntime zone. The rest API formats the UTC timestamp as an ISO-8061 string.", "type" : "string" }, "mean" : { "description" : "The mean of the values of all data-points for this aggregate data point.", "type" : "number" }, "stdDev" : { "description" : "The standard deviation of the values of all data-points for this aggregate\ndata point.", "type" : "number" }, "crossEntityMetadata" : { "description" : "If the data-point is for a cross entity aggregate (e.g.,\nfd_open_across_datanodes) returns the cross entity metadata, null otherwise.", "$ref" : "#/definitions/ApiTimeSeriesCrossEntityMetadata" } }, "example" : { "sampleTime" : "...", "sampleValue" : 12345.0, "count" : 12345, "min" : 12345.0, "minTime" : "...", "max" : 12345.0, "maxTime" : "...", "mean" : 12345.0, "stdDev" : 12345.0, "crossEntityMetadata" : { "maxEntityDisplayName" : "...", "maxEntityName" : "...", "minEntityDisplayName" : "...", "minEntityName" : "...", "numEntities" : 12345.0 } }, "description" : "Statistics related to one time series aggregate data point. It is\navailable from v6 for data points containing aggregate data. It includes\nfurther statistics about the data point. An aggregate can be across\nentities (e.g., fd_open_across_datanodes), over time (e.g., a daily point\nfor the fd_open metric for a specific DataNode), or both (e.g., a daily\npoint for the fd_open_across_datanodes metric). If the data point is for\nnon-aggregate date this will return null." }, "ApiTimeSeriesCrossEntityMetadata" : { "type" : "object", "title" : "ApiTimeSeriesCrossEntityMetadata", "required" : [ "numEntities" ], "properties" : { "maxEntityDisplayName" : { "description" : "The display name of the entity that had the maximum value for the\ncross-entity aggregate metric.", "type" : "string" }, "maxEntityName" : { "description" : "The name of the entity that had the maximum value for the\ncross-entity aggregate metric.\n\nAvailable since API v11.", "type" : "string" }, "minEntityDisplayName" : { "description" : "The display name of the entity that had the minimum value for the\ncross-entity aggregate metric.", "type" : "string" }, "minEntityName" : { "description" : "The name of the entity that had the minimum value for the\ncross-entity aggregate metric.\n
\nAvailable since API v11.", "type" : "string" }, "numEntities" : { "description" : "The number of entities covered by this point. For a raw cross-entity point\nthis number is exact. For a rollup point this number is an average, since\nthe number of entities being aggregated can change over the aggregation\nperiod.", "type" : "number" } }, "example" : { "maxEntityDisplayName" : "...", "maxEntityName" : "...", "minEntityDisplayName" : "...", "minEntityName" : "...", "numEntities" : 12345.0 }, "description" : "A class holding additional metadata to the ApiTimeSeriesAggregateStatistics\nclass that applies specifically to cross-entity aggregate metrics." }, "ApiTimeSeriesData" : { "type" : "object", "title" : "ApiTimeSeriesData", "properties" : { "timestamp" : { "description" : "The timestamp for this time series data point. Note that the timestamp\nreflects coordinated universal time (UTC) and not necessarily the server's\ntime zone. The rest API formats the UTC timestamp as an ISO-8061 string.", "type" : "string" }, "value" : { "description" : "The value of the time series data.", "type" : "number" }, "type" : { "description" : "The type of the time series data.", "type" : "string" }, "aggregateStatistics" : { "description" : "Available from v6 for data points containing aggregate data. It includes\nfurther statistics about the data point. An aggregate can be across\nentities (e.g., fd_open_across_datanodes), over time (e.g., a daily point\nfor the fd_open metric for a specific DataNode), or both (e.g., a daily\npoint for the fd_open_across_datanodes metric). If the data point is for\nnon-aggregate date this will return null.", "$ref" : "#/definitions/ApiTimeSeriesAggregateStatistics" } }, "example" : { "timestamp" : "...", "value" : 12345.0, "type" : "...", "aggregateStatistics" : { "sampleTime" : "...", "sampleValue" : 12345.0, "count" : 12345, "min" : 12345.0, "minTime" : "...", "max" : 12345.0, "maxTime" : "...", "mean" : 12345.0, "stdDev" : 12345.0, "crossEntityMetadata" : { "maxEntityDisplayName" : "...", "maxEntityName" : "...", "minEntityDisplayName" : "...", "minEntityName" : "...", "numEntities" : 12345.0 } } }, "description" : "A single data point of time series data." }, "ApiTimeSeriesEntityAttribute" : { "type" : "object", "title" : "ApiTimeSeriesEntityAttribute", "properties" : { "name" : { "description" : "Name of the of the attribute.\nThis name uniquely identifies this attribute.", "type" : "string" }, "displayName" : { "description" : "Display name of the attribute.", "type" : "string" }, "description" : { "description" : "Description of the attribute.", "type" : "string" }, "isValueCaseSensitive" : { "description" : "Returns whether to treat attribute values as case-sensitive. Defaults to false.", "type" : "boolean" } }, "example" : { "name" : "...", "displayName" : "...", "description" : "...", "isValueCaseSensitive" : true }, "description" : "A time series entity attribute represents a possible attribute of a time\nseries entity type monitored by the Cloudera Management Services.\n
\nAvailable since API v11." }, "ApiTimeSeriesEntityAttributeList" : { "type" : "object", "title" : "ApiTimeSeriesEntityAttributeList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiTimeSeriesEntityAttribute" } } } } ], "example" : { "items" : [ { "name" : "...", "displayName" : "...", "description" : "...", "isValueCaseSensitive" : true }, { "name" : "...", "displayName" : "...", "description" : "...", "isValueCaseSensitive" : true } ] }, "description" : "A list of ApiTimeSeriesEntityAttribute objects" }, "ApiTimeSeriesEntityType" : { "type" : "object", "title" : "ApiTimeSeriesEntityType", "properties" : { "name" : { "description" : "Returns the name of the entity type. This name uniquely identifies this\nentity type.", "type" : "string" }, "category" : { "description" : "Returns the category of the entity type.", "type" : "string" }, "nameForCrossEntityAggregateMetrics" : { "description" : "Returns the string to use to pluralize the name of the entity for cross\nentity aggregate metrics.", "type" : "string" }, "displayName" : { "description" : "Returns the display name of the entity type.", "type" : "string" }, "description" : { "description" : "Returns the description of the entity type.", "type" : "string" }, "immutableAttributeNames" : { "description" : "Returns the list of immutable attributes for this entity type. Immutable\nattributes values for an entity may not change over its lifetime.", "type" : "array", "items" : { "type" : "string" } }, "mutableAttributeNames" : { "description" : "Returns the list of mutable attributes for this entity type. Mutable\nattributes for an entity may change over its lifetime.", "type" : "array", "items" : { "type" : "string" } }, "entityNameFormat" : { "description" : "Returns a list of attribute names that will be used to construct entity\nnames for entities of this type. The attributes named here must be immutable\nattributes of this type or a parent type.", "type" : "array", "items" : { "type" : "string" } }, "entityDisplayNameFormat" : { "description" : "Returns a format string that will be used to construct the display name of\nentities of this type. If this returns null the entity name would be used\nas the display name.\n\nThe entity attribute values are used to replace $attribute name portions of\nthis format string. For example, an entity with roleType \"DATANODE\" and\nhostname \"foo.com\" will have a display name \"DATANODE (foo.com)\" if the\nformat is \"$roleType ($hostname)\".", "type" : "string" }, "parentMetricEntityTypeNames" : { "description" : "Returns a list of metric entity type names which are parents of this\nmetric entity type. A metric entity type inherits the attributes of\nits ancestors. For example a role metric entity type has its service as a\nparent. A service metric entity type has a cluster as a parent. The role\ntype inherits its cluster name attribute through its service parent. Only\nparent ancestors should be returned here. In the example given, only the\nservice metric entity type should be specified in the parent list.", "type" : "array", "items" : { "type" : "string" } } }, "example" : { "name" : "...", "category" : "...", "nameForCrossEntityAggregateMetrics" : "...", "displayName" : "...", "description" : "...", "immutableAttributeNames" : [ "...", "..." ], "mutableAttributeNames" : [ "...", "..." ], "entityNameFormat" : [ "...", "..." ], "entityDisplayNameFormat" : "...", "parentMetricEntityTypeNames" : [ "...", "..." ] }, "description" : "Describe a time series entity type and attributes associated with\nthis entity type.\n
\nAvailable since API v11." }, "ApiTimeSeriesEntityTypeList" : { "type" : "object", "title" : "ApiTimeSeriesEntityTypeList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiTimeSeriesEntityType" } } } } ], "example" : { "items" : [ { "name" : "...", "category" : "...", "nameForCrossEntityAggregateMetrics" : "...", "displayName" : "...", "description" : "...", "immutableAttributeNames" : [ "...", "..." ], "mutableAttributeNames" : [ "...", "..." ], "entityNameFormat" : [ "...", "..." ], "entityDisplayNameFormat" : "...", "parentMetricEntityTypeNames" : [ "...", "..." ] }, { "name" : "...", "category" : "...", "nameForCrossEntityAggregateMetrics" : "...", "displayName" : "...", "description" : "...", "immutableAttributeNames" : [ "...", "..." ], "mutableAttributeNames" : [ "...", "..." ], "entityNameFormat" : [ "...", "..." ], "entityDisplayNameFormat" : "...", "parentMetricEntityTypeNames" : [ "...", "..." ] } ] }, "description" : "A list of ApiTimeSeriesEntityType objects" }, "ApiTimeSeriesMetadata" : { "type" : "object", "title" : "ApiTimeSeriesMetadata", "properties" : { "metricName" : { "description" : "The metric name for the time series.", "type" : "string" }, "entityName" : { "description" : "The display name for the entity associated with this time series.\nFor example, if this was a time series for an HDFS service the entity name\nmight be something like \"My HDFS Service\". If it was for a host it might\nbe something like \"myhost.mysite.com\".", "type" : "string" }, "startTime" : { "description" : "The start time for the time series.", "type" : "string" }, "endTime" : { "description" : "The end time for the time series.", "type" : "string" }, "attributes" : { "description" : "The attributes for the time series. Note that the entityName entry in\nthis map is not the same as the entityName field in this\nApiTimeSeriesMetadata. The entityName entry in this map is a unique\nidentifier for the entity and not the name displayed in the UI.\n\nFor example, if this was a time series for the YARN Job History Server\nthe entityName entry in this map might be something like\n\"yarn-JOBHISTORY-6bd17ceb1489aae93fef4c867350d0dd\"", "type" : "object", "additionalProperties" : { "type" : "string" } }, "unitNumerators" : { "description" : "The numerators of the units for the time series.", "type" : "array", "items" : { "type" : "string" } }, "unitDenominators" : { "description" : "The denominators of the units for the time series.", "type" : "array", "items" : { "type" : "string" } }, "expression" : { "description" : "The tsquery expression that could be used to extract just this stream.", "type" : "string" }, "alias" : { "description" : "The alias for this stream's metric. Aliases correspond to use of the 'as'\nkeyword in the tsquery.", "type" : "string" }, "metricCollectionFrequencyMs" : { "description" : "The minimum frequency at which the underlying metric for this stream is\ncollected. Note that this can be null if the stream returns irregularly\nsampled data.", "type" : "integer" }, "rollupUsed" : { "description" : "The aggregate rollup for the returned data. This can be TEN_MINUTELY,\nHOURLY, SIX_HOURLY, DAILY, or WEEKLY.", "type" : "string" } }, "example" : { "metricName" : "...", "entityName" : "...", "startTime" : "...", "endTime" : "...", "attributes" : { "property1" : "...", "property2" : "..." }, "unitNumerators" : [ "...", "..." ], "unitDenominators" : [ "...", "..." ], "expression" : "...", "alias" : "...", "metricCollectionFrequencyMs" : 12345, "rollupUsed" : "..." }, "description" : "Metadata for a time series." }, "ApiTimeSeriesRequest" : { "type" : "object", "title" : "ApiTimeSeriesRequest", "properties" : { "query" : { "description" : "tsquery to run against the CM time-series data store.\nPlease see the \ntsquery language documentation.
", "type" : "string" }, "from" : { "description" : "Start of the period to query in ISO 8601 format (defaults to 5 minutes\nbefore the end of the period).", "type" : "string" }, "to" : { "description" : "End of the period to query in ISO 8601 format (defaults to current time).", "type" : "string" }, "contentType" : { "description" : "contentType to return the response in. The content types \"application/json\"\nand \"text/csv\" are supported. This defaults to \"application/json\". If\n\"text/csv\" is specified then we return one row per time series data point,\nand we don't return any of the metadata.", "type" : "string" }, "desiredRollup" : { "description" : "Aggregate rollup level desired for the response data.\nValid values are RAW, TEN_MINUTELY, HOURLY, SIX_HOURLY, DAILY, and WEEKLY.\nNote that if the mustUseDesiredRollup parameter is not set, then the\nmonitoring server can decide to return a different rollup level.", "type" : "string" }, "mustUseDesiredRollup" : { "description" : "If set to true, then the tsquery will return data with the desired\naggregate rollup level.", "type" : "boolean" } }, "example" : { "query" : "...", "from" : "...", "to" : "...", "contentType" : "...", "desiredRollup" : "...", "mustUseDesiredRollup" : true }, "description" : "Request object containing information needed for querying timeseries data.\n\nAvailable since API v11." }, "ApiTimeSeriesResponse" : { "type" : "object", "title" : "ApiTimeSeriesResponse", "properties" : { "timeSeries" : { "description" : "The time series data for this single query response.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiTimeSeries" } }, "warnings" : { "description" : "The warnings for this single query response.", "type" : "array", "items" : { "type" : "string" } }, "timeSeriesQuery" : { "description" : "The query for this single query response.", "type" : "string" } }, "example" : { "timeSeries" : [ { "metadata" : { "metricName" : "...", "entityName" : "...", "startTime" : "...", "endTime" : "...", "attributes" : { "property1" : "...", "property2" : "..." }, "unitNumerators" : [ "...", "..." ], "unitDenominators" : [ "...", "..." ], "expression" : "...", "alias" : "...", "metricCollectionFrequencyMs" : 12345, "rollupUsed" : "..." }, "data" : [ { "timestamp" : "...", "value" : 12345.0, "type" : "...", "aggregateStatistics" : {} }, { "timestamp" : "...", "value" : 12345.0, "type" : "...", "aggregateStatistics" : {} } ] }, { "metadata" : { "metricName" : "...", "entityName" : "...", "startTime" : "...", "endTime" : "...", "attributes" : { "property1" : "...", "property2" : "..." }, "unitNumerators" : [ "...", "..." ], "unitDenominators" : [ "...", "..." ], "expression" : "...", "alias" : "...", "metricCollectionFrequencyMs" : 12345, "rollupUsed" : "..." }, "data" : [ { "timestamp" : "...", "value" : 12345.0, "type" : "...", "aggregateStatistics" : {} }, { "timestamp" : "...", "value" : 12345.0, "type" : "...", "aggregateStatistics" : {} } ] } ], "warnings" : [ "...", "..." ], "timeSeriesQuery" : "..." }, "description" : "The time series response for a time series query." }, "ApiTimeSeriesResponseList" : { "type" : "object", "title" : "ApiTimeSeriesResponseList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "The list of responses for this query response list.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiTimeSeriesResponse" } } } } ], "example" : { "items" : [ { "timeSeries" : [ { "metadata" : {}, "data" : [ {}, {} ] }, { "metadata" : {}, "data" : [ {}, {} ] } ], "warnings" : [ "...", "..." ], "timeSeriesQuery" : "..." }, { "timeSeries" : [ { "metadata" : {}, "data" : [ {}, {} ] }, { "metadata" : {}, "data" : [ {}, {} ] } ], "warnings" : [ "...", "..." ], "timeSeriesQuery" : "..." } ] }, "description" : "A generic list." }, "ApiUninstallControlPlaneArgs" : { "type" : "object", "title" : "ApiUninstallControlPlaneArgs", "properties" : { "kubeConfig" : { "description" : "The content of the kubeconfig file of the kubernetes environment on which the control plane is running\nSimplified example:\nPasswords are not returned when querying user information, so this\nproperty will always be empty when reading information from a server.", "type" : "string" }, "roles" : { "description" : "A list of roles this user belongs to.\n
\nIn Cloudera Express, possible values are:\n
\nNote that although this interface provides a list of roles, a user should\nonly be assigned a single role at a time.", "type" : "array", "items" : { "type" : "string" } }, "pwHash" : { "description" : "NOTE: Only available in the \"export\" view", "type" : "string" }, "pwSalt" : { "description" : "NOTE: Only available in the \"export\" view", "type" : "integer" }, "pwLogin" : { "description" : "NOTE: Only available in the \"export\" view", "type" : "boolean" } }, "example" : { "name" : "...", "password" : "...", "roles" : [ "...", "..." ], "pwHash" : "...", "pwSalt" : 12345, "pwLogin" : true }, "description" : "This is the model for user information in the API prior to v18. Post v18,\nplease refer to ApiUser2.java.\n
\nNote that any method that returns user information will not contain any\npassword information. The password property is only used when creating\nor updating users." }, "ApiUser2" : { "type" : "object", "title" : "ApiUser2", "properties" : { "name" : { "description" : "The username, which is unique within a Cloudera Manager installation.", "type" : "string" }, "password" : { "description" : "Returns the user password.\n
\nPasswords are not returned when querying user information, so this\nproperty will always be empty when reading information from a server.", "type" : "string" }, "authRoles" : { "description" : "A list of ApiAuthRole that this user possesses.", "type" : "array", "items" : { "$ref" : "#/definitions/ApiAuthRoleRef" } }, "pwHash" : { "description" : "NOTE: Only available in the \"export\" view", "type" : "string" }, "pwSalt" : { "description" : "NOTE: Only available in the \"export\" view", "type" : "integer" }, "pwLogin" : { "description" : "NOTE: Only available in the \"export\" view", "type" : "boolean" } }, "example" : { "name" : "...", "password" : "...", "authRoles" : [ { "displayName" : "...", "name" : "...", "uuid" : "..." }, { "displayName" : "...", "name" : "...", "uuid" : "..." } ], "pwHash" : "...", "pwSalt" : 12345, "pwLogin" : true }, "description" : "This is the model for user information in the API, v18 and beyond.\n
\nNote that any method that returns user information will not contain any\npassword information. The password property is only used when creating\nor updating users." }, "ApiUser2List" : { "type" : "object", "title" : "ApiUser2List", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiUser2" } } } } ], "example" : { "items" : [ { "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 } ] }, "description" : "A list of users." }, "ApiUser2Ref" : { "type" : "object", "title" : "ApiUser2Ref", "properties" : { "name" : { "description" : "The name of the user, which uniquely identifies it in a CM installation.", "type" : "string" } }, "example" : { "name" : "..." }, "description" : "A userRef references a user." }, "ApiUserList" : { "type" : "object", "title" : "ApiUserList", "allOf" : [ { "$ref" : "#/definitions/ApiListBase" }, { "properties" : { "items" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiUser" } } } } ], "example" : { "items" : [ { "name" : "...", "password" : "...", "roles" : [ "...", "..." ], "pwHash" : "...", "pwSalt" : 12345, "pwLogin" : true }, { "name" : "...", "password" : "...", "roles" : [ "...", "..." ], "pwHash" : "...", "pwSalt" : 12345, "pwLogin" : true } ] }, "description" : "A list of users." }, "ApiUserSession" : { "type" : "object", "title" : "ApiUserSession", "properties" : { "name" : { "description" : "The username associated with the session.\n
\nThis will be the same value shown to the logged in user in the UI, which\nwill normally be the same value they typed when logging in, but it is\npossible that in certain external authentication scenarios, it will differ\nfrom that value.", "type" : "string" }, "remoteAddr" : { "description" : "The remote IP address for the session.\n
\nThis will be the remote IP address for the last request made as part of\nthis session. It is not guaranteed to be the same IP address as was\npreviously used, or the address used to initiate the session.", "type" : "string" }, "lastRequest" : { "description" : "The date and time of the last request received as part of this session.\n
\nThis will be returned in ISO 8601 format from the REST API.", "type" : "string" } }, "example" : { "name" : "...", "remoteAddr" : "...", "lastRequest" : "..." }, "description" : "This is the model for interactive user session information in the API.\n
\nA user may have more than one active session. Each such session will have\nits own session object."
},
"ApiUserSessionList" : {
"type" : "object",
"title" : "ApiUserSessionList",
"allOf" : [
{
"$ref" : "#/definitions/ApiListBase"
},
{
"properties" : {
"items" : {
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/definitions/ApiUserSession"
}
}
}
}
],
"example" : {
"items" : [
{
"name" : "...",
"remoteAddr" : "...",
"lastRequest" : "..."
},
{
"name" : "...",
"remoteAddr" : "...",
"lastRequest" : "..."
}
]
},
"description" : "A list of user sessions."
},
"ApiVersionInfo" : {
"type" : "object",
"title" : "ApiVersionInfo",
"properties" : {
"version" : {
"description" : "Version.",
"type" : "string"
},
"snapshot" : {
"description" : "Whether this build is a development snapshot.",
"type" : "boolean"
},
"buildUser" : {
"description" : "The user performing the build.",
"type" : "string"
},
"buildTimestamp" : {
"description" : "Build timestamp.",
"type" : "string"
},
"gitHash" : {
"description" : "Source control management hash.",
"type" : "string"
}
},
"example" : {
"version" : "...",
"snapshot" : true,
"buildUser" : "...",
"buildTimestamp" : "...",
"gitHash" : "..."
},
"description" : "Version information of Cloudera Manager itself."
},
"ApiWatchedDir" : {
"type" : "object",
"title" : "ApiWatchedDir",
"properties" : {
"path" : {
"description" : "",
"type" : "string"
}
},
"example" : {
"path" : "..."
},
"description" : ""
},
"ApiWatchedDirList" : {
"type" : "object",
"title" : "ApiWatchedDirList",
"allOf" : [
{
"$ref" : "#/definitions/ApiListBase"
},
{
"properties" : {
"items" : {
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/definitions/ApiWatchedDir"
}
}
}
}
],
"example" : {
"items" : [
{
"path" : "..."
},
{
"path" : "..."
}
]
},
"description" : "A list of watched directories."
},
"ApiYarnApplication" : {
"type" : "object",
"title" : "ApiYarnApplication",
"properties" : {
"allocatedMB" : {
"description" : "The sum of memory in MB allocated to the application's running containers\nAvailable since v12.",
"type" : "integer"
},
"allocatedVCores" : {
"description" : "The sum of virtual cores allocated to the application's running containers\nAvailable since v12.",
"type" : "integer"
},
"runningContainers" : {
"description" : "The number of containers currently running for the application\nAvailable since v12.",
"type" : "integer"
},
"applicationTags" : {
"description" : "List of YARN application tags. Available since v12.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"allocatedMemorySeconds" : {
"description" : "Allocated memory to the application in units of mb-secs.\nAvailable since v12.",
"type" : "integer"
},
"allocatedVcoreSeconds" : {
"description" : "Allocated vcore-secs to the application. Available since v12.",
"type" : "integer"
},
"applicationId" : {
"description" : "The application id.",
"type" : "string"
},
"name" : {
"description" : "The name of the application.",
"type" : "string"
},
"startTime" : {
"description" : "The time the application was submitted.",
"type" : "string"
},
"endTime" : {
"description" : "The time the application finished. If the application hasn't finished\nthis will return null.",
"type" : "string"
},
"user" : {
"description" : "The user who submitted the application.",
"type" : "string"
},
"pool" : {
"description" : "The pool the application was submitted to.",
"type" : "string"
},
"progress" : {
"description" : "The progress, as a percentage, the application has made. This is only\nset if the application is currently executing.",
"type" : "number"
},
"attributes" : {
"description" : "A map of additional application attributes which is generated by\nCloudera Manager. For example MR2 job counters are exposed as key/value\npairs here. For more details see the Cloudera Manager documentation.",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"mr2AppInformation" : {
"description" : "",
"$ref" : "#/definitions/ApiMr2AppInformation"
},
"state" : {
"description" : "",
"type" : "string"
},
"containerUsedMemorySeconds" : {
"description" : "Actual memory (in MB-secs) used by containers launched by the YARN application.\nComputed by running a MapReduce job from Cloudera Service Monitor to\naggregate YARN usage metrics.\nAvailable since v12.",
"type" : "number"
},
"containerUsedMemoryMax" : {
"description" : "Maximum memory used by containers launched by the YARN application.\nComputed by running a MapReduce job from Cloudera Service Monitor to\naggregate YARN usage metrics\nAvailable since v16",
"type" : "number"
},
"containerUsedCpuSeconds" : {
"description" : "Actual CPU (in percent-secs) used by containers launched by the YARN application.\nComputed by running a MapReduce job from Cloudera Service Monitor to\naggregate YARN usage metrics.\nAvailable since v12.",
"type" : "number"
},
"containerUsedVcoreSeconds" : {
"description" : "Actual VCore-secs used by containers launched by the YARN application.\nComputed by running a MapReduce job from Cloudera Service Monitor to\naggregate YARN usage metrics.\nAvailable since v12.",
"type" : "number"
},
"containerAllocatedMemorySeconds" : {
"description" : "Total memory (in mb-secs) allocated to containers launched by the YARN application.\nComputed by running a MapReduce job from Cloudera Service Monitor to\naggregate YARN usage metrics.\nAvailable since v12.",
"type" : "number"
},
"containerAllocatedVcoreSeconds" : {
"description" : "Total vcore-secs allocated to containers launched by the YARN application.\nComputed by running a MapReduce job from Cloudera Service Monitor to\naggregate YARN usage metrics.\nAvailable since v12.",
"type" : "number"
}
},
"example" : {
"allocatedMB" : 12345,
"allocatedVCores" : 12345,
"runningContainers" : 12345,
"applicationTags" : [
"...",
"..."
],
"allocatedMemorySeconds" : 12345,
"allocatedVcoreSeconds" : 12345,
"applicationId" : "...",
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"user" : "...",
"pool" : "...",
"progress" : 12345.0,
"attributes" : {
"property1" : "...",
"property2" : "..."
},
"mr2AppInformation" : {
"jobState" : "..."
},
"state" : "...",
"containerUsedMemorySeconds" : 12345.0,
"containerUsedMemoryMax" : 12345.0,
"containerUsedCpuSeconds" : 12345.0,
"containerUsedVcoreSeconds" : 12345.0,
"containerAllocatedMemorySeconds" : 12345.0,
"containerAllocatedVcoreSeconds" : 12345.0
},
"description" : "Represents a Yarn application"
},
"ApiYarnApplicationAttribute" : {
"type" : "object",
"title" : "ApiYarnApplicationAttribute",
"properties" : {
"name" : {
"description" : "The name of the attribute. This name can be used in filters, for example\n'user' could be used in the filter 'user = root'.",
"type" : "string"
},
"type" : {
"description" : "The type of the attribute. Valid types are STRING, NUMBER, BOOLEAN, BYTES,\nMILLISECONDS, BYTES_PER_SECOND, BYTE_SECONDS.",
"type" : "string"
},
"displayName" : {
"description" : "The display name for the attribute.",
"type" : "string"
},
"supportsHistograms" : {
"description" : "Whether the Service Monitor can generate a histogram of the distribution\nof the attribute across applications.",
"type" : "boolean"
},
"description" : {
"description" : "The description of the attribute.",
"type" : "string"
}
},
"example" : {
"name" : "...",
"type" : "...",
"displayName" : "...",
"supportsHistograms" : true,
"description" : "..."
},
"description" : "Metadata about a YARN application attribute."
},
"ApiYarnApplicationAttributeList" : {
"type" : "object",
"title" : "ApiYarnApplicationAttributeList",
"allOf" : [
{
"$ref" : "#/definitions/ApiListBase"
},
{
"properties" : {
"items" : {
"description" : "The list of attributes.",
"type" : "array",
"items" : {
"$ref" : "#/definitions/ApiYarnApplicationAttribute"
}
}
}
}
],
"example" : {
"items" : [
{
"name" : "...",
"type" : "...",
"displayName" : "...",
"supportsHistograms" : true,
"description" : "..."
},
{
"name" : "...",
"type" : "...",
"displayName" : "...",
"supportsHistograms" : true,
"description" : "..."
}
]
},
"description" : "The list of all attributes that are applicable to YARN applications."
},
"ApiYarnApplicationDiagnosticsCollectionArgs" : {
"type" : "object",
"title" : "ApiYarnApplicationDiagnosticsCollectionArgs",
"properties" : {
"applicationIds" : {
"description" : "Id's of the applications whose diagnostics data has to be collected",
"type" : "array",
"items" : {
"type" : "string"
}
},
"ticketNumber" : {
"description" : "Ticket Number of the Cloudera Support Ticket",
"type" : "string"
},
"comments" : {
"description" : "Comments to add to the support bundle",
"type" : "string"
}
},
"example" : {
"applicationIds" : [
"...",
"..."
],
"ticketNumber" : "...",
"comments" : "..."
},
"description" : "Arguments used for collecting diagnostics data for Yarn applications"
},
"ApiYarnApplicationResponse" : {
"type" : "object",
"title" : "ApiYarnApplicationResponse",
"properties" : {
"applications" : {
"description" : "The list of applications for this response.",
"type" : "array",
"items" : {
"$ref" : "#/definitions/ApiYarnApplication"
}
},
"warnings" : {
"description" : "This list of warnings for this response.",
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"example" : {
"applications" : [
{
"allocatedMB" : 12345,
"allocatedVCores" : 12345,
"runningContainers" : 12345,
"applicationTags" : [
"...",
"..."
],
"allocatedMemorySeconds" : 12345,
"allocatedVcoreSeconds" : 12345,
"applicationId" : "...",
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"user" : "...",
"pool" : "...",
"progress" : 12345.0,
"attributes" : {
"property1" : "...",
"property2" : "..."
},
"mr2AppInformation" : {
"jobState" : "..."
},
"state" : "...",
"containerUsedMemorySeconds" : 12345.0,
"containerUsedMemoryMax" : 12345.0,
"containerUsedCpuSeconds" : 12345.0,
"containerUsedVcoreSeconds" : 12345.0,
"containerAllocatedMemorySeconds" : 12345.0,
"containerAllocatedVcoreSeconds" : 12345.0
},
{
"allocatedMB" : 12345,
"allocatedVCores" : 12345,
"runningContainers" : 12345,
"applicationTags" : [
"...",
"..."
],
"allocatedMemorySeconds" : 12345,
"allocatedVcoreSeconds" : 12345,
"applicationId" : "...",
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"user" : "...",
"pool" : "...",
"progress" : 12345.0,
"attributes" : {
"property1" : "...",
"property2" : "..."
},
"mr2AppInformation" : {
"jobState" : "..."
},
"state" : "...",
"containerUsedMemorySeconds" : 12345.0,
"containerUsedMemoryMax" : 12345.0,
"containerUsedCpuSeconds" : 12345.0,
"containerUsedVcoreSeconds" : 12345.0,
"containerAllocatedMemorySeconds" : 12345.0,
"containerAllocatedVcoreSeconds" : 12345.0
}
],
"warnings" : [
"...",
"..."
]
},
"description" : "The response contains a list of applications and warnings."
},
"ApiYarnKillResponse" : {
"type" : "object",
"title" : "ApiYarnKillResponse",
"properties" : {
"warning" : {
"description" : "The warning, if any, from the call. We will return a warning if the caller\nattempts to cancel an application that has already completed.",
"type" : "string"
}
},
"example" : {
"warning" : "..."
},
"description" : "The response from an Yarn kill application response."
},
"ApiYarnTenantUtilization" : {
"type" : "object",
"title" : "ApiYarnTenantUtilization",
"properties" : {
"tenantName" : {
"description" : "Name of the tenant.",
"type" : "string"
},
"avgYarnCpuAllocation" : {
"description" : "Average number of VCores allocated to YARN applications of the tenant.",
"type" : "number"
},
"avgYarnCpuUtilization" : {
"description" : "Average number of VCores used by YARN applications of the tenant.",
"type" : "number"
},
"avgYarnCpuUnusedCapacity" : {
"description" : "Average unused VCores of the tenant.",
"type" : "number"
},
"avgYarnCpuSteadyFairShare" : {
"description" : "Average steady fair share VCores.",
"type" : "number"
},
"avgYarnPoolAllocatedCpuDuringContention" : {
"description" : "Average allocated Vcores with pending containers.",
"type" : "number"
},
"avgYarnPoolFairShareCpuDuringContention" : {
"description" : "Average fair share VCores with pending containers.",
"type" : "number"
},
"avgYarnPoolSteadyFairShareCpuDuringContention" : {
"description" : "Average steady fair share VCores with pending containers.",
"type" : "number"
},
"avgYarnContainerWaitRatio" : {
"description" : "Average percentage of pending containers for the pool during periods of\ncontention.",
"type" : "number"
},
"avgYarnMemoryAllocation" : {
"description" : "Average memory allocated to YARN applications of the tenant.",
"type" : "number"
},
"avgYarnMemoryUtilization" : {
"description" : "Average memory used by YARN applications of the tenant.",
"type" : "number"
},
"avgYarnMemoryUnusedCapacity" : {
"description" : "Average unused memory of the tenant.",
"type" : "number"
},
"avgYarnMemorySteadyFairShare" : {
"description" : "Average steady fair share memory.",
"type" : "number"
},
"avgYarnPoolAllocatedMemoryDuringContention" : {
"description" : "Average allocated memory with pending containers.",
"type" : "number"
},
"avgYarnPoolFairShareMemoryDuringContention" : {
"description" : "Average fair share memory with pending containers.",
"type" : "number"
},
"avgYarnPoolSteadyFairShareMemoryDuringContention" : {
"description" : "Average steady fair share memory with pending containers.",
"type" : "number"
}
},
"example" : {
"tenantName" : "...",
"avgYarnCpuAllocation" : 12345.0,
"avgYarnCpuUtilization" : 12345.0,
"avgYarnCpuUnusedCapacity" : 12345.0,
"avgYarnCpuSteadyFairShare" : 12345.0,
"avgYarnPoolAllocatedCpuDuringContention" : 12345.0,
"avgYarnPoolFairShareCpuDuringContention" : 12345.0,
"avgYarnPoolSteadyFairShareCpuDuringContention" : 12345.0,
"avgYarnContainerWaitRatio" : 12345.0,
"avgYarnMemoryAllocation" : 12345.0,
"avgYarnMemoryUtilization" : 12345.0,
"avgYarnMemoryUnusedCapacity" : 12345.0,
"avgYarnMemorySteadyFairShare" : 12345.0,
"avgYarnPoolAllocatedMemoryDuringContention" : 12345.0,
"avgYarnPoolFairShareMemoryDuringContention" : 12345.0,
"avgYarnPoolSteadyFairShareMemoryDuringContention" : 12345.0
},
"description" : "Utilization report information of a tenant of Yarn application."
},
"ApiYarnTenantUtilizationList" : {
"type" : "object",
"title" : "ApiYarnTenantUtilizationList",
"allOf" : [
{
"$ref" : "#/definitions/ApiListBase"
},
{
"properties" : {
"items" : {
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/definitions/ApiYarnTenantUtilization"
}
}
}
}
],
"example" : {
"items" : [
{
"tenantName" : "...",
"avgYarnCpuAllocation" : 12345.0,
"avgYarnCpuUtilization" : 12345.0,
"avgYarnCpuUnusedCapacity" : 12345.0,
"avgYarnCpuSteadyFairShare" : 12345.0,
"avgYarnPoolAllocatedCpuDuringContention" : 12345.0,
"avgYarnPoolFairShareCpuDuringContention" : 12345.0,
"avgYarnPoolSteadyFairShareCpuDuringContention" : 12345.0,
"avgYarnContainerWaitRatio" : 12345.0,
"avgYarnMemoryAllocation" : 12345.0,
"avgYarnMemoryUtilization" : 12345.0,
"avgYarnMemoryUnusedCapacity" : 12345.0,
"avgYarnMemorySteadyFairShare" : 12345.0,
"avgYarnPoolAllocatedMemoryDuringContention" : 12345.0,
"avgYarnPoolFairShareMemoryDuringContention" : 12345.0,
"avgYarnPoolSteadyFairShareMemoryDuringContention" : 12345.0
},
{
"tenantName" : "...",
"avgYarnCpuAllocation" : 12345.0,
"avgYarnCpuUtilization" : 12345.0,
"avgYarnCpuUnusedCapacity" : 12345.0,
"avgYarnCpuSteadyFairShare" : 12345.0,
"avgYarnPoolAllocatedCpuDuringContention" : 12345.0,
"avgYarnPoolFairShareCpuDuringContention" : 12345.0,
"avgYarnPoolSteadyFairShareCpuDuringContention" : 12345.0,
"avgYarnContainerWaitRatio" : 12345.0,
"avgYarnMemoryAllocation" : 12345.0,
"avgYarnMemoryUtilization" : 12345.0,
"avgYarnMemoryUnusedCapacity" : 12345.0,
"avgYarnMemorySteadyFairShare" : 12345.0,
"avgYarnPoolAllocatedMemoryDuringContention" : 12345.0,
"avgYarnPoolFairShareMemoryDuringContention" : 12345.0,
"avgYarnPoolSteadyFairShareMemoryDuringContention" : 12345.0
}
]
},
"description" : "A list of yarn tenant utilization reports."
},
"ApiYarnUtilization" : {
"type" : "object",
"title" : "ApiYarnUtilization",
"properties" : {
"avgCpuUtilization" : {
"description" : "Average number of VCores used by YARN applications during the report\nwindow.",
"type" : "number"
},
"maxCpuUtilization" : {
"description" : "Maximum number of VCores used by YARN applications during the report\nwindow.",
"type" : "number"
},
"avgCpuDailyPeak" : {
"description" : "Average daily peak VCores used by YARN applications during the report\nwindow. The number is computed by first finding the maximum resource\nconsumption per day and then taking their mean.",
"type" : "number"
},
"maxCpuUtilizationTimestampMs" : {
"description" : "Timestamp corresponds to maximum number of VCores used by YARN applications\nduring the report window.",
"type" : "integer"
},
"avgCpuUtilizationPercentage" : {
"description" : "Average percentage of VCores used by YARN applications during the report\nwindow.",
"type" : "number"
},
"maxCpuUtilizationPercentage" : {
"description" : "Maximum percentage of VCores used by YARN applications during the report\nwindow.",
"type" : "number"
},
"avgCpuDailyPeakPercentage" : {
"description" : "Average daily peak percentage of VCores used by YARN applications during\nthe report window.",
"type" : "number"
},
"avgMemoryUtilization" : {
"description" : "Average memory used by YARN applications during the report window.",
"type" : "number"
},
"maxMemoryUtilization" : {
"description" : "Maximum memory used by YARN applications during the report window.",
"type" : "number"
},
"avgMemoryDailyPeak" : {
"description" : "Average daily peak memory used by YARN applications during the report\nwindow. The number is computed by first finding the maximum resource\nconsumption per day and then taking their mean.",
"type" : "number"
},
"maxMemoryUtilizationTimestampMs" : {
"description" : "Timestamp corresponds to maximum memory used by YARN applications during\nthe report window.",
"type" : "integer"
},
"avgMemoryUtilizationPercentage" : {
"description" : "Average percentage memory used by YARN applications during the report window.",
"type" : "number"
},
"maxMemoryUtilizationPercentage" : {
"description" : "Maximum percentage of memory used by YARN applications during the report window.",
"type" : "number"
},
"avgMemoryDailyPeakPercentage" : {
"description" : "Average daily peak percentage of memory used by YARN applications during the report\nwindow.",
"type" : "number"
},
"tenantUtilizations" : {
"description" : "A list of tenant utilization reports.",
"$ref" : "#/definitions/ApiYarnTenantUtilizationList"
},
"errorMessage" : {
"description" : "error message of utilization report.",
"type" : "string"
}
},
"example" : {
"avgCpuUtilization" : 12345.0,
"maxCpuUtilization" : 12345.0,
"avgCpuDailyPeak" : 12345.0,
"maxCpuUtilizationTimestampMs" : 12345,
"avgCpuUtilizationPercentage" : 12345.0,
"maxCpuUtilizationPercentage" : 12345.0,
"avgCpuDailyPeakPercentage" : 12345.0,
"avgMemoryUtilization" : 12345.0,
"maxMemoryUtilization" : 12345.0,
"avgMemoryDailyPeak" : 12345.0,
"maxMemoryUtilizationTimestampMs" : 12345,
"avgMemoryUtilizationPercentage" : 12345.0,
"maxMemoryUtilizationPercentage" : 12345.0,
"avgMemoryDailyPeakPercentage" : 12345.0,
"tenantUtilizations" : {
"items" : [
{
"tenantName" : "...",
"avgYarnCpuAllocation" : 12345.0,
"avgYarnCpuUtilization" : 12345.0,
"avgYarnCpuUnusedCapacity" : 12345.0,
"avgYarnCpuSteadyFairShare" : 12345.0,
"avgYarnPoolAllocatedCpuDuringContention" : 12345.0,
"avgYarnPoolFairShareCpuDuringContention" : 12345.0,
"avgYarnPoolSteadyFairShareCpuDuringContention" : 12345.0,
"avgYarnContainerWaitRatio" : 12345.0,
"avgYarnMemoryAllocation" : 12345.0,
"avgYarnMemoryUtilization" : 12345.0,
"avgYarnMemoryUnusedCapacity" : 12345.0,
"avgYarnMemorySteadyFairShare" : 12345.0,
"avgYarnPoolAllocatedMemoryDuringContention" : 12345.0,
"avgYarnPoolFairShareMemoryDuringContention" : 12345.0,
"avgYarnPoolSteadyFairShareMemoryDuringContention" : 12345.0
},
{
"tenantName" : "...",
"avgYarnCpuAllocation" : 12345.0,
"avgYarnCpuUtilization" : 12345.0,
"avgYarnCpuUnusedCapacity" : 12345.0,
"avgYarnCpuSteadyFairShare" : 12345.0,
"avgYarnPoolAllocatedCpuDuringContention" : 12345.0,
"avgYarnPoolFairShareCpuDuringContention" : 12345.0,
"avgYarnPoolSteadyFairShareCpuDuringContention" : 12345.0,
"avgYarnContainerWaitRatio" : 12345.0,
"avgYarnMemoryAllocation" : 12345.0,
"avgYarnMemoryUtilization" : 12345.0,
"avgYarnMemoryUnusedCapacity" : 12345.0,
"avgYarnMemorySteadyFairShare" : 12345.0,
"avgYarnPoolAllocatedMemoryDuringContention" : 12345.0,
"avgYarnPoolFairShareMemoryDuringContention" : 12345.0,
"avgYarnPoolSteadyFairShareMemoryDuringContention" : 12345.0
}
]
},
"errorMessage" : "..."
},
"description" : "Utilization report information of a Yarn application service."
},
"BaseApiSshCmdArguments" : {
"type" : "object",
"title" : "BaseApiSshCmdArguments",
"properties" : {
"sshPort" : {
"example" : 22,
"description" : "SSH port. If unset, defaults to 22.",
"type" : "integer"
},
"userName" : {
"description" : "The username used to authenticate with the hosts.\nRoot access to your hosts is required to install Cloudera packages.\nThe installer will connect to your hosts via SSH and log in either\ndirectly as root or as another user with password-less sudo\nprivileges to become root.",
"type" : "string"
},
"password" : {
"description" : "The password used to authenticate with the hosts.\nSpecify either this or a private key.\nFor password-less login, use an empty string as\npassword.",
"type" : "string"
},
"privateKey" : {
"description" : "The private key to authenticate with the hosts.\nSpecify either this or a password.\n
\nThe private key, if specified, needs to be a\nstandard PEM-encoded key as a single string, with all line breaks\nreplaced with the line-feed control character '\\n'.\n
\nA value will typically look like the following string:\n
\n-----BEGIN RSA PRIVATE KEY-----\\n[base-64 encoded key]\\n-----END RSA PRIVATE KEY-----\n
",
"type" : "string"
},
"passphrase" : {
"description" : "The passphrase associated with the private key\nused to authenticate with the hosts (optional).",
"type" : "string"
}
},
"example" : {
"sshPort" : 22,
"userName" : "...",
"password" : "...",
"privateKey" : "...",
"passphrase" : "..."
},
"description" : "Contains common arguments for commands which require SSH'ing into one or more hosts."
},
"DeleteHdfsPathResult" : {
"type" : "string",
"title" : "DeleteHdfsPathResult",
"enum" : [
"DELETED",
"NOT_DELETED",
"NOT_EXISTS"
],
"description" : ""
},
"HBasePeerState" : {
"type" : "string",
"title" : "HBasePeerState",
"enum" : [
"ENABLED",
"DISABLED"
],
"description" : ""
},
"HBaseTableArgs" : {
"type" : "object",
"title" : "HBaseTableArgs",
"required" : [
"initialSnapshot",
"snapshotSucceeded"
],
"properties" : {
"tableName" : {
"description" : "",
"type" : "string"
},
"initialSnapshot" : {
"description" : "",
"type" : "boolean"
},
"snapshotSucceeded" : {
"description" : "",
"type" : "boolean"
}
},
"example" : {
"tableName" : "...",
"initialSnapshot" : true,
"snapshotSucceeded" : true
},
"description" : "Holds information for an HBase table."
},
"HTTPMethod" : {
"type" : "string",
"title" : "HTTPMethod",
"enum" : [
"GET",
"POST",
"PUT",
"DELETE"
],
"description" : ""
},
"HaStatus" : {
"type" : "string",
"title" : "HaStatus",
"enum" : [
"ACTIVE",
"STANDBY",
"UNKNOWN"
],
"description" : ""
},
"Origin" : {
"type" : "string",
"title" : "Origin",
"enum" : [
"SOURCE",
"TARGET"
],
"description" : ""
},
"PerfInspectorPolicyType" : {
"type" : "string",
"title" : "PerfInspectorPolicyType",
"enum" : [
"FULL",
"QUICK"
],
"description" : "Enum to pick the type of Performance Inspector Diagnostics to run"
},
"PolicyStatus" : {
"type" : "string",
"title" : "PolicyStatus",
"enum" : [
"ENABLED",
"DISABLED",
"FAILED_ADMIN"
],
"description" : ""
},
"ReplicationOption" : {
"type" : "string",
"title" : "ReplicationOption",
"enum" : [
"METADATA_ONLY",
"METADATA_AND_DATA",
"KEEP_DATA_IN_CLOUD"
],
"description" : "This will decide how cloud replication will take place"
},
"ReplicationStrategy" : {
"type" : "string",
"title" : "ReplicationStrategy",
"enum" : [
"STATIC",
"DYNAMIC"
],
"description" : "The strategy for distributing the file replication tasks among the mappers\nof the MR job associated with a replication."
},
"ReplicationType" : {
"type" : "string",
"title" : "ReplicationType",
"enum" : [
"BOOTSTRAP",
"INCREMENTAL"
],
"description" : ""
},
"RestartType" : {
"type" : "string",
"title" : "RestartType",
"enum" : [
"NO_RESTART",
"RESTART",
"ROLLING_RESTART"
],
"description" : "Restart type to be used for restarting services"
},
"ScmDbType" : {
"type" : "string",
"title" : "ScmDbType",
"enum" : [
"MYSQL",
"POSTGRESQL",
"HSQL",
"ORACLE",
"DERBY",
"SQLITE3"
],
"description" : "Enum for Cloudera Manager DB type.\nNote that DERBY and SQLITE3 are not supported DBs"
},
"ShutdownReadinessState" : {
"type" : "string",
"title" : "ShutdownReadinessState",
"enum" : [
"READY",
"NOT_READY"
],
"description" : "Enum for Cloudera Manager shutdown readiness state."
},
"State" : {
"type" : "string",
"title" : "State",
"enum" : [
"NOT_RUN",
"RUNNING",
"SUCCEEDED",
"FAILED"
],
"description" : ""
},
"Status" : {
"type" : "string",
"title" : "Status",
"enum" : [
"NOT_READY",
"READY",
"RUNNING",
"WAITING_FOR_SOURCE_RESTART",
"SETUP_INITIATED_ON_REMOTE",
"ERROR"
],
"description" : ""
},
"Storage" : {
"type" : "string",
"title" : "Storage",
"enum" : [
"LOCAL",
"REMOTE_S3"
],
"description" : ""
},
"StreamingOutput" : {
"type" : "object",
"title" : "StreamingOutput",
"example" : {},
"description" : ""
},
"SubStatus" : {
"type" : "string",
"title" : "SubStatus",
"enum" : [
"CONFIGURING",
"RESTARTING"
],
"description" : ""
},
"ValidationState" : {
"type" : "string",
"title" : "ValidationState",
"enum" : [
"OK",
"WARNING",
"ERROR"
],
"description" : ""
},
"ZooKeeperServerMode" : {
"type" : "string",
"title" : "ZooKeeperServerMode",
"enum" : [
"STANDALONE",
"REPLICATED_FOLLOWER",
"REPLICATED_LEADER",
"REPLICATED_LEADER_ELECTION",
"REPLICATED_OBSERVER",
"UNKNOWN"
],
"description" : "The state of the Zookeeper server."
}
},
"paths" : {
"/clusters/{clusterName}/services/{serviceName}/activities" : {
"get" : {
"tags" : [
"ActivitiesResource"
],
"summary" : "Read all activities in the system.",
"description" : "Read all activities in the system",
"operationId" : "readActivities",
"produces" : [
"application/json"
],
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : "The name of the cluster"
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : "The name of the service"
},
{
"name" : "maxResults",
"in" : "query",
"default" : "100",
"type" : "integer",
"description" : "The maximum number of activities to return."
},
{
"name" : "query",
"in" : "query",
"default" : "status==started;parent==",
"type" : "string",
"description" : "The query to perform to find activities in the system. By default,\nthis call returns top level (i.e. root) activities that have currently\nstarted.\n
\nThe query specifies the intersection of a list of constraints,\njoined together with semicolons (without spaces). For example:\n
\n\nThe valid comparators are ==, !=, =lt=,\n=le=, =ge=, and =gt=.\nThey stand for \"==\", \"!=\", \"<\", \"<=\",\n\">=\", \">\" respectively." }, { "name" : "resultOffset", "in" : "query", "default" : "0", "type" : "integer", "description" : "Specified the offset of activities to return." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the activities to materialize" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiActivityList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "OOZIE", "parent" : "...", "startTime" : "...", "finishTime" : "...", "id" : "...", "status" : "SUBMITTED", "user" : "...", "group" : "...", "inputDir" : "...", "outputDir" : "...", "mapper" : "...", "combiner" : "...", "reducer" : "...", "queueName" : "...", "schedulerPriority" : "..." }, { "name" : "...", "type" : "HIVE", "parent" : "...", "startTime" : "...", "finishTime" : "...", "id" : "...", "status" : "SUBMITTED", "user" : "...", "group" : "...", "inputDir" : "...", "outputDir" : "...", "mapper" : "...", "combiner" : "...", "reducer" : "...", "queueName" : "...", "schedulerPriority" : "..." } ] } }, "description" : "A list of activities" } } } }, "/clusters/{clusterName}/services/{serviceName}/activities/{activityId}" : { "get" : { "tags" : [ "ActivitiesResource" ], "summary" : "Returns a specific activity in the system.", "description" : "Returns a specific activity in the system", "operationId" : "readActivity", "produces" : [ "application/json" ], "parameters" : [ { "name" : "activityId", "in" : "path", "required" : true, "type" : "string", "description" : "The id of the activity to retrieve" }, { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the service" }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the activity to materialize" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiActivity" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "type" : "PIG", "parent" : "...", "startTime" : "...", "finishTime" : "...", "id" : "...", "status" : "ASSUMED_SUCCEEDED", "user" : "...", "group" : "...", "inputDir" : "...", "outputDir" : "...", "mapper" : "...", "combiner" : "...", "reducer" : "...", "queueName" : "...", "schedulerPriority" : "..." } }, "description" : "The Activity object with the specified id" } } } }, "/clusters/{clusterName}/services/{serviceName}/activities/{activityId}/children" : { "get" : { "tags" : [ "ActivitiesResource" ], "summary" : "Returns the child activities.", "description" : "Returns the child activities", "operationId" : "readChildActivities", "produces" : [ "application/json" ], "parameters" : [ { "name" : "activityId", "in" : "path", "required" : true, "type" : "string", "description" : "The id of the activity" }, { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the service" }, { "name" : "maxResults", "in" : "query", "default" : "100", "type" : "integer", "description" : "The maximum number of activities to return." }, { "name" : "resultOffset", "in" : "query", "default" : "0", "type" : "integer", "description" : "Specified the offset of activities to return." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the children to materialize" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiActivityList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "MR", "parent" : "...", "startTime" : "...", "finishTime" : "...", "id" : "...", "status" : "UNKNOWN", "user" : "...", "group" : "...", "inputDir" : "...", "outputDir" : "...", "mapper" : "...", "combiner" : "...", "reducer" : "...", "queueName" : "...", "schedulerPriority" : "..." }, { "name" : "...", "type" : "PIG", "parent" : "...", "startTime" : "...", "finishTime" : "...", "id" : "...", "status" : "FAILED", "user" : "...", "group" : "...", "inputDir" : "...", "outputDir" : "...", "mapper" : "...", "combiner" : "...", "reducer" : "...", "queueName" : "...", "schedulerPriority" : "..." } ] } }, "description" : "The list of child activities for the specified activity" } } } }, "/clusters/{clusterName}/services/{serviceName}/activities/{activityId}/metrics" : { "get" : { "tags" : [ "ActivitiesResource" ], "summary" : "Fetch metric readings for a particular activity.", "description" : "Fetch metric readings for a particular activity.\n
\nBy default, this call will look up all metrics available for the activity. If\nonly specific metrics are desired, use the metrics parameter.\n
\nBy default, the returned results correspond to a 5 minute window based on\nthe provided end time (which defaults to the current server time). The\nfrom and to parameters can be used to control the window\nbeing queried. A maximum window of 3 hours is enforced.\n
\nWhen requesting a \"full\" view, aside from the extended properties of the\nreturned metric data, the collection will also contain information about\nall metrics available for the activity, even if no readings are available\nin the requested window.", "operationId" : "getMetrics", "produces" : [ "application/json" ], "parameters" : [ { "name" : "activityId", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the activity." }, { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the service." }, { "name" : "from", "in" : "query", "type" : "string", "description" : "Start of the period to query." }, { "name" : "metrics", "in" : "query", "type" : "array", "items" : { "type" : "string" }, "collectionFormat" : "multi", "description" : "Filter for which metrics to query." }, { "name" : "to", "in" : "query", "default" : "now", "type" : "string", "description" : "End of the period to query." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiMetricList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "context" : "...", "unit" : "...", "data" : [ { "timestamp" : "...", "value" : 12345.0 }, { "timestamp" : "...", "value" : 12345.0 } ], "displayName" : "...", "description" : "..." }, { "name" : "...", "context" : "...", "unit" : "...", "data" : [ { "timestamp" : "...", "value" : 12345.0 }, { "timestamp" : "...", "value" : 12345.0 } ], "displayName" : "...", "description" : "..." } ] } }, "description" : "List of readings from the monitors." } } } }, "/clusters/{clusterName}/services/{serviceName}/activities/{activityId}/similar" : { "get" : { "tags" : [ "ActivitiesResource" ], "summary" : "Returns a list of similar activities.", "description" : "Returns a list of similar activities", "operationId" : "readSimilarActivities", "produces" : [ "application/json" ], "parameters" : [ { "name" : "activityId", "in" : "path", "required" : true, "type" : "string", "description" : "The id of the activity" }, { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the service" }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the activities to materialize" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiActivityList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "OOZIE", "parent" : "...", "startTime" : "...", "finishTime" : "...", "id" : "...", "status" : "SUBMITTED", "user" : "...", "group" : "...", "inputDir" : "...", "outputDir" : "...", "mapper" : "...", "combiner" : "...", "reducer" : "...", "queueName" : "...", "schedulerPriority" : "..." }, { "name" : "...", "type" : "HIVE", "parent" : "...", "startTime" : "...", "finishTime" : "...", "id" : "...", "status" : "UNKNOWN", "user" : "...", "group" : "...", "inputDir" : "...", "outputDir" : "...", "mapper" : "...", "combiner" : "...", "reducer" : "...", "queueName" : "...", "schedulerPriority" : "..." } ] } }, "description" : "The list of similar activities to the specified activity" } } } }, "/cm/allHosts/config" : { "get" : { "tags" : [ "AllHostsResource" ], "summary" : "Retrieve the default configuration for all hosts.", "description" : "Retrieve the default configuration for all hosts.\n
\nThese values will apply to all hosts managed by CM unless overridden\nat the host level.", "operationId" : "readConfig", "produces" : [ "application/json" ], "parameters" : [ { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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 } ] } }, "description" : "List of config values." } } }, "put" : { "tags" : [ "AllHostsResource" ], "summary" : "Update the default configuration values for all hosts.", "description" : "Update the default configuration values for all hosts.\n\nNote that this does not override values set at the host level. It just\nupdates the default values that will be inherited by each host's\nconfiguration.", "operationId" : "updateConfig", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "message", "in" : "query", "type" : "string", "description" : "Optional message describing the changes." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "description" : "The config values to update." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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 } ] } }, "description" : "Updated list of config values." } } } }, "/audits" : { "get" : { "tags" : [ "AuditsResource" ], "summary" : "Fetch audit events from Cloudera Manager (CM) and CM managed services\nlike HDFS, HBase, Impala, Hive, and Sentry.", "description" : "Fetch audit events from Cloudera Manager (CM) and CM managed services\nlike HDFS, HBase, Impala, Hive, and Sentry.\n\nBy default, this call will fetch the first 100 audit events (sorted from most\nrecent to oldest) corresponding to a 1 day window based on provided end time\n(which defaults to the current CM server time). The startTime and\nendTime parameters can be used to control the window being queried.\n
\nAudit events for CM managed services are only retrieved if Cloudera\nNavigator server is running.", "operationId" : "readAudits", "produces" : [ "application/json" ], "parameters" : [ { "name" : "endTime", "in" : "query", "default" : "now", "type" : "string", "description" : "End of the period to query in ISO 8601 format (defaults to\ncurrent time)." }, { "name" : "maxResults", "in" : "query", "default" : "100", "type" : "integer", "description" : "Maximum number of audits to return" }, { "name" : "query", "in" : "query", "type" : "string", "description" : "The query to filter out audits in the system. It accepts\nquerying the intersection of a list of constraints,\njoined together with semicolons (without spaces). For example:\n
\n| Selector | \nDescription | \nSCM | \nHDFS | \nHBase | \nHive | \nImpala | \nSentry | \n
|---|---|---|---|---|---|---|---|
| service | \nCloudera Manager Service | \nx | \nx | \nx | \nx | \nx | \nx | \n
| operation | \nOperation name | \nx | \nx | \nx | \nx | \nx | \nx | \n
| username | \nUser name | \nx | \nx | \nx | \nx | \nx | \nx | \n
| impersonator | \nImpersonator | \n\n | x | \nx | \nx | \nx | \nx | \n
| ip_address | \nIP Address | \nx | \nx | \nx | \nx | \nx | \nx | \n
| allowed | \nWhether the request was allowed or denied | \nx | \nx | \nx | \nx | \nx | \nx | \n
| qualifier | \nColumn qualifier | \n\n | \n | x | \n\n | \n | \n |
| source | \nSource resource of the operation | \nx | \nx | \nx | \nx | \nx | \n\n |
| destination | \nDestination resource of the operation | \n\n | x | \nx | \nx | \nx | \n\n |
| hostIpAddress | \nHost IP Address | \nx | \n\n | \n | \n | \n | \n |
| role | \nCloudera Manager Role | \nx | \n\n | \n | \n | \n | \n |
| family | \nColumn family | \n\n | \n | x | \n\n | \n | \n |
| database_name | \nDatabase name | \n\n | \n | \n | x | \nx | \nx | \n
| table_name | \nTable name | \n\n | \n | x | \nx | \nx | \nx | \n
| object_type | \nType of object being handled | \n\n | \n | \n | x | \nx | \nx | \n
| operation_text | \nCommand/query text | \n\n | \n | \n | x | \nx | \nx | \n
\nThe only supported operator is \";\" (Boolean AND). Boolean OR is\nnot supported.\n
\nThe supported comparators are == and !=\nNote that \"LIKE\" comparison is supported using the wild card syntax,\nfor example foo==*value*. Asterisk is interpreted as a wild\ncard character and must not be part of the value. (LIKE comparison\nqueries are converted to standard SQL LIKE syntax, so any % (%25)\ncharacter in a value that also contains a wild card will be\ninterpreted as a wild card.)\n
\nAvailable since API v8. A subset of these features is available since v4." }, { "name" : "resultOffset", "in" : "query", "default" : "0", "type" : "integer", "description" : "Offset of audits to return" }, { "name" : "startTime", "in" : "query", "type" : "string", "description" : "Start of the period to query in ISO 8601 format (defaults\nto 1 day ago relative to endTime)." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiAuditList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "timestamp" : "...", "service" : "...", "username" : "...", "impersonator" : "...", "ipAddress" : "...", "command" : "...", "resource" : "...", "operationText" : "...", "allowed" : true, "serviceValues" : { "property1" : "...", "property2" : "..." } }, { "timestamp" : "...", "service" : "...", "username" : "...", "impersonator" : "...", "ipAddress" : "...", "command" : "...", "resource" : "...", "operationText" : "...", "allowed" : true, "serviceValues" : { "property1" : "...", "property2" : "..." } } ] } }, "description" : "List of audits in descending order of timestamp" } } } }, "/audits/stream" : { "get" : { "tags" : [ "AuditsResource" ], "description" : "", "operationId" : "streamAudits", "produces" : [ "application/json" ], "parameters" : [ { "name" : "endTime", "in" : "query", "default" : "now", "type" : "string", "description" : "" }, { "name" : "maxResults", "in" : "query", "default" : "100", "type" : "integer", "description" : "" }, { "name" : "query", "in" : "query", "type" : "string", "description" : "" }, { "name" : "resultOffset", "in" : "query", "default" : "0", "type" : "integer", "description" : "" }, { "name" : "startTime", "in" : "query", "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "type" : "file", "description" : "" }, "headers" : {}, "examples" : { "application/json" : {} }, "description" : "" } } } }, "/authRoleMetadatas" : { "get" : { "tags" : [ "AuthRoleMetadatasResource" ], "summary" : "Returns a list of the auth roles' metadata for the built-in roles.", "description" : "Returns a list of the auth roles' metadata for the built-in roles.", "operationId" : "readAuthRolesMetadata", "produces" : [ "application/json" ], "parameters" : [ { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiAuthRoleMetadataList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "displayName" : "...", "uuid" : "...", "role" : "...", "authorities" : [ { "name" : "...", "description" : "..." }, { "name" : "...", "description" : "..." } ], "allowedScopes" : [ "...", "..." ] }, { "displayName" : "...", "uuid" : "...", "role" : "...", "authorities" : [ { "name" : "...", "description" : "..." }, { "name" : "...", "description" : "..." } ], "allowedScopes" : [ "...", "..." ] } ] } }, "description" : "A list of auth role metadata" } } } }, "/authRoles" : { "get" : { "tags" : [ "AuthRolesResource" ], "summary" : "Returns a list of the auth roles configured in the system.", "description" : "Returns a list of the auth roles configured in the system.", "operationId" : "readAuthRoles", "produces" : [ "application/json" ], "parameters" : [ { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiAuthRoleList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "displayName" : "...", "name" : "...", "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "users" : [ { "name" : "..." }, { "name" : "..." } ], "externalUserMappings" : [ { "uuid" : "...", "name" : "...", "type" : "SAML_ATTRIBUTE" }, { "uuid" : "...", "name" : "...", "type" : "SAML_ATTRIBUTE" } ], "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 } ] } }, "description" : "A list of auth roles." } } }, "post" : { "tags" : [ "AuthRolesResource" ], "summary" : "Creates a list of auth roles.", "description" : "Creates a list of auth roles.", "operationId" : "createAuthRoles", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiAuthRoleList" }, "description" : "List of auth roles to create." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiAuthRoleList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "displayName" : "...", "name" : "...", "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "users" : [ { "name" : "..." }, { "name" : "..." } ], "externalUserMappings" : [ { "uuid" : "...", "name" : "...", "type" : "SAML_SCRIPT" }, { "uuid" : "...", "name" : "...", "type" : "LDAP" } ], "baseRole" : { "displayName" : "...", "name" : "...", "uuid" : "..." }, "uuid" : "...", "isCustom" : true }, { "displayName" : "...", "name" : "...", "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "users" : [ { "name" : "..." }, { "name" : "..." } ], "externalUserMappings" : [ { "uuid" : "...", "name" : "...", "type" : "SAML_ATTRIBUTE" }, { "uuid" : "...", "name" : "...", "type" : "EXTERNAL_PROGRAM" } ], "baseRole" : { "displayName" : "...", "name" : "...", "uuid" : "..." }, "uuid" : "...", "isCustom" : true } ] } }, "description" : "Information about created auth roles." } } } }, "/authRoles/metadata" : { "get" : { "tags" : [ "AuthRolesResource" ], "summary" : "Returns a list of the auth roles' metadata for the built-in roles.", "description" : "Returns a list of the auth roles' metadata for the built-in roles.", "operationId" : "readAuthRolesMetadata", "produces" : [ "application/json" ], "parameters" : [ { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiAuthRoleMetadataList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "displayName" : "...", "uuid" : "...", "role" : "...", "authorities" : [ { "name" : "...", "description" : "..." }, { "name" : "...", "description" : "..." } ], "allowedScopes" : [ "...", "..." ] }, { "displayName" : "...", "uuid" : "...", "role" : "...", "authorities" : [ { "name" : "...", "description" : "..." }, { "name" : "...", "description" : "..." } ], "allowedScopes" : [ "...", "..." ] } ] } }, "description" : "A list of auth role metadata" } } } }, "/authRoles/{uuid}" : { "delete" : { "tags" : [ "AuthRolesResource" ], "summary" : "Deletes an auth role from the system.", "description" : "Deletes an auth role from the system.\n", "operationId" : "deleteAuthRole", "produces" : [ "application/json" ], "parameters" : [ { "name" : "uuid", "in" : "path", "required" : true, "type" : "string", "description" : "The uuid of the auth role to delete." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiAuthRole" }, "headers" : {}, "examples" : { "application/json" : { "displayName" : "...", "name" : "...", "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "users" : [ { "name" : "..." }, { "name" : "..." } ], "externalUserMappings" : [ { "uuid" : "...", "name" : "...", "type" : "EXTERNAL_PROGRAM" }, { "uuid" : "...", "name" : "...", "type" : "LDAP" } ], "baseRole" : { "displayName" : "...", "name" : "...", "uuid" : "..." }, "uuid" : "...", "isCustom" : true } }, "description" : "The details of the deleted auth role." } } }, "get" : { "tags" : [ "AuthRolesResource" ], "summary" : "Returns detailed information about an auth role.", "description" : "Returns detailed information about an auth role.", "operationId" : "readAuthRole", "produces" : [ "application/json" ], "parameters" : [ { "name" : "uuid", "in" : "path", "required" : true, "type" : "string", "description" : "The auth role to read." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiAuthRole" }, "headers" : {}, "examples" : { "application/json" : { "displayName" : "...", "name" : "...", "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "users" : [ { "name" : "..." }, { "name" : "..." } ], "externalUserMappings" : [ { "uuid" : "...", "name" : "...", "type" : "EXTERNAL_PROGRAM" }, { "uuid" : "...", "name" : "...", "type" : "SAML_SCRIPT" } ], "baseRole" : { "displayName" : "...", "name" : "...", "uuid" : "..." }, "uuid" : "...", "isCustom" : true } }, "description" : "The auth role's information." } } }, "put" : { "tags" : [ "AuthRolesResource" ], "summary" : "Updates the given auth role's information.", "description" : "Updates the given auth role's information.", "operationId" : "updateAuthRole", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "uuid", "in" : "path", "required" : true, "type" : "string", "description" : "Uuid of the auth role being updated." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiAuthRole" }, "description" : "The auth role information." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiAuthRole" }, "headers" : {}, "examples" : { "application/json" : { "displayName" : "...", "name" : "...", "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "users" : [ { "name" : "..." }, { "name" : "..." } ], "externalUserMappings" : [ { "uuid" : "...", "name" : "...", "type" : "SAML_ATTRIBUTE" }, { "uuid" : "...", "name" : "...", "type" : "EXTERNAL_PROGRAM" } ], "baseRole" : { "displayName" : "...", "name" : "...", "uuid" : "..." }, "uuid" : "...", "isCustom" : true } }, "description" : "" } } } }, "/cm/authService" : { "delete" : { "tags" : [ "AuthServiceResource" ], "summary" : "Delete the Authentication Service.", "description" : "Delete the Authentication Service.\n\nThis method will fail if a CMS instance doesn't already exist.", "operationId" : "delete", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiService" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STOPPED", "healthSummary" : "CONCERNING", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "CONTROL_PLANE" ], "config" : { "roleTypeConfigs" : [ { "roleType" : "...", "items" : [ {}, {} ] }, { "roleType" : "...", "items" : [ {}, {} ] } ], "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STARTED", "commissionState" : "OFFLINED", "healthSummary" : "BAD", "configStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true } ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "CONTROL_PLANE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "BAD_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STARTING", "commissionState" : "UNKNOWN", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true } ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "CONTROL_PLANE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "STANDALONE", "entityStatus" : "BAD_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ], "displayName" : "...", "roleConfigGroups" : [ { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } }, { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } ], "replicationSchedules" : [ { "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "KEEP_DATA_IN_CLOUD", "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : {}, "peerState" : "DISABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ {}, {} ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : {}, "status" : "DISABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : {} }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "KEEP_DATA_IN_CLOUD", "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : {}, "peerState" : "DISABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ {}, {} ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : {}, "status" : "FAILED_ADMIN", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : {} }, "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" : { "tableRegExps" : [ "...", "..." ], "storage" : "LOCAL" }, "hdfsArguments" : { "pathPatterns" : [ "...", "..." ] }, "lastCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "lastSuccessfulCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "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" : { "tableRegExps" : [ "...", "..." ], "storage" : "REMOTE_S3" }, "hdfsArguments" : { "pathPatterns" : [ "...", "..." ] }, "lastCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "lastSuccessfulCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "paused" : true } ], "entityStatus" : "GOOD_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." } }, "description" : "ApiService The deleted CMS information." } } }, "get" : { "tags" : [ "AuthServiceResource" ], "summary" : "Retrieve information about the Authentication Services.", "description" : "Retrieve information about the Authentication Services.", "operationId" : "readService", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiService" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STOPPING", "healthSummary" : "CONCERNING", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "HOST" ], "config" : { "roleTypeConfigs" : [ { "roleType" : "...", "items" : [ {}, {} ] }, { "roleType" : "...", "items" : [ {}, {} ] } ], "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STOPPING", "commissionState" : "DECOMMISSIONING", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true } ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "HOST" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_LEADER", "entityStatus" : "UNKNOWN", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "NA", "commissionState" : "DECOMMISSIONING", "healthSummary" : "CONCERNING", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true } ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "CONTROL_PLANE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION", "entityStatus" : "NONE", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ], "displayName" : "...", "roleConfigGroups" : [ { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } }, { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } ], "replicationSchedules" : [ { "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "METADATA_ONLY", "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : {}, "peerState" : "DISABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ {}, {} ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : {}, "status" : "FAILED_ADMIN", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : {} }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "MINUTE", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "METADATA_AND_DATA", "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : {}, "peerState" : "DISABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ {}, {} ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : {}, "status" : "ENABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : {} }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "YEAR", "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" : { "tableRegExps" : [ "...", "..." ], "storage" : "REMOTE_S3" }, "hdfsArguments" : { "pathPatterns" : [ "...", "..." ] }, "lastCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "lastSuccessfulCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "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" : { "tableRegExps" : [ "...", "..." ], "storage" : "LOCAL" }, "hdfsArguments" : { "pathPatterns" : [ "...", "..." ] }, "lastCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "lastSuccessfulCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "paused" : true } ], "entityStatus" : "STOPPED", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." } }, "description" : "Details about the management service." } } }, "put" : { "tags" : [ "AuthServiceResource" ], "summary" : "Setup the Authentication Service.", "description" : "Setup the Authentication Service.\n
\nConfigure the Auth Service instance with the information given in\nthe ApiService. The provided configuration data can be used to set\nup host mappings for each role, and required configuration such as\ndatabase connection information for specific roles.\n
\nThis method needs a valid CM license to be installed beforehand.\n
\nThis method does not start any services or roles.\n
\nThis method will fail if a Auth Service instance already exists.\n
\nAvailable role types:\n
\nAssignments are done based on number of hosts in the deployment\nand hardware specifications. If no hosts are part of the deployment,\nan exception will be thrown preventing any role assignments.\nExisting roles will be taken into account and their assignments\nwill be not be modified. The deployment should not have any clusters\nwhen calling this endpoint. If it does, an exception will be thrown\npreventing any role assignments.", "operationId" : "autoAssignRoles", "parameters" : [], "responses" : { "204" : { "headers" : {}, "examples" : {}, "description" : "Success" } } } }, "/cm/authService/autoConfigure" : { "put" : { "tags" : [ "AuthServiceResource" ], "summary" : "Automatically configures roles of the Authentication Service.", "description" : "Automatically configures roles of the Authentication Service.\n
\nOverwrites some existing configurations. Only default role config\ngroups must exist before calling this endpoint. Other role config\ngroups must not exist. If they do, an exception will be thrown\npreventing any configuration. Ignores any clusters (and their\nservices and roles) colocated with the Authentication Service.", "operationId" : "autoConfigure", "parameters" : [], "responses" : { "204" : { "headers" : {}, "examples" : {}, "description" : "Success" } } } }, "/cm/authService/commands" : { "get" : { "tags" : [ "AuthServiceResource" ], "summary" : "List active Authentication Service commands.", "description" : "List active Authentication Service commands.", "operationId" : "listActiveCommands", "produces" : [ "application/json" ], "parameters" : [ { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommandList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of active role commands." } } } }, "/cm/authService/config" : { "get" : { "tags" : [ "AuthServiceResource" ], "description" : "", "operationId" : "readServiceConfig", "produces" : [ "application/json" ], "parameters" : [ { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiServiceConfig" }, "headers" : {}, "examples" : { "application/json" : { "roleTypeConfigs" : [ { "roleType" : "...", "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, { "roleType" : "...", "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } ], "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "" } } }, "put" : { "tags" : [ "AuthServiceResource" ], "description" : "", "operationId" : "updateServiceConfig", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "message", "in" : "query", "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiServiceConfig" }, "description" : "" } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiServiceConfig" }, "headers" : {}, "examples" : { "application/json" : { "roleTypeConfigs" : [ { "roleType" : "...", "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, { "roleType" : "...", "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 } ] } ], "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 } ] } }, "description" : "" } } } }, "/cm/authService/roleTypes" : { "get" : { "tags" : [ "AuthServiceResource" ], "summary" : "List the supported role types for the Authentication Service.", "description" : "List the supported role types for the Authentication Service.", "operationId" : "listRoleTypes", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleTypeList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ "...", "..." ] } }, "description" : "List of role types the service supports." } } } }, "/cm/authService/commands/enterMaintenanceMode" : { "post" : { "tags" : [ "AuthServiceResource" ], "summary" : "Put the Authentication Service into maintenance mode.", "description" : "Put the Authentication Service into maintenance mode. This is a\nsynchronous command. The result is known immediately upon return.", "operationId" : "enterMaintenanceMode", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/cm/authService/commands/exitMaintenanceMode" : { "post" : { "tags" : [ "AuthServiceResource" ], "summary" : "Take the Authentication Service out of maintenance mode.", "description" : "Take the Authentication Service out of maintenance mode. This is a\nsynchronous command. The result is known immediately upon return.", "operationId" : "exitMaintenanceMode", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/cm/authService/commands/restart" : { "post" : { "tags" : [ "AuthServiceResource" ], "summary" : "Restart the Authentication Service.", "description" : "Restart the Authentication Service.", "operationId" : "restartCommand", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "A reference to the submitted command." } } } }, "/cm/authService/commands/start" : { "post" : { "tags" : [ "AuthServiceResource" ], "summary" : "Start the Authentication Service.", "description" : "Start the Authentication Service.", "operationId" : "startCommand", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "A reference to the submitted command." } } } }, "/cm/authService/commands/stop" : { "post" : { "tags" : [ "AuthServiceResource" ], "summary" : "Stop the Authentication Service.", "description" : "Stop the Authentication Service.", "operationId" : "stopCommand", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "A reference to the submitted command." } } } }, "/cm/authService/roleCommands/restart" : { "post" : { "tags" : [ "AuthServiceRoleCommandsResource" ], "summary" : "Restart a set of Authentication Service roles.", "description" : "Restart a set of Authentication Service roles.", "operationId" : "restartCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The roles to restart." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of submitted commands (summary view)." } } } }, "/cm/authService/roleCommands/start" : { "post" : { "tags" : [ "AuthServiceRoleCommandsResource" ], "summary" : "Start a set of Authentication Service roles.", "description" : "Start a set of Authentication Service roles.", "operationId" : "startCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The roles to start." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of submitted commands (summary view)." } } } }, "/cm/authService/roleCommands/stop" : { "post" : { "tags" : [ "AuthServiceRoleCommandsResource" ], "summary" : "Stop a set of Authentication Service roles.", "description" : "Stop a set of Authentication Service roles.", "operationId" : "stopCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The roles to stop." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of submitted commands (summary view)." } } } }, "/cm/authService/roleConfigGroups" : { "get" : { "tags" : [ "AuthServiceRoleConfigGroupsResource" ], "summary" : "Returns the information for all role config groups in\nthe Authentication Service.", "description" : "Returns the information for all role config groups in\nthe Authentication Service.", "operationId" : "readRoleConfigGroups", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleConfigGroupList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } }, { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } ] } }, "description" : "The list of role config groups for the given service." } } } }, "/cm/authService/roleConfigGroups/{roleConfigGroupName}" : { "get" : { "tags" : [ "AuthServiceRoleConfigGroupsResource" ], "summary" : "Returns the information for a given role config group\nin the Authentication Service.", "description" : "Returns the information for a given role config group\nin the Authentication Service.", "operationId" : "readRoleConfigGroup", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the requested group." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleConfigGroup" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "roleType" : "...", "base" : true, "config" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } }, "description" : "The requested role config group." } } }, "put" : { "tags" : [ "AuthServiceRoleConfigGroupsResource" ], "summary" : "Updates an existing role config group in the Authentication Service.", "description" : "Updates an existing role config group in the Authentication Service.", "operationId" : "updateRoleConfigGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the group to update." }, { "name" : "message", "in" : "query", "type" : "string", "description" : "The optional message describing the changes." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleConfigGroup" }, "description" : "The updated role config group." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleConfigGroup" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "roleType" : "...", "base" : true, "config" : { "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 } ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } }, "description" : "Role updated role config group." } } } }, "/cm/authService/roleConfigGroups/{roleConfigGroupName}/config" : { "get" : { "tags" : [ "AuthServiceRoleConfigGroupsResource" ], "summary" : "Returns the current revision of the config\nfor the specified role config group in the Authentication Service.", "description" : "Returns the current revision of the config\nfor the specified role config group in the Authentication Service.", "operationId" : "readConfig", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the role config group." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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 } ] } }, "description" : "The current configuration of the role config group." } } }, "put" : { "tags" : [ "AuthServiceRoleConfigGroupsResource" ], "summary" : "Updates the config for the given role config group\nin the Authentication Service.", "description" : "Updates the config for the given role config group\nin the Authentication Service.", "operationId" : "updateConfig", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the role config group." }, { "name" : "message", "in" : "query", "type" : "string", "description" : "Optional message describing the changes." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "description" : "The new config information for the group." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "The updated config of the role config group." } } } }, "/cm/authService/roleConfigGroups/{roleConfigGroupName}/roles" : { "get" : { "tags" : [ "AuthServiceRoleConfigGroupsResource" ], "summary" : "Returns all roles in the given role config group\nin the Authentication Service.", "description" : "Returns all roles in the given role config group\nin the Authentication Service.", "operationId" : "readRoles", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the role config group." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "BUSY", "commissionState" : "UNKNOWN", "healthSummary" : "CONCERNING", "configStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "HOST" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "GOOD_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STARTED", "commissionState" : "DECOMMISSIONED", "healthSummary" : "BAD", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true } ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "HOST" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "HISTORY_NOT_AVAILABLE", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] } }, "description" : "The roles in the role config group." } } } }, "/cm/authService/roles" : { "get" : { "tags" : [ "AuthServiceRolesResource" ], "summary" : "List all roles of the Authentication Services.", "description" : "List all roles of the Authentication Services.", "operationId" : "readRoles", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STARTED", "commissionState" : "OFFLINED", "healthSummary" : "BAD", "configStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "HOST" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION", "entityStatus" : "GOOD_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STARTING", "commissionState" : "OFFLINING", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "CONTROL_PLANE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "UNKNOWN", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] } }, "description" : "List of roles." } } }, "post" : { "tags" : [ "AuthServiceRolesResource" ], "summary" : "Create new roles in the Authentication Services.", "description" : "Create new roles in the Authentication Services.", "operationId" : "createRoles", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleList" }, "description" : "Roles to create." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "BUSY", "commissionState" : "DECOMMISSIONED", "healthSummary" : "GOOD", "configStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true } ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "HOST" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "STANDALONE", "entityStatus" : "DISABLED_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "HISTORY_NOT_AVAILABLE", "commissionState" : "OFFLINED", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true } ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "SERVICE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION", "entityStatus" : "HISTORY_NOT_AVAILABLE", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] } }, "description" : "List of created roles." } } } }, "/cm/authService/roles/{roleName}" : { "delete" : { "tags" : [ "AuthServiceRolesResource" ], "summary" : "Delete a role from the Authentication Services.", "description" : "Delete a role from the Authentication Services.", "operationId" : "deleteRole", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role name." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRole" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "NA", "commissionState" : "UNKNOWN", "healthSummary" : "GOOD", "configStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true } ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "CLUSTER" ], "config" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "CONCERNING_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } }, "description" : "The details of the deleted role." } } }, "get" : { "tags" : [ "AuthServiceRolesResource" ], "summary" : "Retrieve detailed information about a Authentication Services role.", "description" : "Retrieve detailed information about a Authentication Services role.", "operationId" : "readRole", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role name." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRole" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "BUSY", "commissionState" : "OFFLINED", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true } ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "SERVICE" ], "config" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "STANDALONE", "entityStatus" : "GOOD_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } }, "description" : "The details of the role." } } } }, "/cm/authService/roles/{roleName}/commands" : { "get" : { "tags" : [ "AuthServiceRolesResource" ], "summary" : "List active role commands.", "description" : "List active role commands.", "operationId" : "listActiveCommands", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role name." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommandList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of active role commands." } } } }, "/cm/authService/roles/{roleName}/config" : { "get" : { "tags" : [ "AuthServiceRolesResource" ], "summary" : "Retrieve the configuration of a specific Authentication Services role.", "description" : "Retrieve the configuration of a specific Authentication Services role.", "operationId" : "readRoleConfig", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to look up." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "List with configured and available configuration options." } } }, "put" : { "tags" : [ "AuthServiceRolesResource" ], "summary" : "Update the configuration of a Authentication Services role.", "description" : "Update the configuration of a Authentication Services role.\n
\nIf a value is set in the given configuration, it will be added\nto the role's configuration, replacing any existing entries.\nIf a value is unset (its value is null), the existing\nconfiguration for the attribute will be erased, if any.\n
\nAttributes that are not listed in the input will maintain their\ncurrent values in the configuration.", "operationId" : "updateRoleConfig", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to modify." }, { "name" : "message", "in" : "query", "type" : "string", "description" : "Optional message describing the changes." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "description" : "Configuration changes." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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 } ] } }, "description" : "The new service configuration." } } } }, "/cm/authService/roles/{roleName}/commands/enterMaintenanceMode" : { "post" : { "tags" : [ "AuthServiceRolesResource" ], "summary" : "Put the Authentication Service role into maintenance mode.", "description" : "Put the Authentication Service role into maintenance mode.This is a\nsynchronous command. The result is known immediately upon return.", "operationId" : "enterMaintenanceMode", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/cm/authService/roles/{roleName}/commands/exitMaintenanceMode" : { "post" : { "tags" : [ "AuthServiceRolesResource" ], "summary" : "Take the Authentication Service role out of maintenance mode.", "description" : "Take the Authentication Service role out of maintenance mode. This is\na synchronous command. The result is known immediately upon return.", "operationId" : "exitMaintenanceMode", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/cm/authService/roles/{roleName}/logs/full" : { "get" : { "tags" : [ "AuthServiceRolesResource" ], "summary" : "Retrieves the log file for the role's main process.", "description" : "Retrieves the log file for the role's main process.\n
\nIf the role is not started, this will be the log file associated with\nthe last time the role was run.\n
\nLog files are returned as plain text (type \"text/plain\").", "operationId" : "getFullLog", "produces" : [ "text/plain" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to fetch logs from." } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "string" }, "headers" : {}, "examples" : {}, "description" : "Contents of the role's log file." } } } }, "/cm/authService/roles/{roleName}/logs/stacks" : { "get" : { "tags" : [ "AuthServiceRolesResource" ], "summary" : "Retrieves the stacks log file, if any, for the role's main process.", "description" : "Retrieves the stacks log file, if any, for the role's main process. Note\nthat not all roles support periodic stacks collection.\n\nThe log files are returned as plain text (type \"text/plain\").", "operationId" : "getStacksLog", "produces" : [ "text/plain" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to fetch stacks logs from." } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "string" }, "headers" : {}, "examples" : {}, "description" : "Contents of the role's log file." } } } }, "/cm/authService/roles/{roleName}/logs/stacksBundle" : { "get" : { "tags" : [ "AuthServiceRolesResource" ], "summary" : "Download a zip-compressed archive of role stacks logs.", "description" : "Download a zip-compressed archive of role stacks logs. Note that not all\nroles support periodic stacks collection.", "operationId" : "getStacksLogsBundle", "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to fetch the stacks logs bundle from." } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "file" }, "headers" : {}, "examples" : {}, "description" : "The archive data." } } } }, "/cm/authService/roles/{roleName}/logs/stderr" : { "get" : { "tags" : [ "AuthServiceRolesResource" ], "summary" : "Retrieves the role's standard error output.", "description" : "Retrieves the role's standard error output.\n
\nIf the role is not started, this will be the output associated with\nthe last time the role was run.\n
\nLog files are returned as plain text (type \"text/plain\").", "operationId" : "getStandardError", "produces" : [ "text/plain" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to fetch stderr from." } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "string" }, "headers" : {}, "examples" : {}, "description" : "Contents of the role's standard error output." } } } }, "/cm/authService/roles/{roleName}/logs/stdout" : { "get" : { "tags" : [ "AuthServiceRolesResource" ], "summary" : "Retrieves the role's standard output.", "description" : "Retrieves the role's standard output.\n
\nIf the role is not started, this will be the output associated with\nthe last time the role was run.\n
\nLog files are returned as plain text (type \"text/plain\").", "operationId" : "getStandardOutput", "produces" : [ "text/plain" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to fetch stdout from." } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "string" }, "headers" : {}, "examples" : {}, "description" : "Contents of the role's standard output." } } } }, "/batch" : { "post" : { "tags" : [ "BatchResource" ], "summary" : "Executes a batch of API requests in one database transaction.", "description" : "Executes a batch of API requests in one database transaction. If any\nrequest fails, execution halts and the transaction is rolled back.", "operationId" : "execute", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiBatchRequest" }, "description" : "Batch of request to execute." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBatchResponse" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "statusCode" : 12345, "response" : {} }, { "statusCode" : 12345, "response" : {} } ], "success" : true } }, "description" : "Batch response, containing one element for each executed request\nelement. If a request element was skipped (i.e. a previous request\nelement failed), it will not have a corresponding response element." } } } }, "/cdp/createEnvironment" : { "post" : { "tags" : [ "CdpResource" ], "summary" : "Create an environment in ECS.", "description" : "Create an environment in ECS", "operationId" : "createEnvironmentCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "serviceName", "in" : "query", "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiCreateEnvironment" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "command info" } } } }, "/cdp/remoteContext" : { "post" : { "tags" : [ "CdpResource" ], "summary" : "Create or update the remote data context in the Workload cluster.", "description" : "Create or update the remote data context in the Workload cluster.", "operationId" : "postRemoteContext", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRemoteDataContext" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRemoteDataContext" }, "headers" : {}, "examples" : { "application/json" : { "endPointId" : "...", "endPoints" : [ { "name" : "...", "version" : "...", "serviceConfigs" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "endPointHostList" : [ { "uri" : "...", "endPointConfigs" : [ {}, {} ], "type" : "..." }, { "uri" : "...", "endPointConfigs" : [ {}, {} ], "type" : "..." } ], "serviceType" : "..." }, { "name" : "...", "version" : "...", "serviceConfigs" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "endPointHostList" : [ { "uri" : "...", "endPointConfigs" : [ {}, {} ], "type" : "..." }, { "uri" : "...", "endPointConfigs" : [ {}, {} ], "type" : "..." } ], "serviceType" : "..." } ], "configs" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "clusterVersion" : "..." } }, "description" : "json describing" } } } }, "/cdp/remoteContext/byCluster/{clusterName}" : { "get" : { "tags" : [ "CdpResource" ], "summary" : "Get a JSON for creating a remote data context in a Workload cluster.", "description" : "Get a JSON for creating a remote data context in a Workload cluster.", "operationId" : "getRemoteContextByCluster", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the DataContext." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRemoteDataContext" }, "headers" : {}, "examples" : { "application/json" : { "endPointId" : "...", "endPoints" : [ { "name" : "...", "version" : "...", "serviceConfigs" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "endPointHostList" : [ { "uri" : "...", "endPointConfigs" : [ {}, {} ], "type" : "..." }, { "uri" : "...", "endPointConfigs" : [ {}, {} ], "type" : "..." } ], "serviceType" : "..." }, { "name" : "...", "version" : "...", "serviceConfigs" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "endPointHostList" : [ { "uri" : "...", "endPointConfigs" : [ {}, {} ], "type" : "..." }, { "uri" : "...", "endPointConfigs" : [ {}, {} ], "type" : "..." } ], "serviceType" : "..." } ], "configs" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "clusterVersion" : "..." } }, "description" : "json describing" } } } }, "/cdp/remoteContext/byContext/{dataContextName}" : { "get" : { "tags" : [ "CdpResource" ], "summary" : "Get a JSON for creating a remote data context in a Workload cluster.", "description" : "Get a JSON for creating a remote data context in a Workload cluster.", "operationId" : "getRemoteContext", "produces" : [ "application/json" ], "parameters" : [ { "name" : "dataContextName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the DataContext." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRemoteDataContext" }, "headers" : {}, "examples" : { "application/json" : { "endPointId" : "...", "endPoints" : [ { "name" : "...", "version" : "...", "serviceConfigs" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "endPointHostList" : [ { "uri" : "...", "endPointConfigs" : [ {}, {} ], "type" : "..." }, { "uri" : "...", "endPointConfigs" : [ {}, {} ], "type" : "..." } ], "serviceType" : "..." }, { "name" : "...", "version" : "...", "serviceConfigs" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "endPointHostList" : [ { "uri" : "...", "endPointConfigs" : [ {}, {} ], "type" : "..." }, { "uri" : "...", "endPointConfigs" : [ {}, {} ], "type" : "..." } ], "serviceType" : "..." } ], "configs" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "clusterVersion" : "..." } }, "description" : "json describing" } } } }, "/certs/generateCertificate" : { "post" : { "tags" : [ "CertManagerResource" ], "summary" : "Exchange a cert request token for a certificate.", "description" : "Exchange a cert request token for a certificate. The token must be a valid\ntoken generated by the certmanager utility. The resulting certificate will\ncontainin a TLS certificate in JKS and PEM formats. It might optionally\ncontain a private key in JKS and PEM format, corresponding to the\ncertificate.\n\nThe tar file is designed to be consumed by the \"cm install_certs\" command\nto install TLS certificates on a Cloudera Manager agent host.", "operationId" : "generateCertificate", "consumes" : [ "application/json" ], "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiCertificateRequest" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "type" : "file" }, "headers" : {}, "examples" : {}, "description" : "tar file containing TLS certificate" } } } }, "/certs/truststore" : { "get" : { "tags" : [ "CertManagerResource" ], "summary" : "Gets the Auto-TLS truststore contents.", "description" : "Gets the Auto-TLS truststore contents", "operationId" : "getTruststore", "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "type", "in" : "query", "type" : "string", "description" : "truststore type. Must be \"JKS\" or \"PEM\"." } ], "responses" : { "200" : { "schema" : { "type" : "file", "description" : "" }, "headers" : {}, "examples" : {}, "description" : "truststore file contents" } } } }, "/certs/truststorePassword" : { "get" : { "tags" : [ "CertManagerResource" ], "summary" : "Gets the configured CM truststore password.", "description" : "Gets the configured CM truststore password", "operationId" : "getTruststorePassword", "produces" : [ "text/plain" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "type" : "string" }, "headers" : {}, "examples" : {}, "description" : "truststore password" } } } }, "/cm/clusterSupportTokens" : { "get" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Gets the support tokens for all the clusters.", "description" : "Gets the support tokens for all the clusters.", "operationId" : "getClusterSupportTokenList", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiClusterSupportTokenList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "clusterName" : "...", "displayName" : "...", "clusterSupportToken" : "..." }, { "clusterName" : "...", "displayName" : "...", "clusterSupportToken" : "..." } ] } }, "description" : "List of cluster support tokens." } } } }, "/cm/commands" : { "get" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "List active global commands.", "description" : "List active global commands.", "operationId" : "listActiveCommands", "produces" : [ "application/json" ], "parameters" : [ { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommandList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of active global commands." } } } }, "/cm/config" : { "get" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Retrieve the Cloudera Manager settings.", "description" : "Retrieve the Cloudera Manager settings.", "operationId" : "getConfig", "produces" : [ "application/json" ], "parameters" : [ { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view to materialize, either \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "The current Cloudera Manager settings." } } }, "put" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Update the Cloudera Manager settings.", "description" : "Update the Cloudera Manager settings.\n
\nIf a value is set in the given configuration, it will be added to the\nmanager's settings, replacing any existing entry. If a value is unset (its\nvalue is null), the existing the setting will be erased.\n
\nSettings that are not listed in the input will maintain their current\nvalues.", "operationId" : "updateConfig", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "message", "in" : "query", "type" : "string", "description" : "Optional message describing the changes." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "description" : "Settings to update." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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 } ] } }, "description" : "The updated configuration." } } } }, "/cm/deleteInstances" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Remove a list of cm servers from ha cluster.", "description" : "Remove a list of cm servers from ha cluster.\n\n
\nAvailable since API v49. Removes instances of cm server.\n
", "operationId" : "deleteInstances", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiStringList" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCmServerList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "cmServerId" : "...", "name" : "...", "ipAddress" : "...", "createdTime" : "...", "lastUpdatedTime" : "...", "haPriority" : "...", "isAlive" : "..." }, { "cmServerId" : "...", "name" : "...", "ipAddress" : "...", "createdTime" : "...", "lastUpdatedTime" : "...", "haPriority" : "...", "isAlive" : "..." } ] } }, "description" : "list of deleted cm servers" } } } }, "/cm/deployment" : { "get" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Retrieve full description of the entire Cloudera Manager deployment\nincluding all hosts, clusters, services, roles, users, settings, etc.", "description" : "Retrieve full description of the entire Cloudera Manager deployment\nincluding all hosts, clusters, services, roles, users, settings, etc.\n\nThis object can be used to reconstruct your entire deployment\n\nNote: Only users with sufficient privileges are allowed to call this.\n\nAvailable since API v41.\n
", "operationId" : "readInstances", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCmServerList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "cmServerId" : "...", "name" : "...", "ipAddress" : "...", "createdTime" : "...", "lastUpdatedTime" : "...", "haPriority" : "...", "isAlive" : "..." }, { "cmServerId" : "...", "name" : "...", "ipAddress" : "...", "createdTime" : "...", "lastUpdatedTime" : "...", "haPriority" : "...", "isAlive" : "..." } ] } }, "description" : "Detailed CM server information." } } } }, "/cm/kerberosInfo" : { "get" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Provides Cloudera Manager Kerberos information.", "description" : "Provides Cloudera Manager Kerberos information", "operationId" : "getKerberosInfo", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiKerberosInfo" }, "headers" : {}, "examples" : { "application/json" : { "kerberized" : true, "kdcType" : "...", "kerberosRealm" : "...", "kdcHost" : "...", "adminHost" : "...", "domain" : [ "...", "..." ] } }, "description" : "Cloudera Manager Kerberos information" } } } }, "/cm/kerberosPrincipals" : { "get" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Returns the Kerberos principals needed by the services being managed\nby Cloudera Manager.", "description" : "Returns the Kerberos principals needed by the services being managed\nby Cloudera Manager.", "operationId" : "getKerberosPrincipals", "produces" : [ "application/json" ], "parameters" : [ { "name" : "missingOnly", "in" : "query", "type" : "boolean", "description" : "Whether to include only those principals which do\nnot already exist in Cloudera Manager's database." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiPrincipalList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ "...", "..." ] } }, "description" : "List of kerberos principals." } } } }, "/cm/krb5conf" : { "get" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Retrieves krb5.", "description" : "Retrieves krb5.conf of the CM server host\n\n\nAvailable since API v41.\n
", "operationId" : "getKrb5Conf", "produces" : [ "application/octet-stream" ], "parameters" : [], "responses" : { "200" : { "schema" : { "type" : "file", "description" : "" }, "headers" : {}, "examples" : {}, "description" : "krb5.conf file contents or null if not present" } } } }, "/cm/license" : { "get" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Retrieve information about the Cloudera Manager license.", "description" : "Retrieve information about the Cloudera Manager license.", "operationId" : "readLicense", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiLicense" }, "headers" : {}, "examples" : { "application/json" : { "owner" : "...", "uuid" : "...", "expiration" : "...", "features" : [ { "name" : "...", "enabled" : true, "description" : "..." }, { "name" : "...", "enabled" : true, "description" : "..." } ], "deactivationDate" : "...", "startDate" : "..." } }, "description" : "The current license information." } } }, "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Updates the Cloudera Manager license.", "description" : "Updates the Cloudera Manager license.\n\nAfter a new license is installed, the Cloudera Manager needs to be\nrestarted for the changes to take effect.\n
\nThe license file should be uploaded using a request with content type\n\"multipart/form-data\", instead of being encoded into a JSON representation.", "operationId" : "updateLicense", "consumes" : [ "multipart/form-data" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "license", "in" : "formData", "type" : "file", "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiLicense" }, "headers" : {}, "examples" : { "application/json" : { "owner" : "...", "uuid" : "...", "expiration" : "...", "features" : [ { "name" : "...", "enabled" : true, "description" : "..." }, { "name" : "...", "enabled" : true, "description" : "..." } ], "deactivationDate" : "...", "startDate" : "..." } }, "description" : "The new license information." } } } }, "/cm/licensedFeatureUsage" : { "get" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Retrieve a summary of licensed feature usage.", "description" : "Retrieve a summary of licensed feature usage.\n
\nThis command will return information about what Cloudera Enterprise\nlicensed features are in use in the clusters being managed by this Cloudera\nManager, as well as totals for usage across all clusters.\n\nThe specific features described can vary between different versions of\nCloudera Manager.\n\nAvailable since API v6.", "operationId" : "getLicensedFeatureUsage", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiLicensedFeatureUsage" }, "headers" : {}, "examples" : { "application/json" : { "totals" : { "property1" : 12345, "property2" : 12345 }, "clusters" : { "property1" : {}, "property2" : {} } } }, "description" : "" } } } }, "/cm/log" : { "get" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Returns the entire contents of the Cloudera Manager log file.", "description" : "Returns the entire contents of the Cloudera Manager log file", "operationId" : "getLog", "produces" : [ "text/plain" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "type" : "string" }, "headers" : {}, "examples" : {}, "description" : "" } } } }, "/cm/retrieveKeytab" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Retrieves a keytab for a list of principals.", "description" : "Retrieves a keytab for a list of principals. The principals must already exist.", "operationId" : "retrieveKeytab", "consumes" : [ "application/json" ], "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiPrincipalList" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "type" : "file", "description" : "" }, "headers" : {}, "examples" : {}, "description" : "bytes of the keytab" } } } }, "/cm/scmDbInfo" : { "get" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Provides Cloudera Manager server's database information.", "description" : "Provides Cloudera Manager server's database information", "operationId" : "getScmDbInfo", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiScmDbInfo" }, "headers" : {}, "examples" : { "application/json" : { "scmDbType" : "POSTGRESQL", "embeddedDbUsed" : true } }, "description" : "Cloudera Manager server's database information" } } } }, "/cm/shutdownReadiness" : { "get" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Retrieve Cloudera Manager's readiness for shutdown and destroy.", "description" : "Retrieve Cloudera Manager's readiness for shutdown and destroy.\nApplications that wish to destroy Cloudera Manager and its managed cluster\nshould poll this API, repeatedly if necessary, to respect its readiness.", "operationId" : "getShutdownReadiness", "produces" : [ "application/json" ], "parameters" : [ { "name" : "lastActivityTime", "in" : "query", "type" : "string", "description" : "End time of the last known activity/workload\nagainst the managed clusters, in ISO 8601 format." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiShutdownReadiness" }, "headers" : {}, "examples" : { "application/json" : { "state" : "READY" } }, "description" : "Cloudera Manager readiness for shutdown" } } } }, "/cm/version" : { "get" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Provides version information of Cloudera Manager itself.", "description" : "Provides version information of Cloudera Manager itself.", "operationId" : "getVersion", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiVersionInfo" }, "headers" : {}, "examples" : { "application/json" : { "version" : "...", "snapshot" : true, "buildUser" : "...", "buildTimestamp" : "...", "gitHash" : "..." } }, "description" : "Version information" } } } }, "/cm/commands/addCustomCerts" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Add custom certificates to the Auto-TLS certificate database.", "description" : "Add custom certificates to the Auto-TLS certificate database", "operationId" : "addCustomCerts", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiAddCustomCertsArguments" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/clustersPerfInspector" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Run performance diagnostics test against specified clusters\nin ApiClustersPerfInspectorArgs\n\nUser must be Full Administrator or Global Cluster Administrator.", "description" : "Run performance diagnostics test against specified clusters\nin ApiClustersPerfInspectorArgs\n\nUser must be Full Administrator or Global Cluster Administrator.", "operationId" : "clustersPerfInspectorCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiClustersPerfInspectorArgs" }, "description" : "Required arguments for the command. See ApiClustersPerfInspectorArgs." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/collectDiagnosticData" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Collect diagnostic data from hosts managed by Cloudera Manager.", "description" : "Collect diagnostic data from hosts managed by Cloudera Manager.\n\nAfter the command has completed, the ApiCommand will contain a\nresultDataUrl from where you can download the result.\n
\nOnly available with Cloudera Manager Enterprise Edition.", "operationId" : "collectDiagnosticDataCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiCollectDiagnosticDataArguments" }, "description" : "The command arguments." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Detailed command information." } } } }, "/cm/commands/deleteCredentials" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Delete existing Kerberos credentials.", "description" : "Delete existing Kerberos credentials.\n\nThis command will affect all services that have been configured to use\nKerberos, and have existing credentials. In V18 this takes a new\nparamater to determine whether it needs to delete all credentials\nor just unused ones.", "operationId" : "deleteCredentialsCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "deleteCredentialsMode", "in" : "query", "default" : "all", "type" : "string", "description" : "this can be set to \"all\" or \"unused\"" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/disableCsp" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Disables the CSP by setting csp type to \"none\", only when currently the csp type is either \"embedded\" or \"vault\".", "description" : "Disables the CSP by setting csp type to \"none\", only when currently the csp type is either \"embedded\" or \"vault\".\nThis will decrypt the encrypted configurations and disable the use of Credential Storage Provider.", "operationId" : "disableCsp", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/generateCmca" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Generate a CMCA.", "description" : "Generate a CMCA", "operationId" : "generateCmca", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiGenerateCmcaArguments" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/generateCredentials" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Generate missing Kerberos credentials.", "description" : "Generate missing Kerberos credentials.\n
\nThis command will affect all services that have been configured to use\nKerberos, and haven't had their credentials generated yet.", "operationId" : "generateCredentialsCommand", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/generateCredentialsAdhoc" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Generate missing Kerberos credentials, optionally accepting a list of ad-hoc credentials to\ngenerate as well.", "description" : "Generate missing Kerberos credentials, optionally accepting a list of ad-hoc credentials to\ngenerate as well.\n\n
\nThis command will affect all services that have been configured to use\nKerberos, and haven't had their credentials generated yet.\n
", "operationId" : "generateCredentialsAdhoc", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiPrincipalList" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/hostInstall" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Perform installation on a set of hosts.", "description" : "Perform installation on a set of hosts.\n\nThis command installs Cloudera Manager Agent on a\nset of hosts.\n\nAvailable since API v6.", "operationId" : "hostInstallCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostInstallArguments" }, "description" : "Hosts to perform installation on" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/hostsDecommission" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Decommission the given hosts.", "description" : "Decommission the given hosts.\nAll slave roles on the hosts will be decommissioned.\nAll other roles will be stopped.\n\nTo offline by Upgrade Domain, use the \u201cupgradeDomains\u201d endpoint from the clusters resource to\nget the list of host names that belong in each Upgrade Domain. Available since API v40.", "operationId" : "hostsDecommissionCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostNameList" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/hostsOfflineOrDecommission" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Decommission the given hosts.", "description" : "Decommission the given hosts.\nAll slave roles on the hosts will be offlined or decommissioned with\npreference being offlined if supported by the service.\n
\nCurrently the offline operation is only supported by HDFS, where\nthe offline operation will put DataNodes into HDFS IN MAINTENANCE state which\nprevents unnecessary re-replication which could occur if decommissioned.\n
\nAll other roles on the hosts will be stopped.\n
\nThe offlineTimeout parameter is used to specify a timeout for offline. For HDFS, when the\ntimeout expires, the DataNode will automatically transition out of HDFS IN MAINTENANCE state,\nback to HDFS IN SERVICE state.\n
\nTo offline or decommission by Upgrade Domain, use the \u201cupgradeDomains\u201d endpoint from the\nclusters resource to get the list of host names that belong in each Upgrade Domain.\nAvailable since API v40.", "operationId" : "hostsOfflineOrDecommissionCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "offlineTimeout", "in" : "query", "type" : "integer", "description" : "offline timeout in seconds. Specify as null to get the default timeout (4 hours).\nIgnored if service does not support he offline operation." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostNameList" }, "description" : "list of host names to decommission." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/hostsPerfInspector" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Run performance diagnostics test against specified hosts in\nApiHostsPerfInspectorArgs\n\nUser must be Full Administrator or Global Cluster Administrator.", "description" : "Run performance diagnostics test against specified hosts in\nApiHostsPerfInspectorArgs\n\nUser must be Full Administrator or Global Cluster Administrator.", "operationId" : "hostsPerfInspectorCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostsPerfInspectorArgs" }, "description" : "Required arguments for the command. See ApiHostsPerfInspectorArgs." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/hostsRecommission" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Recommission the given hosts.", "description" : "Recommission the given hosts.\nAll slave roles on the hosts will be recommissioned.\nRoles are not started after this command. Use hostsStartRoles command\nfor that.", "operationId" : "hostsRecommissionCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostNameList" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/hostsRecommissionAndExitMaintenanceMode" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Recommission and exit maintenance on the given hosts.", "description" : "Recommission and exit maintenance on the given hosts.\nThe recommission step may optionally start roles as well.", "operationId" : "hostsRecommissionAndExitMaintenanceModeCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "recommissionType", "in" : "query", "default" : "recommission", "type" : "string", "enum" : [ "RECOMMISSION", "RECOMMISSION_WITH_START" ], "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostNameList" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/hostsRecommissionWithStart" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Recommission the given hosts.", "description" : "Recommission the given hosts. If slave roles support start when decommissioned,\nstart those roles before recommission.\nAll slave roles on the hosts will be recommissioned.\n\nWarning: Evolving. This method may change in the future and does not offer standard compatibility guarantees.\nRecommission the given hosts. If possible, start those roles before recommission. All slave roles on the hosts\nwill be recommissioned.\nDo not use without guidance from Cloudera.\n\nCurrently, only HDFS DataNodes will be started by this command.", "operationId" : "hostsRecommissionWithStartCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostNameList" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/hostsStartRoles" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Start all the roles on the given hosts.", "description" : "Start all the roles on the given hosts.", "operationId" : "hostsStartRolesCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostNameList" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/importAdminCredentials" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Imports the KDC Account Manager credentials needed by Cloudera\nManager to create kerberos principals needed by CDH services.", "description" : "Imports the KDC Account Manager credentials needed by Cloudera\nManager to create kerberos principals needed by CDH services.", "operationId" : "importAdminCredentials", "produces" : [ "application/json" ], "parameters" : [ { "name" : "password", "in" : "query", "type" : "string", "description" : "Password for the Account Manager.\n\nreturn Information about the submitted command." }, { "name" : "username", "in" : "query", "type" : "string", "description" : "Username of the Account Manager. Full name including the Kerberos\nrealm must be specified." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "" } } } }, "/cm/commands/importKerberosPrincipal" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Imports the Kerberos credentials for the specified principal\nwhich can then be used to add to a role's keytab by running\nGenerate Credentials command.", "description" : "Imports the Kerberos credentials for the specified principal\nwhich can then be used to add to a role's keytab by running\nGenerate Credentials command.", "operationId" : "importKerberosPrincipal", "produces" : [ "application/json" ], "parameters" : [ { "name" : "kvno", "in" : "query", "type" : "integer", "description" : "Key-version number of the password.\n\nreturn Information about the submitted command." }, { "name" : "password", "in" : "query", "type" : "string", "description" : "Password for the Kerberos principal. Cloudera Manager\nwill encrypt the principal and password and use it when needed for a daemon." }, { "name" : "principal", "in" : "query", "type" : "string", "description" : "Name of the principal. Full name including the Kerberos\nrealm must be specified. If it already exists, it will be overwritten." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "" } } } }, "/cm/commands/inspectHosts" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Runs the host inspector on the configured hosts.", "description" : "Runs the host inspector on the configured hosts.", "operationId" : "inspectHostsCommand", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/migrateCmcaToDb" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Migrate CMCA to the DB.", "description" : "Migrate CMCA to the DB", "operationId" : "migrateCmcaToDb", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/refreshParcelRepos" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : ".", "description" : "
\nSubmit a command to refresh parcels information.\n
\n\nThis API could be used following two scenarios.
\n- User updated Cloudera Manager's local parcel repository.
\n- User updated remote parcel locations.\n
\nUser wants to invoke this API to make sure that Cloudera Manager gets\nlatest parcels information. User can then monitor the returned command\nbefore proceeding to the next step.\n
", "operationId" : "refreshParcelRepos", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/testExternalAuthentication" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Launches a command to test the currently configured external authentication.", "description" : "Launches a command to test the currently configured external authentication", "operationId" : "testExternalAuthentication", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiTestCmExternalAuthArguments" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "the command to test external authentication" } } } }, "/cm/commands/updateCspType" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Updates the CSP type from previous csp type to new csp type, by copying the key_id (used for encryption of configs)\nfrom previous csp type to new csp type.", "description" : "Updates the CSP type from previous csp type to new csp type, by copying the key_id (used for encryption of configs)\nfrom previous csp type to new csp type.", "operationId" : "updateCspType", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiUpdateCspTypeArguments" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/commands/updateGlobalTruststore" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Add/remove certificates to the Auto-TLS certificate truststore.", "description" : "Add/remove certificates to the Auto-TLS certificate truststore", "operationId" : "updateGlobalTruststore", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiUpdateGlobalTruststoreArguments" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/instances/{cmServerId}" : { "get" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Retrieves the CM server information.", "description" : "Retrieves the CM server information.\n\n\nAvailable since API v41.\n
", "operationId" : "readInstance", "produces" : [ "application/json" ], "parameters" : [ { "name" : "cmServerId", "in" : "path", "required" : true, "type" : "string", "description" : "The CM server ID." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCmServer" }, "headers" : {}, "examples" : { "application/json" : { "cmServerId" : "...", "name" : "...", "ipAddress" : "...", "createdTime" : "...", "lastUpdatedTime" : "...", "haPriority" : "...", "isAlive" : "..." } }, "description" : "Detailed CM server information." } } } }, "/cm/trial/begin" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "Begin trial license.", "description" : "Begin trial license.", "operationId" : "beginTrial", "parameters" : [], "responses" : { "201" : { "headers" : {}, "examples" : {}, "description" : "Success" } } } }, "/cm/trial/end" : { "post" : { "tags" : [ "ClouderaManagerResource" ], "summary" : "End trial license.", "description" : "End trial license.", "operationId" : "endTrial", "parameters" : [], "responses" : { "201" : { "headers" : {}, "examples" : {}, "description" : "Success" } } } }, "/clusters" : { "get" : { "tags" : [ "ClustersResource" ], "summary" : "List all known clusters.", "description" : "List all known clusters.", "operationId" : "readClusters", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterType", "in" : "query", "default" : "base", "type" : "string", "enum" : [ "ANY", "BASE", "COMPUTE", "DATA_SERVICES", "EXPERIENCE" ], "description" : "Type of cluster, either \"any\", \"base\", \"compute\" or \"experience\". Default is \"base\"." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize, either \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiClusterList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "displayName" : "...", "fullVersion" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "CONTROL_PLANE" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "HISTORY_NOT_AVAILABLE", "healthSummary" : "BAD", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "ROLE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "UNKNOWN", "tags" : [ {}, {} ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "UNKNOWN", "healthSummary" : "CONCERNING", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "HOST" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "STOPPED", "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" : "..." } ] }, { "name" : "...", "displayName" : "...", "fullVersion" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "ROLE" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "STARTING", "healthSummary" : "BAD", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "SERVICE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "UNKNOWN", "tags" : [ {}, {} ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "HISTORY_NOT_AVAILABLE", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "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" : "STOPPED", "uuid" : "...", "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ], "clusterType" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] } }, "description" : "List of clusters." } } }, "post" : { "tags" : [ "ClustersResource" ], "summary" : "Creates a collection of clusters.", "description" : "Creates a collection of clusters.", "operationId" : "createClusters", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiClusterList" }, "description" : "List of clusters to created." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiClusterList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "displayName" : "...", "fullVersion" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "CLUSTER" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "UNKNOWN", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "HOST" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "BAD_HEALTH", "tags" : [ {}, {} ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "NA", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "CLUSTER" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "DISABLED_HEALTH", "tags" : [ {}, {} ], "serviceVersion" : "..." } ], "parcels" : [ { "product" : "...", "version" : "...", "stage" : "...", "state" : {}, "clusterRef" : {}, "displayName" : "...", "description" : "..." }, { "product" : "...", "version" : "...", "stage" : "...", "state" : {}, "clusterRef" : {}, "displayName" : "...", "description" : "..." } ], "clusterUrl" : "...", "hostsUrl" : "...", "entityStatus" : "UNKNOWN_HEALTH", "uuid" : "...", "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ], "clusterType" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "displayName" : "...", "fullVersion" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "SERVICE" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "STARTING", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "SERVICE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "GOOD_HEALTH", "tags" : [ {}, {} ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "STARTED", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "CLUSTER" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "STOPPED", "tags" : [ {}, {} ], "serviceVersion" : "..." } ], "parcels" : [ { "product" : "...", "version" : "...", "stage" : "...", "state" : {}, "clusterRef" : {}, "displayName" : "...", "description" : "..." }, { "product" : "...", "version" : "...", "stage" : "...", "state" : {}, "clusterRef" : {}, "displayName" : "...", "description" : "..." } ], "clusterUrl" : "...", "hostsUrl" : "...", "entityStatus" : "STOPPING", "uuid" : "...", "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ], "clusterType" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] } }, "description" : "List of created clusters." } } } }, "/clusters/{clusterName}" : { "delete" : { "tags" : [ "ClustersResource" ], "summary" : "Deletes a cluster.", "description" : "Deletes a cluster.", "operationId" : "deleteCluster", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of cluster to delete." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCluster" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "displayName" : "...", "fullVersion" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "HOST" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STOPPED", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "CONTROL_PLANE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "BUSY", "commissionState" : "DECOMMISSIONING", "healthSummary" : "BAD", "configStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "HOST" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "STARTING", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "HISTORY_NOT_AVAILABLE", "commissionState" : "OFFLINED", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "CLUSTER" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "STARTING", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "MONTH", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "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", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STOPPED", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "ROLE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPED", "commissionState" : "OFFLINING", "healthSummary" : "CONCERNING", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "HOST" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "STANDALONE", "entityStatus" : "NONE", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STARTED", "commissionState" : "DECOMMISSIONING", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "HOST" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION", "entityStatus" : "DISABLED_HEALTH", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "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" : "NONE", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." } ], "parcels" : [ { "product" : "...", "version" : "...", "stage" : "...", "state" : { "progress" : 12345, "totalProgress" : 12345, "count" : 12345, "totalCount" : 12345, "errors" : [ "...", "..." ], "warnings" : [ "...", "..." ] }, "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "displayName" : "...", "description" : "..." }, { "product" : "...", "version" : "...", "stage" : "...", "state" : { "progress" : 12345, "totalProgress" : 12345, "count" : 12345, "totalCount" : 12345, "errors" : [ "...", "..." ], "warnings" : [ "...", "..." ] }, "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "displayName" : "...", "description" : "..." } ], "clusterUrl" : "...", "hostsUrl" : "...", "entityStatus" : "UNKNOWN", "uuid" : "...", "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ], "clusterType" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } }, "description" : "Details of deleted cluster." } } }, "get" : { "tags" : [ "ClustersResource" ], "summary" : "Reads information about a cluster.", "description" : "Reads information about a cluster.", "operationId" : "readCluster", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of cluster to look up." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCluster" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "displayName" : "...", "fullVersion" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "ROLE" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STARTED", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "SERVICE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STARTING", "commissionState" : "OFFLINED", "healthSummary" : "BAD", "configStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "HOST" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "CONCERNING_HEALTH", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "BUSY", "commissionState" : "OFFLINING", "healthSummary" : "CONCERNING", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "CLUSTER" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION", "entityStatus" : "GOOD_HEALTH", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "DAY", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "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" : "NONE", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STOPPING", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "CONTROL_PLANE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "NA", "commissionState" : "COMMISSIONED", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "ROLE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER", "entityStatus" : "CONCERNING_HEALTH", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "UNKNOWN", "commissionState" : "UNKNOWN", "healthSummary" : "DISABLED", "configStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "ROLE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "MONTH", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "WEEK", "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" : "BAD_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." } ], "parcels" : [ { "product" : "...", "version" : "...", "stage" : "...", "state" : { "progress" : 12345, "totalProgress" : 12345, "count" : 12345, "totalCount" : 12345, "errors" : [ "...", "..." ], "warnings" : [ "...", "..." ] }, "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "displayName" : "...", "description" : "..." }, { "product" : "...", "version" : "...", "stage" : "...", "state" : { "progress" : 12345, "totalProgress" : 12345, "count" : 12345, "totalCount" : 12345, "errors" : [ "...", "..." ], "warnings" : [ "...", "..." ] }, "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "displayName" : "...", "description" : "..." } ], "clusterUrl" : "...", "hostsUrl" : "...", "entityStatus" : "STARTING", "uuid" : "...", "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ], "clusterType" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } }, "description" : "Details of requested cluster." } } }, "put" : { "tags" : [ "ClustersResource" ], "summary" : "Update an existing cluster.", "description" : "Update an existing cluster.\n\nTo update the CDH version, provide the new value in the \"fullVersion\"\nproperty. Setting a correct version that matches the actual installed software\nwill ensure the correct version-specific features, such as services, roles,\ncommands, and configurations. This need not be manually set for clusters\nusing parcels. In general this action is only necessary after the CDH\npackages have been manually updated. Note that a downgrade may be rejected\nif it would render existing services or roles unusable. For major upgrade,\nthe \"upgradeService\" cluster command should be used instead.
\n\nTo rename the cluster, provide the new name in the \"displayName\"\nproperty for API >= 6, or in the \"name\" property for API <=5.\n
\nAvailable since API v2.", "operationId" : "updateCluster", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiCluster" }, "description" : "" } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCluster" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "displayName" : "...", "fullVersion" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "ROLE" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STARTED", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "SERVICE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STARTED", "commissionState" : "OFFLINED", "healthSummary" : "BAD", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "HOST" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION", "entityStatus" : "DOWN", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STARTED", "commissionState" : "DECOMMISSIONING", "healthSummary" : "CONCERNING", "configStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "CLUSTER" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "STANDALONE", "entityStatus" : "UNKNOWN_HEALTH", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "MONTH", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "WEEK", "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" : "CONCERNING_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STARTED", "healthSummary" : "BAD", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "HOST" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPING", "commissionState" : "OFFLINING", "healthSummary" : "CONCERNING", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "CLUSTER" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_OBSERVER", "entityStatus" : "DOWN", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPED", "commissionState" : "OFFLINING", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "CLUSTER" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER", "entityStatus" : "HISTORY_NOT_AVAILABLE", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "WEEK", "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" : "DISABLED_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." } ], "parcels" : [ { "product" : "...", "version" : "...", "stage" : "...", "state" : { "progress" : 12345, "totalProgress" : 12345, "count" : 12345, "totalCount" : 12345, "errors" : [ "...", "..." ], "warnings" : [ "...", "..." ] }, "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "displayName" : "...", "description" : "..." }, { "product" : "...", "version" : "...", "stage" : "...", "state" : { "progress" : 12345, "totalProgress" : 12345, "count" : 12345, "totalCount" : 12345, "errors" : [ "...", "..." ], "warnings" : [ "...", "..." ] }, "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "displayName" : "...", "description" : "..." } ], "clusterUrl" : "...", "hostsUrl" : "...", "entityStatus" : "DOWN", "uuid" : "...", "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ], "clusterType" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } }, "description" : "Details of the affected cluster." } } } }, "/clusters/{clusterName}/autoAssignRoles" : { "put" : { "tags" : [ "ClustersResource" ], "summary" : "Automatically assign roles to hosts and create the roles for all the services in a cluster.", "description" : "Automatically assign roles to hosts and create the roles for all the services in a cluster.\n
\nAssignments are done based on services and hosts in the cluster, and hardware specifications.\nIf no hosts are added to the cluster, an exception will be thrown preventing any\nrole assignments.\nExisting roles will be taken into account and their assignments will be\nnot be modified.\n
\nAvailable since API v6.", "operationId" : "autoAssignRoles", "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." } ], "responses" : { "204" : { "headers" : {}, "examples" : {}, "description" : "Success" } } } }, "/clusters/{clusterName}/autoConfigure" : { "put" : { "tags" : [ "ClustersResource" ], "summary" : "Automatically configures roles and services in a cluster.", "description" : "Automatically configures roles and services in a cluster.\n
\nOverwrites some existing configurations. Might create new role config groups.\nOnly default role config groups must exist before calling this endpoint.\nOther role config groups must not exist. If they do, an exception will be thrown\npreventing any configuration.\nIgnores the Cloudera Management Service even if colocated with roles of this\ncluster. To avoid over-committing the heap on hosts, assign hosts to this cluster\nthat are not being used by the Cloudera Management Service.\n
\nAvailable since API v6.", "operationId" : "autoConfigure", "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." } ], "responses" : { "204" : { "headers" : {}, "examples" : {}, "description" : "Success" } } } }, "/clusters/{clusterName}/clientConfig" : { "get" : { "tags" : [ "ClustersResource" ], "summary" : "Download a zip-compressed archive of the client configuration, of a\nspecific cluster.", "description" : "Download a zip-compressed archive of the client configuration, of a\nspecific cluster. Currently, this only includes Kerberos Client\nConfiguration (krb5.conf). For client configuration of services, use the\nclientConfig endpoint of the services resource. This resource does not\nrequire any authentication.", "operationId" : "getClientConfig", "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The cluster name." } ], "responses" : { "200" : { "schema" : { "type" : "file", "description" : "" }, "headers" : {}, "examples" : {}, "description" : "The archive data." } } } }, "/clusters/{clusterName}/clusterSupportToken" : { "get" : { "tags" : [ "ClustersResource" ], "summary" : "Gets the support token for a cluster.", "description" : "Gets the support token for a cluster.", "operationId" : "getClusterSupportToken", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiClusterSupportToken" }, "headers" : {}, "examples" : { "application/json" : { "clusterName" : "...", "displayName" : "...", "clusterSupportToken" : "..." } }, "description" : "The cluster support token." } } } }, "/clusters/{clusterName}/commands" : { "get" : { "tags" : [ "ClustersResource" ], "summary" : "List active cluster commands.", "description" : "List active cluster commands.", "operationId" : "listActiveCommands", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The cluster to which the role belongs." }, { "name" : "commandName", "in" : "query", "type" : "string", "description" : "the command name, unique for the command class RestartClusterCommand#COMMAND_NAME" }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommandList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of active service commands." } } } }, "/clusters/{clusterName}/dfsServices" : { "get" : { "tags" : [ "ClustersResource" ], "summary" : "List the services that can provide distributed file system (DFS) capabilities in this cluster.", "description" : "List the services that can provide distributed file system (DFS) capabilities in this cluster.", "operationId" : "listDfsServices", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "cluster name" }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "data view required for matching services" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiServiceList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "NA", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "SERVICE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "BUSY", "commissionState" : "OFFLINING", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "SERVICE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER", "entityStatus" : "NONE", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STARTING", "commissionState" : "OFFLINING", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "CLUSTER" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "UNKNOWN_HEALTH", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "DAY", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "YEAR", "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" : "UNKNOWN", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STARTING", "healthSummary" : "GOOD", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "SERVICE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "NA", "commissionState" : "OFFLINING", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "SERVICE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "STOPPED", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STARTED", "commissionState" : "COMMISSIONED", "healthSummary" : "BAD", "configStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "CONTROL_PLANE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_OBSERVER", "entityStatus" : "UNKNOWN", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "MONTH", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "YEAR", "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" : "STOPPED", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." } ] } }, "description" : "Services that provide DFS capabilities in this cluster" } } } }, "/clusters/{clusterName}/export" : { "get" : { "tags" : [ "ClustersResource" ], "summary" : "Export the cluster template for the given cluster.", "description" : "Export the cluster template for the given cluster. If cluster does not have\nhost templates defined it will export host templates based on roles\nassignment.", "operationId" : "export", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "cluster name" }, { "name" : "exportAutoConfig", "in" : "query", "default" : "false", "type" : "boolean", "description" : "export configs set by the auto configuration" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiClusterTemplate" }, "headers" : {}, "examples" : { "application/json" : { "cdhVersion" : "...", "experienceVersion" : "...", "dataServicesVersion" : "...", "products" : [ { "version" : "...", "product" : "..." }, { "version" : "...", "product" : "..." } ], "services" : [ { "refName" : "...", "serviceType" : "...", "serviceConfigs" : [ { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true }, { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true } ], "roleConfigGroups" : [ { "refName" : "...", "roleType" : "...", "base" : true, "displayName" : "...", "configs" : [ {}, {} ] }, { "refName" : "...", "roleType" : "...", "base" : true, "displayName" : "...", "configs" : [ {}, {} ] } ], "roles" : [ { "refName" : "...", "roleType" : "..." }, { "refName" : "...", "roleType" : "..." } ], "displayName" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "refName" : "...", "serviceType" : "...", "serviceConfigs" : [ { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true }, { "name" : "...", "value" : "...", "ref" : "...", "variable" : "...", "autoConfig" : true } ], "roleConfigGroups" : [ { "refName" : "...", "roleType" : "...", "base" : true, "displayName" : "...", "configs" : [ {}, {} ] }, { "refName" : "...", "roleType" : "...", "base" : true, "displayName" : "...", "configs" : [ {}, {} ] } ], "roles" : [ { "refName" : "...", "roleType" : "..." }, { "refName" : "...", "roleType" : "..." } ], "displayName" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ], "hostTemplates" : [ { "refName" : "...", "roleConfigGroupsRefNames" : [ "...", "..." ], "cardinality" : 12345, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "refName" : "...", "roleConfigGroupsRefNames" : [ "...", "..." ], "cardinality" : 12345, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ], "displayName" : "...", "cmVersion" : "...", "instantiator" : { "clusterName" : "...", "hosts" : [ { "hostName" : "...", "hostNameRange" : "...", "rackId" : "...", "hostTemplateRefName" : "...", "roleRefNames" : [ "...", "..." ] }, { "hostName" : "...", "hostNameRange" : "...", "rackId" : "...", "hostTemplateRefName" : "...", "roleRefNames" : [ "...", "..." ] } ], "variables" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "roleConfigGroups" : [ { "rcgRefName" : "...", "name" : "..." }, { "rcgRefName" : "...", "name" : "..." } ], "clusterSpec" : { "dataContextRefs" : [ {}, {} ] }, "keepHostTemplates" : true, "lenient" : true, "enableKerberos" : { "datanodeTransceiverPort" : 12345, "datanodeWebPort" : 12345 } }, "repositories" : [ "...", "..." ], "clusterSpec" : { "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ] }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } }, "description" : "Cluster template" } } } }, "/clusters/{clusterName}/getOzoneBucketInfo" : { "get" : { "tags" : [ "ClustersResource" ], "summary" : "Returns the properties of the provided ozone bucket if the bucket exists.", "description" : "Returns the properties of the provided ozone bucket if the bucket exists.", "operationId" : "getOzoneBucketInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "bucketName", "in" : "query", "type" : "string", "description" : "" }, { "name" : "volumeName", "in" : "query", "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiOzoneBucketInfo" }, "headers" : {}, "examples" : { "application/json" : { "volumeName" : "...", "bucketName" : "...", "bucketType" : "...", "bucketEncrypted" : true, "bucketInS3Volume" : true, "bucketLinked" : true, "sourceVolumeName" : "...", "sourceBucketName" : "..." } }, "description" : "" } } } }, "/clusters/{clusterName}/getOzoneS3GatewayInfo" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Returns the REST url for the Ozone S3 Gateway, as well as the AWS\ncredentials needed to access the S3 endpoint.", "description" : "Returns the REST url for the Ozone S3 Gateway, as well as the AWS\ncredentials needed to access the S3 endpoint. Additionally, creates\na bucket with the specified name under the volume s3v. If no Ozone is\npresent, or Ozone is not running, returns success with an empty response.\n\nCurrently, we get the credentials for the Hive kerberos principal, and\ngive ownership of the created bucket to the same. This is likely not\na permanent solution. If the cluster is not kerberizied, we return dummy\ncredentials.\n\nRequires CDH 7.2.1+ or CDH 7.1.3+", "operationId" : "getOzoneS3GatewayInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster" }, { "name" : "bucketName", "in" : "query", "type" : "string", "description" : "the name of the bucket to create" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiOzoneS3GatewayInfo" }, "headers" : {}, "examples" : { "application/json" : { "awsAccessKey" : "...", "awsSecret" : "...", "restUrl" : "...", "bucket" : "..." } }, "description" : "The REST url and AWS credentials for S3 Gateway" } } } }, "/clusters/{clusterName}/hosts" : { "delete" : { "tags" : [ "ClustersResource" ], "description" : "", "operationId" : "removeAllHosts", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostRefList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "hostId" : "...", "hostname" : "..." }, { "hostId" : "...", "hostname" : "..." } ] } }, "description" : "all the hosts that were unassociated with the cluster" } } }, "get" : { "tags" : [ "ClustersResource" ], "summary" : "Returns hosts in the system filtered by optional host configuration parameters,\nif specified.", "description" : "Returns hosts in the system filtered by optional host configuration parameters,\nif specified.", "operationId" : "listHosts", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the cluster" }, { "name" : "configName", "in" : "query", "type" : "string", "description" : "optional host config name to filter hosts by. Available from v40." }, { "name" : "configValue", "in" : "query", "type" : "string", "description" : "host config value associated with config name. Available from v40." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view to materialize" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "UNKNOWN" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTED" } ], "healthSummary" : "DISABLED", "healthChecks" : [ { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "OFFLINED", "maintenanceOwners" : [ "SERVICE", "CLUSTER" ], "config" : { "items" : [ {}, {} ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "BAD_HEALTH", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "RHEL8_PPC64LE", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPED" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "BUSY" } ], "healthSummary" : "BAD", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "OFFLINED", "maintenanceOwners" : [ "CONTROL_PLANE", "CONTROL_PLANE" ], "config" : { "items" : [ {}, {} ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "NONE", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "UBUNTU_MAVERICK", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] } }, "description" : "A list of hosts in requested cluster" } } }, "post" : { "tags" : [ "ClustersResource" ], "description" : "", "operationId" : "addHosts", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostRefList" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostRefList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "hostId" : "...", "hostname" : "..." }, { "hostId" : "...", "hostname" : "..." } ] } }, "description" : "the newly added hosts to the cluster.\nif a host is already a member,\nit will be excluded from the list" } } } }, "/clusters/{clusterName}/isTlsEnabled" : { "get" : { "tags" : [ "ClustersResource" ], "summary" : "Returns whether a cluster has any TLS settings enabled.", "description" : "Returns whether a cluster has any TLS settings enabled. This only checks settings that\nwould have been enabled by Auto-TLS.", "operationId" : "isTlsEnabled", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster" } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "boolean" }, "headers" : {}, "examples" : {}, "description" : "true if it has any TLS settings enabled" } } } }, "/clusters/{clusterName}/kerberosInfo" : { "get" : { "tags" : [ "ClustersResource" ], "summary" : "Provides Cluster Kerberos information.", "description" : "Provides Cluster Kerberos information", "operationId" : "getKerberosInfo", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The cluster name." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiKerberosInfo" }, "headers" : {}, "examples" : { "application/json" : { "kerberized" : true, "kdcType" : "...", "kerberosRealm" : "...", "kdcHost" : "...", "adminHost" : "...", "domain" : [ "...", "..." ] } }, "description" : "Cluster Kerberos information" } } } }, "/clusters/{clusterName}/serviceTypes" : { "get" : { "tags" : [ "ClustersResource" ], "summary" : "List the supported service types for a cluster.", "description" : "List the supported service types for a cluster.", "operationId" : "listServiceTypes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The cluster." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiServiceTypeList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ "...", "..." ] } }, "description" : "List of service types the cluster supports." } } } }, "/clusters/{clusterName}/tags" : { "delete" : { "tags" : [ "ClustersResource" ], "summary" : "Remove the tags associated with the cluster.", "description" : "Remove the tags associated with the cluster. Tag names beginning with\nthe prefix _cldr_ (case insensitive) are reserved for internal use by Cloudera.", "operationId" : "deleteTags", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the cluster to remove tags from" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "description" : "" } ], "responses" : { "204" : { "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "headers" : {}, "examples" : { "application/json" : [ { "name" : "...", "value" : "..." } ] }, "description" : "A list of tags that were removed from the cluster" } } }, "get" : { "tags" : [ "ClustersResource" ], "summary" : "Returns the tags associated with this cluster.", "description" : "Returns the tags associated with this cluster. Tag names beginning with\nthe prefix _cldr_ (case insensitive) are reserved for internal use by Cloudera.", "operationId" : "readTags", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster" }, { "name" : "limit", "in" : "query", "default" : "10", "type" : "integer", "description" : "Number of tags" }, { "name" : "offset", "in" : "query", "default" : "0", "type" : "integer", "description" : "Index of the first tag to retrieve" } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "headers" : {}, "examples" : { "application/json" : [ { "name" : "...", "value" : "..." } ] }, "description" : "A list of tags associated with the cluster" } } }, "put" : { "tags" : [ "ClustersResource" ], "summary" : "Attach tags to the cluster.", "description" : "Attach tags to the cluster. Tag names beginning with the prefix\n_cldr_ (case insensitive) are reserved for internal use by Cloudera.", "operationId" : "addTags", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the cluster" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "description" : "list of tags to add" } ], "responses" : { "204" : { "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "headers" : {}, "examples" : { "application/json" : [ { "name" : "...", "value" : "..." } ] }, "description" : "" } } } }, "/clusters/{clusterName}/upgradeDomains" : { "get" : { "tags" : [ "ClustersResource" ], "summary" : "Returns the Upgrade Domains associated with the cluster and the host names that belong to each\nUpgrade Domain.", "description" : "Returns the Upgrade Domains associated with the cluster and the host names that belong to each\nUpgrade Domain. Hosts without an Upgrade Domain set will default to using the rack assignment\nof the host.", "operationId" : "listUpgradeDomains", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHdfsUpgradeDomainList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "key" : "...", "value" : { "items" : [ "...", "..." ] } }, { "key" : "...", "value" : { "items" : [ "...", "..." ] } } ] } }, "description" : "A list of upgrade domains and the corresponding host names." } } } }, "/clusters/{clusterName}/utilization" : { "get" : { "tags" : [ "ClustersResource" ], "summary" : "Provides the resource utilization of the entire cluster as well as the\nresource utilization per tenant.", "description" : "Provides the resource utilization of the entire cluster as well as the\nresource utilization per tenant. Only available with Cloudera Manager Enterprise Edition.", "operationId" : "getUtilizationReport", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "cluster name" }, { "name" : "daysOfWeek", "in" : "query", "type" : "array", "items" : { "type" : "string" }, "collectionFormat" : "multi", "description" : "The days of the week for which the user wants to report utilization.\nDays is a list of number between 1 to 7, where 1 corresponds to Monday,\nand 7 corrensponds to Sunday. All 7 days are included if this is not specified." }, { "name" : "endHourOfDay", "in" : "query", "default" : "23", "type" : "integer", "description" : "The end hour of a day for which the user wants to report utilization.\nThe hour is a number between [0-23]. Default value is 23 if this is not specified." }, { "name" : "from", "in" : "query", "type" : "string", "description" : "Start of the time range to report utilization in ISO 8601 format." }, { "name" : "startHourOfDay", "in" : "query", "default" : "0", "type" : "integer", "description" : "The start hour of a day for which the user wants to report utilization.\nThe hour is a number between [0-23]. Default value is 0 if this is not specified." }, { "name" : "tenantType", "in" : "query", "default" : "POOL", "type" : "string", "description" : "The type of the tenant (POOL or USER)." }, { "name" : "to", "in" : "query", "default" : "now", "type" : "string", "description" : "End of the the time range to report utilization in ISO 8601 format (defaults to now)." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiClusterUtilization" }, "headers" : {}, "examples" : { "application/json" : { "totalCpuCores" : 12345.0, "avgCpuUtilization" : 12345.0, "maxCpuUtilization" : 12345.0, "avgCpuDailyPeak" : 12345.0, "avgWorkloadCpu" : 12345.0, "maxWorkloadCpu" : 12345.0, "avgWorkloadCpuDailyPeak" : 12345.0, "totalMemory" : 12345.0, "avgMemoryUtilization" : 12345.0, "maxMemoryUtilization" : 12345.0, "avgMemoryDailyPeak" : 12345.0, "avgWorkloadMemory" : 12345.0, "maxWorkloadMemory" : 12345.0, "avgWorkloadMemoryDailyPeak" : 12345.0, "tenantUtilizations" : { "items" : [ { "tenantName" : "...", "cpuUtilizationPercentage" : 12345.0, "memoryUtilizationPercentage" : 12345.0 }, { "tenantName" : "...", "cpuUtilizationPercentage" : 12345.0, "memoryUtilizationPercentage" : 12345.0 } ] }, "maxCpuUtilizationTimestampMs" : 12345, "maxMemoryUtilizationTimestampMs" : 12345, "maxWorkloadCpuTimestampMs" : 12345, "maxWorkloadMemoryTimestampMs" : 12345, "errorMessage" : "..." } }, "description" : "Cluster utilization report resource handler." } } } }, "/clusters/{clusterName}/commands/configureAutoTlsServices" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Configures all services in a cluster to use Auto-TLS.", "description" : "Configures all services in a cluster to use Auto-TLS", "operationId" : "configureAutoTlsServicesCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/configureForKerberos" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Command to configure the cluster to use Kerberos for authentication.", "description" : "Command to configure the cluster to use Kerberos for authentication.\n\nThis command will configure all relevant services on a cluster for\nKerberos usage. This command will trigger a GenerateCredentials command\nto create Kerberos keytabs for all roles in the cluster.", "operationId" : "configureForKerberos", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigureForKerberosArguments" }, "description" : "Arguments for the configure for kerberos command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/deleteCredentials" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Delete existing Kerberos credentials for the cluster.", "description" : "Delete existing Kerberos credentials for the cluster.\n
\nThis command will affect all services that have been configured to use\nKerberos, and have existing credentials.", "operationId" : "deleteClusterCredentialsCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "cluster name" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/deployClientConfig" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Deploy the cluster-wide client configuration.", "description" : "Deploy the cluster-wide client configuration.\n\n
For each service in the cluster, deploy the service's client configuration\nto all the hosts that the service runs on.
\n\nAvailable since API v2.
", "operationId" : "deployClientConfig", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/deployClientConfigsAndRefresh" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Performs a command with the 2 steps\n- deploy cc\n- cluster refresh\n\nThis orchestration is needed for the staleness wizard, so it can invoke\na single command at wizard finish.", "description" : "Performs a command with the 2 steps\n- deploy cc\n- cluster refresh\n\nThis orchestration is needed for the staleness wizard, so it can invoke\na single command at wizard finish.", "operationId" : "deployClientConfigsAndRefresh", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/deployClusterClientConfig" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Deploy the Cluster's Kerberos client configuration.", "description" : "Deploy the Cluster's Kerberos client configuration.\n\n\nDeploy krb5.conf to hosts in a cluster. Does not deploy to decommissioned\nhosts or hosts with active processes.\n
\n\n\nAvailable since API v7.\n
", "operationId" : "deployClusterClientConfig", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostRefList" }, "description" : "Hosts in cluster to deploy to. If empty, will target all eligible\nhosts in the cluster." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/disableTls" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Disables TLS settings on a cluster.", "description" : "Disables TLS settings on a cluster.", "operationId" : "disableTls", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/enterMaintenanceMode" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Put the cluster into maintenance mode.", "description" : "Put the cluster into maintenance mode. This is a synchronous command.\nThe result is known immediately upon return.\n\nAvailable since API v2.
", "operationId" : "enterMaintenanceMode", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/clusters/{clusterName}/commands/exitMaintenanceMode" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Take the cluster out of maintenance mode.", "description" : "Take the cluster out of maintenance mode. This is a synchronous command.\nThe result is known immediately upon return.\n\nAvailable since API v2.
", "operationId" : "exitMaintenanceMode", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/clusters/{clusterName}/commands/expireLogs" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Remove backup and disaster related log files in hdfs.", "description" : "Remove backup and disaster related log files in hdfs.", "operationId" : "expireLogs", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." }, { "name" : "days", "in" : "query", "default" : "-2", "type" : "integer", "description" : "Logs more than these many days old are purged. By default, it uses the\nvalue defined in the CM configuration. Set to -2 to explicitly set to\ndefault." }, { "name" : "scheduleNext", "in" : "query", "default" : "false", "type" : "boolean", "description" : "Whether to schedule a next run for the command, or not. If set to , the next run will get scheduled after this one finished. If a\nschedule already exists, it will be updated. Can be omitted, the default\nvalue is false." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/firstRun" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Prepare and start services in a cluster.", "description" : "Prepare and start services in a cluster.\n\n\nPerform all the steps needed to prepare each service in a cluster and start the services\nin order.\n
\n\n\nAvailable since API v7.\n
", "operationId" : "firstRun", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/inspectHosts" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Runs the host inspector on the configured hosts in the specified cluster.", "description" : "Runs the host inspector on the configured hosts in the specified cluster.\n\nAvailable since V8.", "operationId" : "inspectHostsCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/perfInspector" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Run cluster performance diagnostics test.", "description" : "Run cluster performance diagnostics test.", "operationId" : "perfInspectorCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiClusterPerfInspectorArgs" }, "description" : "Optional arguments for the command. See ApiClusterPerfInspectorArgs." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/poolsRefresh" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Updates all refreshable configuration files for services with\nDynamic Resource Pools.", "description" : "Updates all refreshable configuration files for services with\nDynamic Resource Pools.\n\nAvailable since API v6.", "operationId" : "poolsRefresh", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/postClouderaRuntimeUpgrade" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Post Cloudera Runtime upgrade API.", "description" : "Post Cloudera Runtime upgrade API.\n
\nThis API executes special finalization tasks (already part of regular CDH upgrade) after the installation of an updated build of Cloudera Runtime (no version change).\nNo version change of Cloudera Rumtime means when first 3 digits of build remains the same (e.g. from 7.2.1.a to 7.2.1.b) during upgrade.\nPurpose of this is to automate manual tasks of CDH upgrade.\n
", "operationId" : "postClouderaRuntimeUpgrade", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/commands/preUpgradeCheck" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Run cluster pre-upgrade check(s) when upgrading from\nspecified version of CDH to the other.", "description" : "Run cluster pre-upgrade check(s) when upgrading from\nspecified version of CDH to the other.\n
\nAllows the following upgrade checks:\n
\nAvailable since API v6.", "operationId" : "refresh", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/restart" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Restart all services in the cluster.", "description" : "Restart all services in the cluster.\n
\nServices are stopped then started in the appropriate order given their\ndependencies. The command can optionally restart only stale services and\ntheir dependencies as well as redeploy client configuration on all services\nin the cluster.", "operationId" : "restartCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRestartClusterArgs" }, "description" : "arguments for the restart command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/rollingRestart" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Command to do a \"best-effort\" rolling restart of the given cluster,\ni.", "description" : "Command to do a \"best-effort\" rolling restart of the given cluster,\ni.e. it does plain restart of services that cannot be rolling restarted,\nfollowed by first rolling restarting non-slaves and then rolling restarting\nthe slave roles of services that can be rolling restarted. The slave restarts\nare done host-by-host.\n
\nAvailable since API v4. Only available with Cloudera Manager Enterprise\nEdition.", "operationId" : "rollingRestart", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRollingRestartClusterArgs" }, "description" : "Arguments for the rolling restart command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/rollingUpgrade" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Command to do a rolling upgrade of specific services in the given cluster\n\nThis command does not handle any services that don't support rolling\nupgrades.", "description" : "Command to do a rolling upgrade of specific services in the given cluster\n\nThis command does not handle any services that don't support rolling\nupgrades. The command will throw an error and not start if upgrade of any\nsuch service is requested.\n\nThis command does not upgrade the full CDH Cluster. You should normally\nuse the upgradeCDH Command for upgrading the cluster. This is primarily\nhelpful if you need to need to recover from an upgrade failure or for\nadvanced users to script an alternative to the upgradeCdhCommand.\n\nThis command expects the binaries to be available on hosts and activated.\nIt does not change any binaries on the hosts.", "operationId" : "rollingUpgrade", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRollingUpgradeServicesArgs" }, "description" : "Arguments for the rolling upgrade command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/start" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Start all services in the cluster.", "description" : "Start all services in the cluster.\n
\nServices are started in the appropriate order given their dependencies.", "operationId" : "startCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/stop" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Stop all services in the cluster.", "description" : "Stop all services in the cluster.\n
\nServices are stopped in the appropriate order given their dependencies.", "operationId" : "stopCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/upgradeCdh" : { "post" : { "tags" : [ "ClustersResource" ], "summary" : "Perform CDH upgrade to the specified version.", "description" : "Perform CDH upgrade to the specified version.\n
\nAllows the following upgrades:\n
\nIf using packages, CDH packages on all hosts of the cluster must be\nmanually upgraded before this command is issued.\n
\nThe command will upgrade the services and their configuration to the\nversion available in the CDH5 distribution.\n
\nUnless rolling upgrade options are provided, the entire cluster will\nexperience downtime. If rolling upgrade options are provided, command will\ndo a \"best-effort\" rolling upgrade of the given cluster, i.e. it does\nplain upgrade of services that cannot be rolling upgraded, followed by\nfirst rolling upgrading non-slaves and then rolling restarting the slave\nroles of services that can be rolling restarted. The slave restarts are\ndone host-by-host.\n
\nAvailable since v9. Rolling upgrade is only available with Cloudera\nManager Enterprise Edition. A more limited upgrade variant available since\nv6.", "operationId" : "upgradeCdhCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiCdhUpgradeArgs" }, "description" : "Arguments for the command. See ApiCdhUpgradeArgs." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/commands/upgradeServices" : { "post" : { "deprecated" : true, "tags" : [ "ClustersResource" ], "summary" : "Upgrades the services in the cluster to the CDH5 version.", "description" : "Upgrades the services in the cluster to the CDH5 version.\n
\nThis command requires that the CDH packages in the hosts used by the\ncluster be upgraded to CDH5 before this command is issued. Once issued,\nthis command will stop all running services before proceeding.\n
\nIf parcels are used instead of CDH system packages then the following\nsteps need to happen in order:\n
\nTear Down Ranger plugin service (repository) associated with the workload cluster.", "operationId" : "tearDownWorkloadCluster", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." }, { "name" : "workloadClusterName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the workload cluster." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/cm/peers" : { "get" : { "tags" : [ "CmPeersResource" ], "summary" : "Retrieves all configured Cloudera Manager peers.", "description" : "Retrieves all configured Cloudera Manager peers.\n
\nAvailable since API v3. Only available with Cloudera Manager Enterprise\nEdition.\n
\nWhen accessed via API version before v11, only REPLICATION type peers will\nbe returned.", "operationId" : "listPeers", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCmPeerList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "STATUS_AGGREGATION", "url" : "...", "username" : "...", "password" : "...", "clouderaManagerCreatedUser" : true, "createUserWithAdminRole" : true }, { "name" : "...", "type" : "REPLICATION", "url" : "...", "username" : "...", "password" : "...", "clouderaManagerCreatedUser" : true, "createUserWithAdminRole" : true } ] } }, "description" : "List of Cloudera Manager peers." } } }, "post" : { "tags" : [ "CmPeersResource" ], "summary" : "Create a new Cloudera Manager peer.", "description" : "Create a new Cloudera Manager peer.\n
\nThe remote server will be contacted so that a user can be created\nfor use by the new peer. The username and password\nproperties of the provided peer object should contain credentials\nof a valid admin user on the remote server. A timeout of 10 seconds\nis enforced when contacting the remote server.\n
\nIt is recommended to run the remote server with TLS enabled, since\ncreating and using peers involve transferring credentials over the\nnetwork.\n
\nAvailable since API v3. Only available with Cloudera Manager Enterprise\nEdition.\n
\nType field in ApiCmPeer is available since API v11. if not specified\nwhen making createPeer() call, 'REPLICATION' type peer will be created.", "operationId" : "createPeer", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiCmPeer" }, "description" : "Peer to create (see above)." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCmPeer" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "type" : "REPLICATION", "url" : "...", "username" : "...", "password" : "...", "clouderaManagerCreatedUser" : true, "createUserWithAdminRole" : true } }, "description" : "Information about the created peer." } } } }, "/cm/peers/{peerName}" : { "delete" : { "tags" : [ "CmPeersResource" ], "summary" : "Delete Cloudera Manager peer.", "description" : "Delete Cloudera Manager peer.\n
\nAn attempt will be made to contact the peer server, so that the configured\nuser can be deleted.. Errors while contacting the remote server are\nnon-fatal.\n
\nAvailable since API v11. Only available with Cloudera Manager Enterprise\nEdition.", "operationId" : "deletePeer", "produces" : [ "application/json" ], "parameters" : [ { "name" : "peerName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of peer to delete." }, { "name" : "type", "in" : "query", "type" : "string", "enum" : [ "REPLICATION", "STATUS_AGGREGATION" ], "description" : "Type of peer to delete. If null, REPLICATION peer type will\nbe deleted." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCmPeer" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "type" : "REPLICATION", "url" : "...", "username" : "...", "password" : "...", "clouderaManagerCreatedUser" : true, "createUserWithAdminRole" : true } }, "description" : "Information about the deleted peer." } } }, "get" : { "tags" : [ "CmPeersResource" ], "summary" : "Fetch information about an existing Cloudera Manager peer.", "description" : "Fetch information about an existing Cloudera Manager peer.\n
\nAvailable since API v11. Only available with Cloudera Manager Enterprise\nEdition.", "operationId" : "readPeer", "produces" : [ "application/json" ], "parameters" : [ { "name" : "peerName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of peer to retrieve." }, { "name" : "type", "in" : "query", "type" : "string", "enum" : [ "REPLICATION", "STATUS_AGGREGATION" ], "description" : "Type of peer to retrieve. If null, REPLICATION peer type\nwill be returned." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCmPeer" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "type" : "STATUS_AGGREGATION", "url" : "...", "username" : "...", "password" : "...", "clouderaManagerCreatedUser" : true, "createUserWithAdminRole" : true } }, "description" : "Peer information." } } }, "put" : { "tags" : [ "CmPeersResource" ], "summary" : "Update information for a Cloudera Manager peer.", "description" : "Update information for a Cloudera Manager peer.\n
\nIn administrator credentials are provided in the peer information, they\nwill be used to establish new credentials with the remote server. This\ncan be used in case the old credentials are not working anymore. An\nattempt will be made to delete the old credentials if new ones are\nsuccessfully created.\n
\nIf changing the peer's URL, an attempt will be made to contact the old\nCloudera Manager to delete the existing credentials.\n
\nAvailable since API v3. Only available with Cloudera Manager Enterprise\nEdition.", "operationId" : "updatePeer", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "peerName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of peer to update." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiCmPeer" }, "description" : "Updated peer information." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCmPeer" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "type" : "STATUS_AGGREGATION", "url" : "...", "username" : "...", "password" : "...", "clouderaManagerCreatedUser" : true, "createUserWithAdminRole" : true } }, "description" : "The updated peer information." } } } }, "/cm/peers/{peerName}/commands/test" : { "post" : { "tags" : [ "CmPeersResource" ], "summary" : "Test the connectivity of a peer.", "description" : "Test the connectivity of a peer.\n
\nAvailable since API v11. Only available with Cloudera Manager Enterprise\nEdition.", "operationId" : "testPeer", "produces" : [ "application/json" ], "parameters" : [ { "name" : "peerName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of peer to test." }, { "name" : "type", "in" : "query", "type" : "string", "enum" : [ "REPLICATION", "STATUS_AGGREGATION" ], "description" : "Type of peer to test. If null, REPLICATION peer type will\nbe tested." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/commands/commands" : { "get" : { "tags" : [ "CommandsResource" ], "summary" : "Retrieve detailed information on all recent commands.", "description" : "Retrieve detailed information on all recent commands.", "operationId" : "readCommands", "produces" : [ "application/json" ], "parameters" : [ { "name" : "endTime", "in" : "query", "default" : "-1", "type" : "integer", "description" : "timestamp of the command end time" }, { "name" : "limit", "in" : "query", "default" : "50", "type" : "integer", "description" : "command count to return (from offset)" }, { "name" : "name", "in" : "query", "type" : "string", "description" : "the command name, unique for the command class HdfsCreateSnapshotCommand#COMMAND_NAME" }, { "name" : "offset", "in" : "query", "default" : "0", "type" : "integer", "description" : "command position to start" }, { "name" : "startTime", "in" : "query", "default" : "-1", "type" : "integer", "description" : "timestamp of the command start time" }, { "name" : "success", "in" : "query", "type" : "boolean", "description" : "whether the command was successful, if already finished" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommandList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "Detailed information about recent asynchronous commands." } } } }, "/commands/{commandId}" : { "get" : { "tags" : [ "CommandsResource" ], "summary" : "Retrieve detailed information on an asynchronous command.", "description" : "Retrieve detailed information on an asynchronous command.\n\n
Cloudera Manager keeps the results and statuses of asynchronous\ncommands, which have non-negative command IDs. On the other hand,\nsynchronous commands complete immediately, and their results are passed\nback in the return object of the command execution API call.\nOutside of that return object, there is no way to check the result\nof a synchronous command.
", "operationId" : "readCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "commandId", "in" : "path", "required" : true, "type" : "integer", "description" : "The command id." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Detailed command information." } } } }, "/commands/{commandId}/abort" : { "post" : { "tags" : [ "CommandsResource" ], "summary" : "Abort a running command.", "description" : "Abort a running command.", "operationId" : "abortCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "commandId", "in" : "path", "required" : true, "type" : "integer", "description" : "The command id." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Detailed command information." } } } }, "/commands/{commandId}/download" : { "get" : { "tags" : [ "CommandsResource" ], "summary" : "Download the end result of a command.", "description" : "Download the end result of a command.\n\nContent-Type header is explicitly set in the implementation instead of using annotation. In\ncase the MIME type is not set for the command result, application/octet-stream is set.", "operationId" : "getCommandResultData", "produces" : [ "application/json" ], "parameters" : [ { "name" : "commandId", "in" : "path", "required" : true, "type" : "integer", "description" : "The command id." } ], "responses" : { "200" : { "schema" : { "type" : "file", "description" : "" }, "headers" : {}, "examples" : {}, "description" : "The command result." } } } }, "/commands/{commandId}/retry" : { "post" : { "tags" : [ "CommandsResource" ], "summary" : "Try to rerun a command.", "description" : "Try to rerun a command.", "operationId" : "retry", "produces" : [ "application/json" ], "parameters" : [ { "name" : "commandId", "in" : "path", "required" : true, "type" : "integer", "description" : "ID of the command that needs to be run." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Command that represents the retry attempt." } } } }, "/commands/{commandId}/steps" : { "get" : { "tags" : [ "CommandsResource" ], "summary" : "Retrieve detailed information of an asynchronous command including the command steps.", "description" : "Retrieve detailed information of an asynchronous command including the command steps.\n\nCloudera Manager keeps the results and statuses of asynchronous\ncommands, which have non-negative command IDs. On the other hand,\nsynchronous commands complete immediately, and their results are passed\nback in the return object of the command execution API call.\nOutside of that return object, there is no way to check the result\nof a synchronous command.
", "operationId" : "getCommandWithSteps", "produces" : [ "application/json" ], "parameters" : [ { "name" : "commandId", "in" : "path", "required" : true, "type" : "integer", "description" : "The command id." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommandWithSteps" }, "headers" : {}, "examples" : { "application/json" : { "displayName" : "...", "steps" : [ { "description" : "...", "startTime" : "...", "endTime" : "...", "state" : "RUNNING", "resultMessage" : "...", "ignoreError" : true, "parallel" : true, "processes" : [ { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 }, { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 } ], "clientConfigs" : [ { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 }, { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 } ], "roles" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "NA" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTING" } ], "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "hosts" : [ { "hostId" : "...", "hostname" : "..." }, { "hostId" : "...", "hostname" : "..." } ], "services" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "children" : [ {}, {} ], "commands" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "remoteCommand" : { "id" : 12345, "peerName" : "..." } }, { "description" : "...", "startTime" : "...", "endTime" : "...", "state" : "NOT_RUN", "resultMessage" : "...", "ignoreError" : true, "parallel" : true, "processes" : [ { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 }, { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 } ], "clientConfigs" : [ { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 }, { "name" : "...", "id" : 12345, "program" : "...", "args" : "...", "stdout" : "...", "stderr" : "...", "exitCode" : 12345 } ], "roles" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "UNKNOWN" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" } ], "clusters" : [ { "clusterName" : "...", "displayName" : "..." }, { "clusterName" : "...", "displayName" : "..." } ], "hosts" : [ { "hostId" : "...", "hostname" : "..." }, { "hostId" : "...", "hostname" : "..." } ], "services" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "children" : [ {}, {} ], "commands" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "remoteCommand" : { "id" : 12345, "peerName" : "..." } } ], "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Detailed command information including the command steps." } } } }, "/commands/{commandId}/logs/stderr" : { "get" : { "tags" : [ "CommandsResource" ], "summary" : "Download a zip-compressed archive of standard error outputs for the command's one-off processes.", "description" : "Download a zip-compressed archive of standard error outputs for the command's one-off processes.\n\nLog files are returned zipped together.", "operationId" : "getStandardError", "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "commandId", "in" : "path", "required" : true, "type" : "integer", "description" : "The command id." } ], "responses" : { "200" : { "schema" : { "type" : "file", "description" : "" }, "headers" : {}, "examples" : {}, "description" : "Contents of the role's standard output." } } } }, "/commands/{commandId}/logs/stdout" : { "get" : { "tags" : [ "CommandsResource" ], "summary" : "Download a zip-compressed archive of standard outputs for the command's one-off processes.", "description" : "Download a zip-compressed archive of standard outputs for the command's one-off processes.\n\nLog files are returned zipped together.", "operationId" : "getStandardOutput", "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "commandId", "in" : "path", "required" : true, "type" : "integer", "description" : "The command id." } ], "responses" : { "200" : { "schema" : { "type" : "file", "description" : "" }, "headers" : {}, "examples" : {}, "description" : "Contents of the role's standard output." } } } }, "/controlPlanes" : { "get" : { "tags" : [ "ControlPlanesResource" ], "summary" : "Current Control Planes.", "description" : "Current Control Planes", "operationId" : "getControlPlanes", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiControlPlaneList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "namespace" : "...", "dnsSuffix" : "...", "uuid" : "...", "remoteRepoUrl" : "...", "version" : "...", "manifest" : "...", "valuesYaml" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "kubernetesType" : "..." }, { "namespace" : "...", "dnsSuffix" : "...", "uuid" : "...", "remoteRepoUrl" : "...", "version" : "...", "manifest" : "...", "valuesYaml" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "kubernetesType" : "..." } ] } }, "description" : "Detailed description of the current control planes." } } } }, "/controlPlanes/{controlPlaneUuid}" : { "get" : { "tags" : [ "ControlPlanesResource" ], "summary" : "The control plane with the given id.", "description" : "The control plane with the given id", "operationId" : "readControlPlaneByUuid", "produces" : [ "application/json" ], "parameters" : [ { "name" : "controlPlaneUuid", "in" : "path", "required" : true, "type" : "string", "description" : "The universally unique id of the control plane" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiControlPlane" }, "headers" : {}, "examples" : { "application/json" : { "namespace" : "...", "dnsSuffix" : "...", "uuid" : "...", "remoteRepoUrl" : "...", "version" : "...", "manifest" : "...", "valuesYaml" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "kubernetesType" : "..." } }, "description" : "Detailed description of the control plane." } } } }, "/controlPlanes/commands/generateCopyDocker" : { "post" : { "tags" : [ "ControlPlanesResource" ], "summary" : "Launches the Generate Copy Docker Script Command.", "description" : "Launches the Generate Copy Docker Script Command", "operationId" : "generateCopyDocker", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiGenerateCopyDockerArgs" }, "description" : "Arguments for the Command" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "The command that generates the script" } } } }, "/controlPlanes/commands/generateExternalVaultSetup" : { "post" : { "tags" : [ "ControlPlanesResource" ], "summary" : "Launches the Generate Vault Setup Command command.", "description" : "Launches the Generate Vault Setup Command command", "operationId" : "generateExternalVaultSetup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiGenerateExternalVaultSetupArgs" }, "description" : "Arguments for the Command" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "The command that generates and downloads the script" } } } }, "/controlPlanes/commands/installControlPlane" : { "post" : { "tags" : [ "ControlPlanesResource" ], "summary" : "Launches the install control plane command.", "description" : "Launches the install control plane command.", "operationId" : "installControlPlane", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiInstallControlPlaneArgs" }, "description" : "Arguments for the Command" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "The command that install a control plane." } } } }, "/controlPlanes/commands/installEmbeddedControlPlane" : { "post" : { "tags" : [ "ControlPlanesResource" ], "summary" : "Brings up a control plane on embedded kubernetes.", "description" : "Brings up a control plane on embedded kubernetes.\nAt its core, this command launches the FirstRun command\non the Containerized Cluster.", "operationId" : "installEmbeddedControlPlane", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiInstallEmbeddedControlPlaneArgs" }, "description" : "The arguments for Ek8s control plane installation" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "The First Run command" } } } }, "/controlPlanes/commands/upgradeEmbeddedControlPlane" : { "post" : { "tags" : [ "ControlPlanesResource" ], "summary" : "Upgrade a Containerized Cluster, including upgrading the\ncontrol plane running on embedded kubernetes.", "description" : "Upgrade a Containerized Cluster, including upgrading the\ncontrol plane running on embedded kubernetes.", "operationId" : "upgradeEmbeddedControlPlane", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiUpgradeEmbeddedControlPlaneArgs" }, "description" : "The arguments for Ek8s control plane upgrade" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "The Upgrade Cluster command" } } } }, "/controlPlanes/fetchResources/manifest.json" : { "post" : { "tags" : [ "ControlPlanesResource" ], "summary" : "Fetches the manifest.", "description" : "Fetches the manifest.json under the specified remote repo.", "operationId" : "getManifestJson", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRemoteRepoUrl" }, "description" : "the remote repo url." } ], "responses" : { "201" : { "schema" : { "type" : "file", "description" : "" }, "headers" : {}, "examples" : { "application/json" : {} }, "description" : "the content of the manifest.json" } } } }, "/controlPlanes/{controlPlaneUuid}/getTaggedCluster" : { "get" : { "tags" : [ "ControlPlanesResource" ], "summary" : "The cluster with tags matching this control plane's UUID, if any.", "description" : "The cluster with tags matching this control plane's UUID, if any", "operationId" : "getExperienceCluster", "produces" : [ "application/json" ], "parameters" : [ { "name" : "controlPlaneUuid", "in" : "path", "required" : true, "type" : "string", "description" : "The universally unique id of the control plane" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCluster" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "displayName" : "...", "fullVersion" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "HOST" ], "services" : [ { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STARTED", "healthSummary" : "BAD", "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "HOST" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPED", "commissionState" : "DECOMMISSIONED", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "ROLE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "DOWN", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "HISTORY_NOT_AVAILABLE", "commissionState" : "COMMISSIONED", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "ROLE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "STANDALONE", "entityStatus" : "STARTING", "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" : {}, "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "WEEK", "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" : "CONCERNING_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "NA", "healthSummary" : "GOOD", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "SERVICE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "UNKNOWN", "commissionState" : "DECOMMISSIONING", "healthSummary" : "CONCERNING", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "ROLE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION", "entityStatus" : "HISTORY_NOT_AVAILABLE", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPED", "commissionState" : "DECOMMISSIONED", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "HOST" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_OBSERVER", "entityStatus" : "NONE", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "MINUTE", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "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" : "BAD_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." } ], "parcels" : [ { "product" : "...", "version" : "...", "stage" : "...", "state" : { "progress" : 12345, "totalProgress" : 12345, "count" : 12345, "totalCount" : 12345, "errors" : [ "...", "..." ], "warnings" : [ "...", "..." ] }, "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "displayName" : "...", "description" : "..." }, { "product" : "...", "version" : "...", "stage" : "...", "state" : { "progress" : 12345, "totalProgress" : 12345, "count" : 12345, "totalCount" : 12345, "errors" : [ "...", "..." ], "warnings" : [ "...", "..." ] }, "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "displayName" : "...", "description" : "..." } ], "clusterUrl" : "...", "hostsUrl" : "...", "entityStatus" : "STOPPED", "uuid" : "...", "dataContextRefs" : [ { "name" : "..." }, { "name" : "..." } ], "clusterType" : "...", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } }, "description" : "The cluster attached to this control plane" } } } }, "/controlPlanes/{controlPlaneUuid}/tags" : { "delete" : { "tags" : [ "ControlPlanesResource" ], "summary" : "Remove the tags associated with the control plane.", "description" : "Remove the tags associated with the control plane", "operationId" : "deleteTags", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "controlPlaneUuid", "in" : "path", "required" : true, "type" : "string", "description" : "The uuid of the control plane." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "description" : "A list of tags to remove from the control plane" } ], "responses" : { "204" : { "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "headers" : {}, "examples" : { "application/json" : [ { "name" : "...", "value" : "..." } ] }, "description" : "A list of tags that were removed from the control plane" } } }, "get" : { "tags" : [ "ControlPlanesResource" ], "summary" : "Returns the tags associated with this control plane.", "description" : "Returns the tags associated with this control plane.", "operationId" : "readTags", "produces" : [ "application/json" ], "parameters" : [ { "name" : "controlPlaneUuid", "in" : "path", "required" : true, "type" : "string", "description" : "The uuid of the control plane." }, { "name" : "limit", "in" : "query", "default" : "10", "type" : "integer", "description" : "Number of tags" }, { "name" : "offset", "in" : "query", "default" : "0", "type" : "integer", "description" : "Index of the first tag to retrieve" } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "headers" : {}, "examples" : { "application/json" : [ { "name" : "...", "value" : "..." } ] }, "description" : "A list of tags associated with the control plane" } } }, "put" : { "tags" : [ "ControlPlanesResource" ], "summary" : "Attach tags to the control plane.", "description" : "Attach tags to the control plane.", "operationId" : "addTags", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "controlPlaneUuid", "in" : "path", "required" : true, "type" : "string", "description" : "The uuid of the control plane." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "description" : "List of tags to add to the control plane" } ], "responses" : { "204" : { "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "headers" : {}, "examples" : { "application/json" : [ { "name" : "...", "value" : "..." } ] }, "description" : "A list of tags that were added to the control plane" } } } }, "/controlPlanes/fetchResources/{commandId}/logContent" : { "post" : { "tags" : [ "ControlPlanesResource" ], "summary" : "Fetches the log content for the specific command.", "description" : "Fetches the log content for the specific command.", "operationId" : "getLogContent", "produces" : [ "text/plain" ], "parameters" : [ { "name" : "commandId", "in" : "path", "required" : true, "type" : "integer", "description" : "the command id" } ], "responses" : { "201" : { "schema" : { "type" : "file", "description" : "" }, "headers" : {}, "examples" : {}, "description" : "the log content." } } } }, "/controlPlanes/{controlPlaneUuid}/commands/copyImagesInFeatures" : { "post" : { "tags" : [ "ControlPlanesResource" ], "summary" : "Launches the command to copy images for one or more features (a comma separated list).", "description" : "Launches the command to copy images for one or more features (a comma separated list).", "operationId" : "copyImagesInFeatures", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "controlPlaneUuid", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiCopyImagesInFeaturesArgs" }, "description" : "Arguments for the Command" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "The command that does the copying." } } } }, "/controlPlanes/{controlPlaneUuid}/commands/uninstallControlPlane" : { "post" : { "tags" : [ "ControlPlanesResource" ], "summary" : "Launches Uninstall Command on the control plane with the given uuid.", "description" : "Launches Uninstall Command on the control plane with the given uuid", "operationId" : "uninstallControlPlane", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "controlPlaneUuid", "in" : "path", "required" : true, "type" : "string", "description" : "The universally unique id of the control plane" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiUninstallControlPlaneArgs" }, "description" : "Arguments for the Command" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "The command that uninstalls the control plane." } } } }, "/controlPlanes/{controlPlaneUuid}/commands/updateControlPlaneValuesYaml" : { "post" : { "tags" : [ "ControlPlanesResource" ], "summary" : "Launches update the values.", "description" : "Launches update the values.yaml from the control plane with the given uuid\nThis updates the content of values.yaml.merged in the CM database.", "operationId" : "updateValuesYaml", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "controlPlaneUuid", "in" : "path", "required" : true, "type" : "string", "description" : "The universally unique id of the control plane" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiUpdateControlPlaneValuesYamlArgs" }, "description" : "Arguments for the Command" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "The command that updates the current values.yaml.merged from the control plane." } } } }, "/controlPlanes/{controlPlaneUuid}/commands/upgradeControlPlane" : { "post" : { "tags" : [ "ControlPlanesResource" ], "summary" : "Launches the Upgrade Command on the control plane with the given uuid.", "description" : "Launches the Upgrade Command on the control plane with the given uuid", "operationId" : "upgradeControlPlane", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "controlPlaneUuid", "in" : "path", "required" : true, "type" : "string", "description" : "The universally unique id of the control plane" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiUpgradeControlPlaneArgs" }, "description" : "Arguments for the Command" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "The command that upgrades the control plane." } } } }, "/csp/uploadCspCert" : { "put" : { "tags" : [ "CspResource" ], "summary" : "Upload CA certificates, client certificates and client key for Credential Storage Provider.", "description" : "Upload CA certificates, client certificates and client key for Credential Storage Provider.\nCM server restart is needed for these certificates to be applied.", "operationId" : "uploadCspCert", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiCspArguments" }, "description" : "Arguments for the CSP" } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCspArguments" }, "headers" : {}, "examples" : { "application/json" : { "caCertContent" : "...", "certContent" : "...", "keyContent" : "..." } }, "description" : "Arguments to upload CA certificates, client certificates and client key for CSP" } } } }, "/timeseries/dashboards" : { "get" : { "tags" : [ "DashboardsResource" ], "summary" : "Returns the list of all user-customized dashboards.", "description" : "Returns the list of all user-customized dashboards. This includes both the\nnew dashboards created by users as well as any user customizations to\nbuilt-in dashboards.\n\nAvailable since API v6.", "operationId" : "getDashboards", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiDashboardList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "json" : "..." }, { "name" : "...", "json" : "..." } ] } }, "description" : "" } } }, "post" : { "tags" : [ "DashboardsResource" ], "summary" : "Creates the list of dashboards.", "description" : "Creates the list of dashboards. If any of the dashboards already exist\nthis whole command will fail and no dashboards will be created.\n
\nAvailable since API v6.", "operationId" : "createDashboards", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiDashboardList" }, "description" : "The list of dashboards to create." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiDashboardList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "json" : "..." }, { "name" : "...", "json" : "..." } ] } }, "description" : "The dashboards created." } } } }, "/timeseries/dashboards/{dashboardName}" : { "delete" : { "tags" : [ "DashboardsResource" ], "summary" : "Deletes a dashboard.", "description" : "Deletes a dashboard.\n\n
\nAvailable since API v6.", "operationId" : "deleteDashboard", "produces" : [ "application/json" ], "parameters" : [ { "name" : "dashboardName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the dashboard." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiDashboard" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "json" : "..." } }, "description" : "The deleted dashboard." } } }, "get" : { "tags" : [ "DashboardsResource" ], "summary" : "Returns a dashboard definition for the specified name.", "description" : "Returns a dashboard definition for the specified name. This dashboard\ncan be imported with the createDashboards API.\n
\nAvailable since API v6.", "operationId" : "getDashboard", "produces" : [ "application/json" ], "parameters" : [ { "name" : "dashboardName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the dashboard." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiDashboard" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "json" : "..." } }, "description" : "" } } } }, "/dataContexts" : { "get" : { "tags" : [ "DataContextsResource" ], "summary" : "Get all the datacontexts.", "description" : "Get all the datacontexts.", "operationId" : "readDataContexts", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiDataContextList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "displayName" : "...", "nameservice" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "services" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "servicesDetails" : [ { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "STARTED", "healthSummary" : "BAD", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "SERVICE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "CONCERNING_HEALTH", "tags" : [ {}, {} ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "STARTING", "healthSummary" : "DISABLED", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "CONTROL_PLANE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "HISTORY_NOT_AVAILABLE", "tags" : [ {}, {} ], "serviceVersion" : "..." } ], "supportedServiceTypes" : [ "...", "..." ], "allowedClusterVersions" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthSummary" : "GOOD" }, { "name" : "...", "displayName" : "...", "nameservice" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "services" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "servicesDetails" : [ { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "STARTING", "healthSummary" : "CONCERNING", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "SERVICE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "UNKNOWN_HEALTH", "tags" : [ {}, {} ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : {}, "serviceState" : "STARTING", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "ROLE" ], "config" : {}, "roles" : [ {}, {} ], "displayName" : "...", "roleConfigGroups" : [ {}, {} ], "replicationSchedules" : [ {}, {} ], "snapshotPolicies" : [ {}, {} ], "entityStatus" : "BAD_HEALTH", "tags" : [ {}, {} ], "serviceVersion" : "..." } ], "supportedServiceTypes" : [ "...", "..." ], "allowedClusterVersions" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthSummary" : "GOOD" } ] } }, "description" : "List of datacontext." } } }, "post" : { "tags" : [ "DataContextsResource" ], "summary" : "Create a datacontext.", "description" : "Create a datacontext. Following are are required fields of ApiDataContext:\nname,\ndisplayName,\nservices.", "operationId" : "createDataContext", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiDataContext" }, "description" : "DataContext to be created." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiDataContext" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "displayName" : "...", "nameservice" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "services" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "servicesDetails" : [ { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STARTING", "healthSummary" : "BAD", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "SERVICE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPED", "commissionState" : "OFFLINED", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "HOST" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "STANDALONE", "entityStatus" : "DISABLED_HEALTH", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STARTED", "commissionState" : "DECOMMISSIONED", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "CLUSTER" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION", "entityStatus" : "STOPPING", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "WEEK", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "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" : {}, "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" : "CONCERNING_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "HISTORY_NOT_AVAILABLE", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "CONTROL_PLANE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPED", "commissionState" : "OFFLINING", "healthSummary" : "CONCERNING", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "HOST" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "CONCERNING_HEALTH", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "HISTORY_NOT_AVAILABLE", "commissionState" : "UNKNOWN", "healthSummary" : "CONCERNING", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "HOST" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "GOOD_HEALTH", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "WEEK", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "YEAR", "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" : "STOPPING", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." } ], "supportedServiceTypes" : [ "...", "..." ], "allowedClusterVersions" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthSummary" : "CONCERNING" } }, "description" : "DataContext created." } } } }, "/dataContexts/{dataContextName}" : { "delete" : { "tags" : [ "DataContextsResource" ], "summary" : "Delete a datacontext.", "description" : "Delete a datacontext.", "operationId" : "deleteDataContext", "produces" : [ "application/json" ], "parameters" : [ { "name" : "dataContextName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the datacontext." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiDataContext" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "displayName" : "...", "nameservice" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "services" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "servicesDetails" : [ { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "UNKNOWN", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "HOST" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPING", "commissionState" : "DECOMMISSIONED", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "SERVICE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_OBSERVER", "entityStatus" : "CONCERNING_HEALTH", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "UNKNOWN", "commissionState" : "UNKNOWN", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "ROLE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "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" : {}, "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" : "CONCERNING_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "NA", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "CONTROL_PLANE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "BUSY", "commissionState" : "OFFLINED", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "HOST" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "STANDALONE", "entityStatus" : "HISTORY_NOT_AVAILABLE", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "UNKNOWN", "commissionState" : "OFFLINED", "healthSummary" : "CONCERNING", "configStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "HOST" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "NONE", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "MONTH", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "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" : "GOOD_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." } ], "supportedServiceTypes" : [ "...", "..." ], "allowedClusterVersions" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "STALE", "healthSummary" : "BAD" } }, "description" : "Deleted datacontext." } } }, "get" : { "tags" : [ "DataContextsResource" ], "summary" : "Reads information about a datacontext.", "description" : "Reads information about a datacontext.", "operationId" : "readDataContext", "produces" : [ "application/json" ], "parameters" : [ { "name" : "dataContextName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the datacontext." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiDataContext" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "displayName" : "...", "nameservice" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "services" : [ { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } ], "servicesDetails" : [ { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "NA", "healthSummary" : "BAD", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "SERVICE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "UNKNOWN", "commissionState" : "DECOMMISSIONED", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "HOST" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_OBSERVER", "entityStatus" : "GOOD_HEALTH", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPED", "commissionState" : "COMMISSIONED", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "CONTROL_PLANE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "DISABLED_HEALTH", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "DAY", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "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" : "NONE", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "UNKNOWN", "healthSummary" : "CONCERNING", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "SERVICE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPED", "commissionState" : "UNKNOWN", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "HOST" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "NONE", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "BUSY", "commissionState" : "UNKNOWN", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "HOST" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER", "entityStatus" : "GOOD_HEALTH", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "MINUTE", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "WEEK", "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" : "UNKNOWN_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." } ], "supportedServiceTypes" : [ "...", "..." ], "allowedClusterVersions" : [ { "key" : "...", "value" : "..." }, { "key" : "...", "value" : "..." } ], "configStalenessStatus" : "FRESH", "clientConfigStalenessStatus" : "FRESH", "healthSummary" : "BAD" } }, "description" : "Detailed description of the datacontext." } } } }, "/events" : { "get" : { "tags" : [ "EventsResource" ], "summary" : "Allows you to query events in the system.", "description" : "Allows you to query events in the system.", "operationId" : "readEvents", "produces" : [ "application/json" ], "parameters" : [ { "name" : "maxResults", "in" : "query", "default" : "100", "type" : "integer", "description" : "The maximum number of events to return." }, { "name" : "query", "in" : "query", "type" : "string", "description" : "The query to perform to find events in the system. It accepts\nquerying the intersection of a list of constraints,\njoined together with semicolons (without spaces). For example:\n
\n\nThe other valid comparators are =lt=, =le=,\n=ge=, and =gt=. They stand for \"<\", \"<=\",\n\">=\", \">\" respectively. These comparators are only applicable\nfor date time fields." }, { "name" : "resultOffset", "in" : "query", "default" : "0", "type" : "integer", "description" : "Specified the offset of events to return." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiEventQueryResult" }, "headers" : {}, "examples" : { "application/json" : { "totalResults" : 12345, "items" : [ { "id" : "...", "content" : "...", "timeOccurred" : "...", "timeReceived" : "...", "category" : "HBASE", "severity" : "UNKNOWN", "alert" : true, "attributes" : [ { "name" : "...", "values" : [ "...", "..." ] }, { "name" : "...", "values" : [ "...", "..." ] } ] }, { "id" : "...", "content" : "...", "timeOccurred" : "...", "timeReceived" : "...", "category" : "LOG_EVENT", "severity" : "UNKNOWN", "alert" : true, "attributes" : [ { "name" : "...", "values" : [ "...", "..." ] }, { "name" : "...", "values" : [ "...", "..." ] } ] } ] } }, "description" : "The results of the query" } } } }, "/events/{eventId}" : { "get" : { "tags" : [ "EventsResource" ], "summary" : "Returns a specific event in the system.", "description" : "Returns a specific event in the system", "operationId" : "readEvent", "produces" : [ "application/json" ], "parameters" : [ { "name" : "eventId", "in" : "path", "required" : true, "type" : "string", "description" : "The UUID of the event to read" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiEvent" }, "headers" : {}, "examples" : { "application/json" : { "id" : "...", "content" : "...", "timeOccurred" : "...", "timeReceived" : "...", "category" : "SYSTEM", "severity" : "UNKNOWN", "alert" : true, "attributes" : [ { "name" : "...", "values" : [ "...", "..." ] }, { "name" : "...", "values" : [ "...", "..." ] } ] } }, "description" : "The Event object with the specified UUID" } } } }, "/externalAccounts/create" : { "post" : { "tags" : [ "ExternalAccountsResource" ], "summary" : "Create a new external account.", "description" : "Create a new external account.\nAccount names and display names must be unique, i.e. they must not share names or display\nnames with an existing account.\nServer generates an account ID for the requested account.", "operationId" : "createAccount", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalAccount" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalAccount" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "displayName" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "typeName" : "...", "accountConfigs" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } } }, "description" : "" } } } }, "/externalAccounts/supportedCategories" : { "get" : { "tags" : [ "ExternalAccountsResource" ], "summary" : "List of external account categories supported by this Cloudera Manager.", "description" : "List of external account categories supported by this Cloudera Manager.", "operationId" : "getSupportedCategories", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalAccountCategoryList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "displayName" : "...", "description" : "..." }, { "name" : "...", "displayName" : "...", "description" : "..." } ] } }, "description" : "external account categories" } } } }, "/externalAccounts/update" : { "put" : { "tags" : [ "ExternalAccountsResource" ], "summary" : "Update an external account.", "description" : "Update an external account.", "operationId" : "updateAccount", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalAccount" }, "description" : "" } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalAccount" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "displayName" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "typeName" : "...", "accountConfigs" : { "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } } }, "description" : "" } } } }, "/externalAccounts/account/{name}" : { "get" : { "tags" : [ "ExternalAccountsResource" ], "summary" : "Get a single external account by account name.", "description" : "Get a single external account by account name.", "operationId" : "readAccount", "produces" : [ "application/json" ], "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "view", "in" : "query", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalAccount" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "displayName" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "typeName" : "...", "accountConfigs" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } } }, "description" : "" } } } }, "/externalAccounts/accountByDisplayName/{displayName}" : { "get" : { "tags" : [ "ExternalAccountsResource" ], "summary" : "Get a single external account by display name.", "description" : "Get a single external account by display name.", "operationId" : "readAccountByDisplayName", "produces" : [ "application/json" ], "parameters" : [ { "name" : "displayName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "view", "in" : "query", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalAccount" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "displayName" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "typeName" : "...", "accountConfigs" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } } }, "description" : "" } } } }, "/externalAccounts/delete/{name}" : { "delete" : { "tags" : [ "ExternalAccountsResource" ], "summary" : "Delete an external account, specifying its name.", "description" : "Delete an external account, specifying its name.", "operationId" : "deleteAccount", "produces" : [ "application/json" ], "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalAccount" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "displayName" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "typeName" : "...", "accountConfigs" : { "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 } ] } } }, "description" : "" } } } }, "/externalAccounts/supportedTypes/{categoryName}" : { "get" : { "tags" : [ "ExternalAccountsResource" ], "summary" : "List of external account types supported by this Cloudera Manager by category.", "description" : "List of external account types supported by this Cloudera Manager by category.", "operationId" : "getSupportedTypes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "categoryName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalAccountTypeList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "categoryName" : "...", "type" : "...", "displayName" : "...", "description" : "...", "allowedAccountConfigs" : { "items" : [ {}, {} ] } }, { "name" : "...", "categoryName" : "...", "type" : "...", "displayName" : "...", "description" : "...", "allowedAccountConfigs" : { "items" : [ {}, {} ] } } ] } }, "description" : "" } } } }, "/externalAccounts/type/{typeName}" : { "get" : { "tags" : [ "ExternalAccountsResource" ], "summary" : "Get a list of external accounts for a specific account type.", "description" : "Get a list of external accounts for a specific account type.", "operationId" : "readAccounts", "produces" : [ "application/json" ], "parameters" : [ { "name" : "typeName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "view", "in" : "query", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalAccountList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "displayName" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "typeName" : "...", "accountConfigs" : { "items" : [ {}, {} ] } }, { "name" : "...", "displayName" : "...", "createdTime" : "...", "lastModifiedTime" : "...", "typeName" : "...", "accountConfigs" : { "items" : [ {}, {} ] } } ] } }, "description" : "" } } } }, "/externalAccounts/account/{name}/config" : { "get" : { "tags" : [ "ExternalAccountsResource" ], "summary" : "Get configs of external account for the given account name.", "description" : "Get configs of external account for the given account name.", "operationId" : "readConfig", "produces" : [ "application/json" ], "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "type" : "string", "description" : "The external account name" }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view to materialize, either \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "the current external account configurations." } } }, "put" : { "tags" : [ "ExternalAccountsResource" ], "summary" : "Upadate configs of external account for the given account name.", "description" : "Upadate configs of external account for the given account name.", "operationId" : "updateConfig", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "name", "in" : "path", "required" : true, "type" : "string", "description" : "The external account name" }, { "name" : "message", "in" : "query", "type" : "string", "description" : "Optional message describing the changes." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "description" : "Settings to update." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "The updated configuration." } } } }, "/externalAccounts/typeInfo/{typeName}/commandsByName" : { "get" : { "tags" : [ "ExternalAccountsResource" ], "summary" : "Lists all the commands that can be executed by name on the\nprovided external account type.", "description" : "Lists all the commands that can be executed by name on the\nprovided external account type.\n
\nAvailable since API v16.", "operationId" : "listExternalAccountCommands", "produces" : [ "application/json" ], "parameters" : [ { "name" : "typeName", "in" : "path", "required" : true, "type" : "string", "description" : "The external account type name" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommandMetadataList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "argSchema" : "..." }, { "name" : "...", "argSchema" : "..." } ] } }, "description" : "a list of command metadata objects" } } } }, "/externalAccounts/account/{name}/commands/{commandName}" : { "post" : { "tags" : [ "ExternalAccountsResource" ], "summary" : "Executes a command on the external account specified\nby name.", "description" : "Executes a command on the external account specified\nby name.\n
\nAvailable since API v16.", "operationId" : "externalAccountCommandByName", "produces" : [ "application/json" ], "parameters" : [ { "name" : "commandName", "in" : "path", "required" : true, "type" : "string", "description" : "The command name." }, { "name" : "name", "in" : "path", "required" : true, "type" : "string", "description" : "The external account name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/externalUserMappings" : { "get" : { "tags" : [ "ExternalUserMappingsResource" ], "summary" : "Returns a list of the external user mappings configured in the system.", "description" : "Returns a list of the external user mappings configured in the system.", "operationId" : "readExternalUserMappings", "produces" : [ "application/json" ], "parameters" : [ { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalUserMappingList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "SAML_ATTRIBUTE", "uuid" : "...", "authRoles" : [ { "displayName" : "...", "name" : "...", "uuid" : "..." }, { "displayName" : "...", "name" : "...", "uuid" : "..." } ] }, { "name" : "...", "type" : "SAML_ATTRIBUTE", "uuid" : "...", "authRoles" : [ { "displayName" : "...", "name" : "...", "uuid" : "..." }, { "displayName" : "...", "name" : "...", "uuid" : "..." } ] } ] } }, "description" : "A list of external user mappings." } } }, "post" : { "tags" : [ "ExternalUserMappingsResource" ], "summary" : "Creates a list of external user mappings.", "description" : "Creates a list of external user mappings", "operationId" : "createExternalUserMappings", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalUserMappingList" }, "description" : "List of external user mappings to create." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalUserMappingList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "SAML_ATTRIBUTE", "uuid" : "...", "authRoles" : [ { "displayName" : "...", "name" : "...", "uuid" : "..." }, { "displayName" : "...", "name" : "...", "uuid" : "..." } ] }, { "name" : "...", "type" : "SAML_SCRIPT", "uuid" : "...", "authRoles" : [ { "displayName" : "...", "name" : "...", "uuid" : "..." }, { "displayName" : "...", "name" : "...", "uuid" : "..." } ] } ] } }, "description" : "Information about created external user mappings." } } } }, "/externalUserMappings/{uuid}" : { "delete" : { "tags" : [ "ExternalUserMappingsResource" ], "summary" : "Deletes an external user mapping from the system.", "description" : "Deletes an external user mapping from the system.\n
", "operationId" : "deleteExternalUserMapping", "produces" : [ "application/json" ], "parameters" : [ { "name" : "uuid", "in" : "path", "required" : true, "type" : "string", "description" : "The uuid of the external user mapping to delete." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalUserMapping" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "type" : "LDAP", "uuid" : "...", "authRoles" : [ { "displayName" : "...", "name" : "...", "uuid" : "..." }, { "displayName" : "...", "name" : "...", "uuid" : "..." } ] } }, "description" : "The details of the deleted external user mapping role." } } }, "get" : { "tags" : [ "ExternalUserMappingsResource" ], "summary" : "Returns detailed information about an external user mapping.", "description" : "Returns detailed information about an external user mapping.", "operationId" : "readExternalUserMapping", "produces" : [ "application/json" ], "parameters" : [ { "name" : "uuid", "in" : "path", "required" : true, "type" : "string", "description" : "The external user mapping to read." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalUserMapping" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "type" : "EXTERNAL_PROGRAM", "uuid" : "...", "authRoles" : [ { "displayName" : "...", "name" : "...", "uuid" : "..." }, { "displayName" : "...", "name" : "...", "uuid" : "..." } ] } }, "description" : "The external user mapping's information." } } }, "put" : { "tags" : [ "ExternalUserMappingsResource" ], "summary" : "Updates the given external user mapping's information.", "description" : "Updates the given external user mapping's information.", "operationId" : "updateExternalUserMapping", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "uuid", "in" : "path", "required" : true, "type" : "string", "description" : "Uuid of the external user mapping being updated." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalUserMapping" }, "description" : "The external user mapping information." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiExternalUserMapping" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "type" : "SAML_ATTRIBUTE", "uuid" : "...", "authRoles" : [ { "displayName" : "...", "name" : "...", "uuid" : "..." }, { "displayName" : "...", "name" : "...", "uuid" : "..." } ] } }, "description" : "" } } } }, "/clusters/{clusterName}/hostTemplates" : { "get" : { "tags" : [ "HostTemplatesResource" ], "summary" : "Lists all host templates in a cluster.", "description" : "Lists all host templates in a cluster.\n\nAvailable since API v3.", "operationId" : "readHostTemplates", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostTemplateList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "roleConfigGroupRefs" : [ { "roleConfigGroupName" : "..." }, { "roleConfigGroupName" : "..." } ] }, { "name" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "roleConfigGroupRefs" : [ { "roleConfigGroupName" : "..." }, { "roleConfigGroupName" : "..." } ] } ] } }, "description" : "List of host templates in the cluster." } } }, "post" : { "tags" : [ "HostTemplatesResource" ], "summary" : "Creates new host templates.", "description" : "Creates new host templates.\n
\nHost template names must be unique across clusters.\n
\nAvailable since API v3.", "operationId" : "createHostTemplates", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostTemplateList" }, "description" : "The list of host templates to create." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostTemplateList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "roleConfigGroupRefs" : [ { "roleConfigGroupName" : "..." }, { "roleConfigGroupName" : "..." } ] }, { "name" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "roleConfigGroupRefs" : [ { "roleConfigGroupName" : "..." }, { "roleConfigGroupName" : "..." } ] } ] } }, "description" : "The created host templates." } } } }, "/clusters/{clusterName}/hostTemplates/{hostTemplateName}" : { "delete" : { "tags" : [ "HostTemplatesResource" ], "summary" : "Deletes a host template.", "description" : "Deletes a host template.\n
\nAvailable since API v3.", "operationId" : "deleteHostTemplate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "hostTemplateName", "in" : "path", "required" : true, "type" : "string", "description" : "Host template to delete." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostTemplate" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "roleConfigGroupRefs" : [ { "roleConfigGroupName" : "..." }, { "roleConfigGroupName" : "..." } ] } }, "description" : "Deleted host template." } } }, "get" : { "tags" : [ "HostTemplatesResource" ], "summary" : "Retrieves information about a host template.", "description" : "Retrieves information about a host template.\n
\nAvailable since API v3.", "operationId" : "readHostTemplate", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "hostTemplateName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostTemplate" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "roleConfigGroupRefs" : [ { "roleConfigGroupName" : "..." }, { "roleConfigGroupName" : "..." } ] } }, "description" : "The requested host template." } } }, "put" : { "tags" : [ "HostTemplatesResource" ], "summary" : "Updates an existing host template.", "description" : "Updates an existing host template.\n
\nCan be used to update the role config groups in a host template\nor rename it.\n
\nAvailable since API v3.", "operationId" : "updateHostTemplate", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "hostTemplateName", "in" : "path", "required" : true, "type" : "string", "description" : "Host template with updated fields." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostTemplate" }, "description" : "" } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostTemplate" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "roleConfigGroupRefs" : [ { "roleConfigGroupName" : "..." }, { "roleConfigGroupName" : "..." } ] } }, "description" : "The updated host template." } } } }, "/clusters/{clusterName}/hostTemplates/{hostTemplateName}/commands/applyHostTemplate" : { "post" : { "tags" : [ "HostTemplatesResource" ], "summary" : "Applies a host template to a collection of hosts.", "description" : "Applies a host template to a collection of hosts. This will create a role\nfor each role config group on each of the hosts.\n
\nThe provided hosts must not have any existing roles on them and if the\ncluster is not using parcels, the hosts must have a CDH version matching\nthat of the cluster version.\n
\nAvailable since API v3.", "operationId" : "applyHostTemplate", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "hostTemplateName", "in" : "path", "required" : true, "type" : "string", "description" : "Host template to apply." }, { "name" : "startRoles", "in" : "query", "type" : "boolean", "description" : "Whether to start the newly created roles or not." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostRefList" }, "description" : "List of hosts to apply the host template to." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/clusters/{clusterName}/hostTemplates/{hostTemplateName}/commands/reapplyHostTemplateOnHosts" : { "post" : { "tags" : [ "HostTemplatesResource" ], "summary" : "Reapplies a host template on all the hosts associated with the host template.", "description" : "Reapplies a host template on all the hosts associated with the host template. This will run apply host template command\non the all the hosts using the host template .\n
\nSet deleteRoles to true to delete the roles on the associated hosts if RCG is missing from host template.\nCheck host tags with name as _cldr_cm_host_template_name to find out hosts using with the host template.\n
\nAvailable since API v46.", "operationId" : "reapplyHostTemplateOnHosts", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "hostTemplateName", "in" : "path", "required" : true, "type" : "string", "description" : "Host template to apply." }, { "name" : "deleteRoles", "in" : "query", "type" : "boolean", "description" : "Whether to delete roles on host if RCG is deleted from host template ." }, { "name" : "startRoles", "in" : "query", "type" : "boolean", "description" : "Whether to start the newly created roles or not." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/hosts" : { "delete" : { "tags" : [ "HostsResource" ], "summary" : "Delete all hosts in the system.", "description" : "Delete all hosts in the system", "operationId" : "deleteAllHosts", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPED" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "BUSY" } ], "healthSummary" : "DISABLED", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "OFFLINING", "maintenanceOwners" : [ "CLUSTER", "ROLE" ], "config" : { "items" : [ {}, {} ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "CONCERNING_HEALTH", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "UBUNTU_PRECISE", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "NA" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPING" } ], "healthSummary" : "HISTORY_NOT_AVAILABLE", "healthChecks" : [ { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "DECOMMISSIONED", "maintenanceOwners" : [ "ROLE", "SERVICE" ], "config" : { "items" : [ {}, {} ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "GOOD_HEALTH", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "UBUNTU_LUCID", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] } }, "description" : "The list of deleted hosts" } } }, "get" : { "tags" : [ "HostsResource" ], "summary" : "Returns hosts in the system filtered by optional host configuration parameters,\nif specified.", "description" : "Returns hosts in the system filtered by optional host configuration parameters,\nif specified.", "operationId" : "readHosts", "produces" : [ "application/json" ], "parameters" : [ { "name" : "configName", "in" : "query", "type" : "string", "description" : "Optional host config name to filter hosts by. Available from v40." }, { "name" : "configValue", "in" : "query", "type" : "string", "description" : "host config value associated with config name. Available from v40." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view to materialize" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTING" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "BUSY" } ], "healthSummary" : "CONCERNING", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "OFFLINING", "maintenanceOwners" : [ "CLUSTER", "CONTROL_PLANE" ], "config" : { "items" : [ {}, {} ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "STARTING", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "SLES12", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPED" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" } ], "healthSummary" : "NOT_AVAILABLE", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "COMMISSIONED", "maintenanceOwners" : [ "HOST", "HOST" ], "config" : { "items" : [ {}, {} ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "STARTING", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "RHEL7", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] } }, "description" : "A list of hosts" } } }, "post" : { "tags" : [ "HostsResource" ], "summary" : ".", "description" : "
Create one or more hosts.
\nYou must specify at least the\nhostname and ipAddress in the request objects.\nIf no hostId is specified, it will be set to the\nhostname. It is an error to try and create\nhost with the same hostId as another host.
", "operationId" : "createHosts", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostList" }, "description" : "The list of hosts to create" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPING" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTING" } ], "healthSummary" : "BAD", "healthChecks" : [ { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "UNKNOWN", "maintenanceOwners" : [ "CLUSTER", "HOST" ], "config" : { "items" : [ {}, {} ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "DISABLED_HEALTH", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "UNKNOWN", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPED" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "UNKNOWN" } ], "healthSummary" : "HISTORY_NOT_AVAILABLE", "healthChecks" : [ { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "DECOMMISSIONED", "maintenanceOwners" : [ "HOST", "ROLE" ], "config" : { "items" : [ {}, {} ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "DOWN", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "UBUNTU_PRECISE", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] } }, "description" : "The newly created host objects" } } } }, "/hosts/enterMaintenanceMode" : { "post" : { "tags" : [ "HostsResource" ], "summary" : "Puts a set of hosts into Maintenance mode.", "description" : "Puts a set of hosts into Maintenance mode\n\n\nAvailable since API v49. Since this is a bulk API, the response may contain partial failures.\nThe returned list contains a list of responses indicating the status of the maintenance mode of the hosts.\n
", "operationId" : "hostsEnterMaintenanceMode", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostNameList" }, "description" : "The List of Host Names that needs to go into the maintenance mode." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostMaintenanceResponseList" }, "headers" : {}, "examples" : { "application/json" : { "hostMaintenanceResponseList" : [ { "success" : true, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "errorMessage" : "..." }, { "success" : true, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "errorMessage" : "..." } ] } }, "description" : "Maintenance mode status of the hosts" } } } }, "/hosts/removeHostsFromCluster" : { "post" : { "tags" : [ "HostsResource" ], "summary" : "Decommissions and deletes all non management roles from the list of\nhosts and removes the hosts from the cluster.", "description" : "Decommissions and deletes all non management roles from the list of\nhosts and removes the hosts from the cluster. Also additionally delete the\nhosts if deleteHosts is set to true.", "operationId" : "removeHostsFromCluster", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHostsToRemoveArgs" }, "description" : "The list of hosts to remove from cluster or delete from CM" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "The command details." } } } }, "/hosts/{hostId}" : { "delete" : { "tags" : [ "HostsResource" ], "summary" : "Delete a host from the system.", "description" : "Delete a host from the system", "operationId" : "deleteHost", "produces" : [ "application/json" ], "parameters" : [ { "name" : "hostId", "in" : "path", "required" : true, "type" : "string", "description" : "The ID of the host to remove" } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHost" }, "headers" : {}, "examples" : { "application/json" : { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTING" } ], "healthSummary" : "CONCERNING", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "DECOMMISSIONING", "maintenanceOwners" : [ "CLUSTER", "ROLE" ], "config" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "DISABLED_HEALTH", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "UNKNOWN", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } }, "description" : "The deleted Host" } } }, "get" : { "tags" : [ "HostsResource" ], "summary" : "Returns a specific Host in the system.", "description" : "Returns a specific Host in the system.", "operationId" : "readHost", "produces" : [ "application/json" ], "parameters" : [ { "name" : "hostId", "in" : "path", "required" : true, "type" : "string", "description" : "The ID of the host to read." }, { "name" : "view", "in" : "query", "default" : "full", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view to materialize. Defaults to 'full'." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHost" }, "headers" : {}, "examples" : { "application/json" : { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "NA" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "HISTORY_NOT_AVAILABLE" } ], "healthSummary" : "DISABLED", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "COMMISSIONED", "maintenanceOwners" : [ "CLUSTER", "SERVICE" ], "config" : { "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "UNKNOWN", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "UBUNTU_LUCID", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } }, "description" : "The Host object with the specified hostId." } } }, "put" : { "tags" : [ "HostsResource" ], "summary" : ".", "description" : "Update an existing host in the system.
\nCurrently, only updating the rackId is supported. All other fields\nof the host will be ignored.
", "operationId" : "updateHost", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "hostId", "in" : "path", "required" : true, "type" : "string", "description" : "The hostId to update" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHost" }, "description" : "The updated host object." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHost" }, "headers" : {}, "examples" : { "application/json" : { "hostId" : "...", "ipAddress" : "...", "hostname" : "...", "rackId" : "...", "lastHeartbeat" : "...", "roleRefs" : [ { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "NA" }, { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPING" } ], "healthSummary" : "BAD", "healthChecks" : [ { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true } ], "hostUrl" : "...", "maintenanceMode" : true, "commissionState" : "DECOMMISSIONING", "maintenanceOwners" : [ "HOST", "CONTROL_PLANE" ], "config" : { "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "numCores" : 12345, "numPhysicalCores" : 12345, "totalPhysMemBytes" : 12345, "entityStatus" : "STARTING", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "distribution" : { "distributionType" : "UNKNOWN", "name" : "...", "version" : "..." }, "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } }, "description" : "The updated host" } } } }, "/hosts/{hostId}/components" : { "get" : { "tags" : [ "HostsResource" ], "summary" : "Returns the list of Component details on the requested host.", "description" : "Returns the list of Component details on the requested host.", "operationId" : "getHostComponents", "produces" : [ "application/json" ], "parameters" : [ { "name" : "hostId", "in" : "path", "required" : true, "type" : "string", "description" : "The ID of the host." } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiComponentInfo" } }, "headers" : {}, "examples" : { "application/json" : [ { "name" : "...", "cdhVersion" : "...", "cdhRelease" : "...", "componentVersion" : "...", "componentRelease" : "...", "componentInfoSource" : "...", "isActive" : true, "componentConfig" : { "property1" : "...", "property2" : "..." } } ] }, "description" : "List of component details." } } } }, "/hosts/{hostId}/config" : { "get" : { "tags" : [ "HostsResource" ], "summary" : "Retrieves the configuration of a specific host.", "description" : "Retrieves the configuration of a specific host.", "operationId" : "readHostConfig", "produces" : [ "application/json" ], "parameters" : [ { "name" : "hostId", "in" : "path", "required" : true, "type" : "string", "description" : "The ID of the host." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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 } ] } }, "description" : "List of host configuration parameters." } } }, "put" : { "tags" : [ "HostsResource" ], "summary" : "Updates the host configuration with the given values.", "description" : "Updates the host configuration with the given values.\n\nIf a value is set in the given configuration, it will be added\nto the host's configuration, replacing any existing entries.\nIf a value is unset (its value is null), the existing\nconfiguration for the attribute will be erased, if any.\n
\nAttributes that are not listed in the input will maintain their\ncurrent values in the configuration.", "operationId" : "updateHostConfig", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "hostId", "in" : "path", "required" : true, "type" : "string", "description" : "The ID of the host." }, { "name" : "message", "in" : "query", "type" : "string", "description" : "Optional message describing the changes." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "description" : "Configuration changes." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "The new host configuration." } } } }, "/hosts/{hostId}/metrics" : { "get" : { "deprecated" : true, "tags" : [ "HostsResource" ], "summary" : "Fetch metric readings for a host.", "description" : "Fetch metric readings for a host.\n
\nBy default, this call will look up all metrics available for the host. If\nonly specific metrics are desired, use the metrics parameter.\n
\nBy default, the returned results correspond to a 5 minute window based on\nthe provided end time (which defaults to the current server time). The\nfrom and to parameters can be used to control the window\nbeing queried. A maximum window of 3 hours is enforced.\n
\nWhen requesting a \"full\" view, aside from the extended properties of the\nreturned metric data, the collection will also contain information about\nall metrics available for the role, even if no readings are available\nin the requested window.\n
\nHost metrics also include per-network interface and per-storage device\nmetrics. Since collecting this data incurs in more overhead, query\nparameters can be used to choose which network interfaces and storage\ndevices to query, or to these metrics altogether.\n
\nStorage metrics are collected at different levels; for example, per-disk\nand per-partition metrics are available. The \"storageIds\" parameter can be\nused to filter specific storage IDs.\n
\nIn the returned data, the network interfaces and storage IDs can be\nidentified by looking at the \"context\" property of the metric objects.", "operationId" : "getMetrics", "produces" : [ "application/json" ], "parameters" : [ { "name" : "hostId", "in" : "path", "required" : true, "type" : "string", "description" : "The host's ID." }, { "name" : "from", "in" : "query", "type" : "string", "description" : "Start of the period to query." }, { "name" : "ifs", "in" : "query", "type" : "array", "items" : { "type" : "string" }, "collectionFormat" : "multi", "description" : "Network interfaces to query for metrics (default = all)." }, { "name" : "metrics", "in" : "query", "type" : "array", "items" : { "type" : "string" }, "collectionFormat" : "multi", "description" : "Filter for which metrics to query." }, { "name" : "queryNw", "in" : "query", "default" : "true", "type" : "boolean", "description" : "Whether to query for network interface metrics." }, { "name" : "queryStorage", "in" : "query", "default" : "true", "type" : "boolean", "description" : "Whether to query for storage metrics." }, { "name" : "storageIds", "in" : "query", "type" : "array", "items" : { "type" : "string" }, "collectionFormat" : "multi", "description" : "Storage context IDs to query for metrics (default = all)." }, { "name" : "to", "in" : "query", "default" : "now", "type" : "string", "description" : "End of the period to query." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiMetricList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "context" : "...", "unit" : "...", "data" : [ { "timestamp" : "...", "value" : 12345.0 }, { "timestamp" : "...", "value" : 12345.0 } ], "displayName" : "...", "description" : "..." }, { "name" : "...", "context" : "...", "unit" : "...", "data" : [ { "timestamp" : "...", "value" : 12345.0 }, { "timestamp" : "...", "value" : 12345.0 } ], "displayName" : "...", "description" : "..." } ] } }, "description" : "List of readings from the monitors." } } } }, "/hosts/{hostname}/tags" : { "delete" : { "tags" : [ "HostsResource" ], "summary" : "Remove the tags associated with the host.", "description" : "Remove the tags associated with the host. Tag names beginning with the\nprefix _cldr_ (case insensitive) are reserved for internal use by Cloudera.", "operationId" : "deleteTags", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "hostname", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the host to remove tags from" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "description" : "List of tags to remove from the host" } ], "responses" : { "204" : { "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "headers" : {}, "examples" : { "application/json" : [ { "name" : "...", "value" : "..." } ] }, "description" : "A list of tags that were removed from the host" } } }, "get" : { "tags" : [ "HostsResource" ], "summary" : "Returns the tags associated with this host.", "description" : "Returns the tags associated with this host. Tag names beginning with\nthe prefix _cldr_ (case insensitive) are reserved for internal use by Cloudera.", "operationId" : "readTags", "produces" : [ "application/json" ], "parameters" : [ { "name" : "hostname", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the host" }, { "name" : "limit", "in" : "query", "default" : "10", "type" : "integer", "description" : "Number of tags" }, { "name" : "offset", "in" : "query", "default" : "0", "type" : "integer", "description" : "Index of the first tag to retrieve" } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "headers" : {}, "examples" : { "application/json" : [ { "name" : "...", "value" : "..." } ] }, "description" : "A list of tags associated with the host" } } }, "put" : { "tags" : [ "HostsResource" ], "summary" : "Attach tags to the host.", "description" : "Attach tags to the host. Tag names beginning with the prefix _cldr_\n(case insensitive) are reserved for internal use by Cloudera.", "operationId" : "addTags", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "hostname", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the host" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "description" : "List of tags to add to the host" } ], "responses" : { "204" : { "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "headers" : {}, "examples" : { "application/json" : [ { "name" : "...", "value" : "..." } ] }, "description" : "A list of tags that were added to the host" } } } }, "/hosts/{hostId}/commands/enterMaintenanceMode" : { "post" : { "tags" : [ "HostsResource" ], "summary" : "Put the host into maintenance mode.", "description" : "Put the host into maintenance mode. This is a synchronous command.\nThe result is known immediately upon return.\n\n
Available since API v2.
", "operationId" : "enterMaintenanceMode", "produces" : [ "application/json" ], "parameters" : [ { "name" : "hostId", "in" : "path", "required" : true, "type" : "string", "description" : "The ID of the host" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/hosts/{hostId}/commands/exitMaintenanceMode" : { "post" : { "tags" : [ "HostsResource" ], "summary" : "Take the host out of maintenance mode.", "description" : "Take the host out of maintenance mode. This is a synchronous command. The\nresult is known immediately upon return.\n\n\nAvailable since API v2.\n
", "operationId" : "exitMaintenanceMode", "produces" : [ "application/json" ], "parameters" : [ { "name" : "hostId", "in" : "path", "required" : true, "type" : "string", "description" : "The ID of the host" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/hosts/{hostId}/commands/generateHostCerts" : { "post" : { "tags" : [ "HostsResource" ], "summary" : "Generates (or regenerates) a key and certificate for this host if Auto-TLS is enabled.", "description" : "Generates (or regenerates) a key and certificate for this host if Auto-TLS is enabled.", "operationId" : "generateHostCerts", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "hostId", "in" : "path", "required" : true, "type" : "string", "description" : "The ID of the host to generate a certificate for." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiGenerateHostCertsArguments" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "" } } } }, "/hosts/{hostId}/commands/migrateRoles" : { "post" : { "tags" : [ "HostsResource" ], "summary" : "Migrate roles to a different host.", "description" : "Migrate roles to a different host.\n\nThis command applies only to HDFS NameNode, JournalNode, and Failover\nController roles. In order to migrate these roles:\n
If the active NameNode is selected for migration, a manual failover\nwill be performed before the role is migrated. The role will remain in\nstandby mode after the migration is complete.\n
When migrating a NameNode role, the co-located Failover Controller\nrole must be migrated as well if automatic failover is enabled. The\nFailover Controller role name must be included in the list of role\nnames to migrate specified in the arguments to this command (it will\nnot be included implicitly). This command does not allow a Failover\nController role to be moved by itself, although it is possible to move\na JournalNode independently.\n
\nAvailable since API v10.", "operationId" : "migrateRoles", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "hostId", "in" : "path", "required" : true, "type" : "string", "description" : "The ID of the host on which the roles to migrate currently\nreside" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiMigrateRolesArguments" }, "description" : "Arguments for the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/hosts/{hostId}/commands/resetHostId" : { "post" : { "tags" : [ "HostsResource" ], "summary" : "Forces agent on specified host to switch to reporting a different host id.", "description" : "Forces agent on specified host to switch to reporting a different host id.", "operationId" : "resetHostId", "produces" : [ "application/json" ], "parameters" : [ { "name" : "hostId", "in" : "path", "required" : true, "type" : "string", "description" : "The ID of the host that should be affected." }, { "name" : "newHostId", "in" : "query", "type" : "string", "description" : "New ID the the host should report." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "" } } } }, "/clusters/{clusterName}/services/{serviceName}/impalaQueries" : { "get" : { "tags" : [ "ImpalaQueriesResource" ], "summary" : "Returns a list of queries that satisfy the filter.", "description" : "Returns a list of queries that satisfy the filter\n
\nAvailable since API v4.", "operationId" : "getImpalaQueries", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the service" }, { "name" : "filter", "in" : "query", "default" : "", "type" : "string", "description" : "A filter to apply to the queries. A basic filter tests the\nvalue of an attribute and looks something like 'rowsFetched = 1' or\n'user = root'. Multiple basic filters can be combined into a complex\nexpression using standard and / or boolean logic and parenthesis.\nAn example of a complex filter is: 'query_duration > 5s and (user = root or\nuser = myUserName)'. An example of expected full query string in requested\nURL is: '?filter=(query_duration > 5s and (user = root or user = myUserName))'." }, { "name" : "from", "in" : "query", "type" : "string", "description" : "Start of the period to query in ISO 8601 format (defaults to 5\nminutes before the 'to' time)." }, { "name" : "limit", "in" : "query", "default" : "100", "type" : "integer", "description" : "The maximum number of queries to return. Queries will be\nreturned in the following order:\n
\nExamples of attributes include the user who issued the query and the\nnumber of HDFS bytes read by the query.\n
\nThese attributes can be used to search for specific Impala queries through\nthe getImpalaQueries API. For example the 'user' attribute could be used\nin the search 'user = root'. If the attribute is numeric it can also be used\nas a metric in a tsquery (ie, 'select hdfs_bytes_read from IMPALA_QUERIES').\n
\nNote that this response is identical for all Impala services.\n
\nAvailable since API v6.", "operationId" : "getImpalaQueryAttributes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiImpalaQueryAttributeList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "...", "displayName" : "...", "supportsHistograms" : true, "description" : "..." }, { "name" : "...", "type" : "...", "displayName" : "...", "supportsHistograms" : true, "description" : "..." } ] } }, "description" : "" } } } }, "/clusters/{clusterName}/services/{serviceName}/impalaQueries/{queryId}" : { "get" : { "tags" : [ "ImpalaQueriesResource" ], "summary" : "Returns details about the query.", "description" : "Returns details about the query. Not all queries have details, check\nthe detailsAvailable field from the getQueries response.\n
\nAvailable since API v4.", "operationId" : "getQueryDetails", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "queryId", "in" : "path", "required" : true, "type" : "string", "description" : "The queryId to get information about" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "format", "in" : "query", "default" : "text", "type" : "string", "description" : "There are two valid format parameters:\n
\nAvailable since API v4.", "operationId" : "cancelImpalaQuery", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "queryId", "in" : "path", "required" : true, "type" : "string", "description" : "The queryId to cancel" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the service" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiImpalaCancelResponse" }, "headers" : {}, "examples" : { "application/json" : { "warning" : "..." } }, "description" : "A warning if there was one. Otherwise null." } } } }, "/cm/service/roleCommands/jmapDump" : { "post" : { "tags" : [ "MgmtRoleCommandsResource" ], "summary" : "Run the jmapDump diagnostic command.", "description" : "Run the jmapDump diagnostic command. The command runs the jmap utility to\ncapture a dump of the role's java heap.\n
\nAvailable since API v8.", "operationId" : "jmapDump", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "the names of the roles to jmap." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "List of submitted commands." } } } }, "/cm/service/roleCommands/jmapHisto" : { "post" : { "tags" : [ "MgmtRoleCommandsResource" ], "summary" : "Run the jmapHisto diagnostic command.", "description" : "Run the jmapHisto diagnostic command. The command runs the jmap utility to\ncapture a histogram of the objects on the role's java heap.\n\nAvailable since API v8.", "operationId" : "jmapHisto", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "the names of the roles to jmap." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "List of submitted commands." } } } }, "/cm/service/roleCommands/jstack" : { "post" : { "tags" : [ "MgmtRoleCommandsResource" ], "summary" : "Run the jstack diagnostic command.", "description" : "Run the jstack diagnostic command. The command runs the jstack utility to\ncapture a role's java thread stacks.\n\nAvailable since API v8.", "operationId" : "jstack", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "the names of the roles to jstack." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "List of submitted commands." } } } }, "/cm/service/roleCommands/lsof" : { "post" : { "tags" : [ "MgmtRoleCommandsResource" ], "summary" : "Run the lsof diagnostic command.", "description" : "Run the lsof diagnostic command. This command runs the lsof utility to\nlist a role's open files.\n\nAvailable since API v8.", "operationId" : "lsof", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "the names of the roles to lsof." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "List of submitted commands." } } } }, "/cm/service/roleCommands/restart" : { "post" : { "tags" : [ "MgmtRoleCommandsResource" ], "summary" : "Restart a set of Cloudera Management Services roles.", "description" : "Restart a set of Cloudera Management Services roles.", "operationId" : "restartCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The roles to restart." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of submitted commands (summary view)." } } } }, "/cm/service/roleCommands/start" : { "post" : { "tags" : [ "MgmtRoleCommandsResource" ], "summary" : "Start a set of Cloudera Management Services roles.", "description" : "Start a set of Cloudera Management Services roles.", "operationId" : "startCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The roles to start." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of submitted commands (summary view)." } } } }, "/cm/service/roleCommands/stop" : { "post" : { "tags" : [ "MgmtRoleCommandsResource" ], "summary" : "Stop a set of Cloudera Management Services roles.", "description" : "Stop a set of Cloudera Management Services roles.", "operationId" : "stopCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The roles to stop." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of submitted commands (summary view)." } } } }, "/cm/service/roleConfigGroups" : { "get" : { "tags" : [ "MgmtRoleConfigGroupsResource" ], "summary" : "Returns the information for all role config groups in\nthe Cloudera Management Services.", "description" : "Returns the information for all role config groups in\nthe Cloudera Management Services.\n\nAvailable since API v3.", "operationId" : "readRoleConfigGroups", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleConfigGroupList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } }, { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } ] } }, "description" : "The list of role config groups for the given service." } } } }, "/cm/service/roleConfigGroups/{roleConfigGroupName}" : { "get" : { "tags" : [ "MgmtRoleConfigGroupsResource" ], "summary" : "Returns the information for a given role config group\nin the Cloudera Management Services.", "description" : "Returns the information for a given role config group\nin the Cloudera Management Services.\n
\nAvailable since API v3.", "operationId" : "readRoleConfigGroup", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the requested group." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleConfigGroup" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "roleType" : "...", "base" : true, "config" : { "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } }, "description" : "The requested role config group." } } }, "put" : { "tags" : [ "MgmtRoleConfigGroupsResource" ], "summary" : "Updates an existing role config group in the Cloudera Management Services.", "description" : "Updates an existing role config group in the Cloudera Management Services.\n
\nAvailable since API v3.", "operationId" : "updateRoleConfigGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the group to update." }, { "name" : "message", "in" : "query", "type" : "string", "description" : "The optional message describing the changes." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleConfigGroup" }, "description" : "The updated role config group." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleConfigGroup" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "roleType" : "...", "base" : true, "config" : { "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } }, "description" : "Role updated role config group." } } } }, "/cm/service/roleConfigGroups/{roleConfigGroupName}/config" : { "get" : { "tags" : [ "MgmtRoleConfigGroupsResource" ], "summary" : "Returns the current revision of the config\nfor the specified role config group in the Cloudera Management Services.", "description" : "Returns the current revision of the config\nfor the specified role config group in the Cloudera Management Services.\n
\nAvailable since API v3.", "operationId" : "readConfig", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the role config group." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "The current configuration of the role config group." } } }, "put" : { "tags" : [ "MgmtRoleConfigGroupsResource" ], "summary" : "Updates the config for the given role config group\nin the Cloudera Management Services.", "description" : "Updates the config for the given role config group\nin the Cloudera Management Services.\n
\nAvailable since API v3.", "operationId" : "updateConfig", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the role config group." }, { "name" : "message", "in" : "query", "type" : "string", "description" : "Optional message describing the changes." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "description" : "The new config information for the group." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "The updated config of the role config group." } } } }, "/cm/service/roleConfigGroups/{roleConfigGroupName}/roles" : { "get" : { "tags" : [ "MgmtRoleConfigGroupsResource" ], "summary" : "Returns all roles in the given role config group\nin the Cloudera Management Services.", "description" : "Returns all roles in the given role config group\nin the Cloudera Management Services.\n
\nAvailable since API v3.", "operationId" : "readRoles", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the role config group." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STOPPING", "commissionState" : "UNKNOWN", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true } ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "ROLE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION", "entityStatus" : "STOPPING", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STOPPED", "commissionState" : "DECOMMISSIONING", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true } ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "SERVICE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "STOPPING", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] } }, "description" : "The roles in the role config group." } } } }, "/cm/service/roles" : { "get" : { "tags" : [ "MgmtRolesResource" ], "summary" : "List all roles of the Cloudera Management Services.", "description" : "List all roles of the Cloudera Management Services.", "operationId" : "readRoles", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "UNKNOWN", "commissionState" : "DECOMMISSIONED", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true } ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "CONTROL_PLANE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "STANDALONE", "entityStatus" : "STARTING", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STOPPED", "commissionState" : "OFFLINING", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "ROLE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "GOOD_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] } }, "description" : "List of roles." } } }, "post" : { "tags" : [ "MgmtRolesResource" ], "summary" : "Create new roles in the Cloudera Management Services.", "description" : "Create new roles in the Cloudera Management Services.", "operationId" : "createRoles", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleList" }, "description" : "Roles to create." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "HISTORY_NOT_AVAILABLE", "commissionState" : "OFFLINED", "healthSummary" : "CONCERNING", "configStalenessStatus" : "FRESH", "healthChecks" : [ { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "ROLE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_LEADER", "entityStatus" : "DISABLED_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STARTING", "commissionState" : "OFFLINED", "healthSummary" : "CONCERNING", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true } ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "SERVICE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_OBSERVER", "entityStatus" : "GOOD_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] } }, "description" : "List of created roles." } } } }, "/cm/service/roles/{roleName}" : { "delete" : { "tags" : [ "MgmtRolesResource" ], "summary" : "Delete a role from the Cloudera Management Services.", "description" : "Delete a role from the Cloudera Management Services.", "operationId" : "deleteRole", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role name." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRole" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "UNKNOWN", "commissionState" : "DECOMMISSIONED", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "CONTROL_PLANE" ], "config" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "DISABLED_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } }, "description" : "The details of the deleted role." } } }, "get" : { "tags" : [ "MgmtRolesResource" ], "summary" : "Retrieve detailed information about a Cloudera Management Services role.", "description" : "Retrieve detailed information about a Cloudera Management Services role.", "operationId" : "readRole", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role name." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRole" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STARTING", "commissionState" : "COMMISSIONED", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "ROLE" ], "config" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "STANDALONE", "entityStatus" : "STARTING", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } }, "description" : "The details of the role." } } } }, "/cm/service/roles/{roleName}/commands" : { "get" : { "tags" : [ "MgmtRolesResource" ], "summary" : "List active role commands.", "description" : "List active role commands.", "operationId" : "listActiveCommands", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role name." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommandList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of active role commands." } } } }, "/cm/service/roles/{roleName}/config" : { "get" : { "tags" : [ "MgmtRolesResource" ], "summary" : "Retrieve the configuration of a specific Cloudera Management Services role.", "description" : "Retrieve the configuration of a specific Cloudera Management Services role.", "operationId" : "readRoleConfig", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to look up." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "List with configured and available configuration options." } } }, "put" : { "tags" : [ "MgmtRolesResource" ], "summary" : "Update the configuration of a Cloudera Management Services role.", "description" : "Update the configuration of a Cloudera Management Services role.\n
\nIf a value is set in the given configuration, it will be added\nto the role's configuration, replacing any existing entries.\nIf a value is unset (its value is null), the existing\nconfiguration for the attribute will be erased, if any.\n
\nAttributes that are not listed in the input will maintain their\ncurrent values in the configuration.", "operationId" : "updateRoleConfig", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to modify." }, { "name" : "message", "in" : "query", "type" : "string", "description" : "Optional message describing the changes." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "description" : "Configuration changes." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "The new service configuration." } } } }, "/cm/service/roles/{roleName}/commands/enterMaintenanceMode" : { "post" : { "tags" : [ "MgmtRolesResource" ], "summary" : "Put the Cloudera Management Service role into maintenance mode.", "description" : "Put the Cloudera Management Service role into maintenance mode.This is a\nsynchronous command. The result is known immediately upon return.\n\n
\nAvailable since API v18.\n
", "operationId" : "enterMaintenanceMode", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/cm/service/roles/{roleName}/commands/exitMaintenanceMode" : { "post" : { "tags" : [ "MgmtRolesResource" ], "summary" : "Take the Cloudera Management Service role out of maintenance mode.", "description" : "Take the Cloudera Management Service role out of maintenance mode. This is\na synchronous command. The result is known immediately upon return.\n\n\nAvailable since API v18.\n
", "operationId" : "exitMaintenanceMode", "produces" : [ "application/json" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/cm/service/roles/{roleName}/logs/full" : { "get" : { "tags" : [ "MgmtRolesResource" ], "summary" : "Retrieves the log file for the role's main process.", "description" : "Retrieves the log file for the role's main process.\n\nIf the role is not started, this will be the log file associated with\nthe last time the role was run.\n
\nLog files are returned as plain text (type \"text/plain\").", "operationId" : "getFullLog", "produces" : [ "text/plain" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to fetch logs from." } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "string" }, "headers" : {}, "examples" : {}, "description" : "Contents of the role's log file." } } } }, "/cm/service/roles/{roleName}/logs/stacks" : { "get" : { "tags" : [ "MgmtRolesResource" ], "summary" : "Retrieves the stacks log file, if any, for the role's main process.", "description" : "Retrieves the stacks log file, if any, for the role's main process. Note\nthat not all roles support periodic stacks collection.\n\nThe log files are returned as plain text (type \"text/plain\").", "operationId" : "getStacksLog", "produces" : [ "text/plain" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to fetch stacks logs from." } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "string" }, "headers" : {}, "examples" : {}, "description" : "Contents of the role's log file." } } } }, "/cm/service/roles/{roleName}/logs/stacksBundle" : { "get" : { "tags" : [ "MgmtRolesResource" ], "summary" : "Download a zip-compressed archive of role stacks logs.", "description" : "Download a zip-compressed archive of role stacks logs. Note that not all\nroles support periodic stacks collection.", "operationId" : "getStacksLogsBundle", "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to fetch the stacks logs bundle from." } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "file" }, "headers" : {}, "examples" : {}, "description" : "The archive data." } } } }, "/cm/service/roles/{roleName}/logs/stderr" : { "get" : { "tags" : [ "MgmtRolesResource" ], "summary" : "Retrieves the role's standard error output.", "description" : "Retrieves the role's standard error output.\n
\nIf the role is not started, this will be the output associated with\nthe last time the role was run.\n
\nLog files are returned as plain text (type \"text/plain\").", "operationId" : "getStandardError", "produces" : [ "text/plain" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to fetch stderr from." } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "string" }, "headers" : {}, "examples" : {}, "description" : "Contents of the role's standard error output." } } } }, "/cm/service/roles/{roleName}/logs/stdout" : { "get" : { "tags" : [ "MgmtRolesResource" ], "summary" : "Retrieves the role's standard output.", "description" : "Retrieves the role's standard output.\n
\nIf the role is not started, this will be the output associated with\nthe last time the role was run.\n
\nLog files are returned as plain text (type \"text/plain\").", "operationId" : "getStandardOutput", "produces" : [ "text/plain" ], "parameters" : [ { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to fetch stdout from." } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "string" }, "headers" : {}, "examples" : {}, "description" : "Contents of the role's standard output." } } } }, "/cm/service" : { "delete" : { "tags" : [ "MgmtServiceResource" ], "summary" : "Delete the Cloudera Management Services.", "description" : "Delete the Cloudera Management Services.\n
\nThis method will fail if a CMS instance doesn't already exist.", "operationId" : "deleteCMS", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiService" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STARTED", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "HOST" ], "config" : { "roleTypeConfigs" : [ { "roleType" : "...", "items" : [ {}, {} ] }, { "roleType" : "...", "items" : [ {}, {} ] } ], "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 } ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "BUSY", "commissionState" : "UNKNOWN", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "CLUSTER" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION", "entityStatus" : "UNKNOWN", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "NA", "commissionState" : "OFFLINED", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true } ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "HOST" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_LEADER", "entityStatus" : "DISABLED_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ], "displayName" : "...", "roleConfigGroups" : [ { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } }, { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } ], "replicationSchedules" : [ { "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "METADATA_AND_DATA", "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : {}, "peerState" : "ENABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ {}, {} ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : {}, "status" : "DISABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : {} }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "DAY", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "METADATA_AND_DATA", "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : {}, "peerState" : "DISABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ {}, {} ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : {}, "status" : "ENABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : {} }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "MINUTE", "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" : { "tableRegExps" : [ "...", "..." ], "storage" : "LOCAL" }, "hdfsArguments" : { "pathPatterns" : [ "...", "..." ] }, "lastCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "lastSuccessfulCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "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" : { "tableRegExps" : [ "...", "..." ], "storage" : "REMOTE_S3" }, "hdfsArguments" : { "pathPatterns" : [ "...", "..." ] }, "lastCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "lastSuccessfulCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "paused" : true } ], "entityStatus" : "STOPPING", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." } }, "description" : "ApiService The deleted CMS information." } } }, "get" : { "tags" : [ "MgmtServiceResource" ], "summary" : "Retrieve information about the Cloudera Management Services.", "description" : "Retrieve information about the Cloudera Management Services.", "operationId" : "readService", "produces" : [ "application/json" ], "parameters" : [ { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiService" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "NA", "healthSummary" : "CONCERNING", "configStalenessStatus" : "STALE_REFRESHABLE", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "HOST" ], "config" : { "roleTypeConfigs" : [ { "roleType" : "...", "items" : [ {}, {} ] }, { "roleType" : "...", "items" : [ {}, {} ] } ], "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "UNKNOWN", "commissionState" : "DECOMMISSIONING", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "ROLE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_LEADER", "entityStatus" : "DOWN", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STARTING", "commissionState" : "UNKNOWN", "healthSummary" : "HISTORY_NOT_AVAILABLE", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "ROLE", "CONTROL_PLANE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "UNKNOWN", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ], "displayName" : "...", "roleConfigGroups" : [ { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } }, { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } ], "replicationSchedules" : [ { "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "METADATA_ONLY", "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : {}, "peerState" : "ENABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ {}, {} ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : {}, "status" : "ENABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : {} }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "YEAR", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "METADATA_ONLY", "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : {}, "peerState" : "ENABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ {}, {} ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : {}, "status" : "ENABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : {} }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "YEAR", "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" : { "tableRegExps" : [ "...", "..." ], "storage" : "LOCAL" }, "hdfsArguments" : { "pathPatterns" : [ "...", "..." ] }, "lastCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "lastSuccessfulCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "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" : { "tableRegExps" : [ "...", "..." ], "storage" : "REMOTE_S3" }, "hdfsArguments" : { "pathPatterns" : [ "...", "..." ] }, "lastCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "lastSuccessfulCommand" : { "hbaseResult" : {}, "hdfsResult" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "paused" : true } ], "entityStatus" : "GOOD_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." } }, "description" : "Details about the management service." } } }, "put" : { "tags" : [ "MgmtServiceResource" ], "summary" : "Setup the Cloudera Management Services.", "description" : "Setup the Cloudera Management Services.\n
\nConfigure the CMS instance and create all the management roles. The\nprovided configuration data can be used to set up host mappings for\neach role, and required configuration such as database connection\ninformation for specific roles.\n
\nRegardless of the list of roles provided in the input data, all\nmanagement roles are created by this call. The input is used to\noverride any default settings for the specific roles.\n
\nThis method needs a valid CM license to be installed beforehand.\n
\nThis method does not start any services or roles.\n
\nThis method will fail if a CMS instance already exists.\n
\nAvailable role types:\n
\nAssignments are done based on number of hosts in the deployment and hardware specifications.\nIf no hosts are part of the deployment, an exception will be thrown preventing any role assignments.\nExisting roles will be taken into account and their assignments will be not be modified.\nThe deployment should not have any clusters when calling this endpoint. If it does,\nan exception will be thrown preventing any role assignments.\n
\nAvailable since API v6.", "operationId" : "autoAssignRoles", "parameters" : [], "responses" : { "204" : { "headers" : {}, "examples" : {}, "description" : "Success" } } } }, "/cm/service/autoConfigure" : { "put" : { "tags" : [ "MgmtServiceResource" ], "summary" : "Automatically configures roles of the Cloudera Management Service.", "description" : "Automatically configures roles of the Cloudera Management Service.\n
\nOverwrites some existing configurations.\nOnly default role config groups must exist before calling this endpoint.\nOther role config groups must not exist. If they do, an exception will be thrown\npreventing any configuration.\nIgnores any clusters (and their services and roles) colocated with the Cloudera\nManagement Service. To avoid over-committing the heap on hosts, place the\nCloudera Management Service roles on machines not used by any of the clusters.\n
\nAvailable since API v6.", "operationId" : "autoConfigure", "parameters" : [], "responses" : { "204" : { "headers" : {}, "examples" : {}, "description" : "Success" } } } }, "/cm/service/commands" : { "get" : { "tags" : [ "MgmtServiceResource" ], "summary" : "List active Cloudera Management Services commands.", "description" : "List active Cloudera Management Services commands.", "operationId" : "listActiveCommands", "produces" : [ "application/json" ], "parameters" : [ { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommandList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of active role commands." } } } }, "/cm/service/config" : { "get" : { "tags" : [ "MgmtServiceResource" ], "summary" : "Retrieve the configuration of the Cloudera Management Services.", "description" : "Retrieve the configuration of the Cloudera Management Services.", "operationId" : "readServiceConfig", "produces" : [ "application/json" ], "parameters" : [ { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiServiceConfig" }, "headers" : {}, "examples" : { "application/json" : { "roleTypeConfigs" : [ { "roleType" : "...", "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, { "roleType" : "...", "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } ], "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "List with configured and available configuration options." } } }, "put" : { "tags" : [ "MgmtServiceResource" ], "summary" : "Update the Cloudera Management Services configuration.", "description" : "Update the Cloudera Management Services configuration.\n
\nIf a value is set in the given configuration, it will be added\nto the service's configuration, replacing any existing entries.\nIf a value is unset (its value is null), the existing\nconfiguration for the attribute will be erased, if any.\n
\nAttributes that are not listed in the input will maintain their\ncurrent values in the configuration.", "operationId" : "updateServiceConfig", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "message", "in" : "query", "type" : "string", "description" : "Optional message describing the changes." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiServiceConfig" }, "description" : "Configuration changes." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiServiceConfig" }, "headers" : {}, "examples" : { "application/json" : { "roleTypeConfigs" : [ { "roleType" : "...", "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 } ] }, { "roleType" : "...", "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } ], "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "The new service configuration." } } } }, "/cm/service/roleTypes" : { "get" : { "tags" : [ "MgmtServiceResource" ], "summary" : "List the supported role types for the Cloudera Management Services.", "description" : "List the supported role types for the Cloudera Management Services.", "operationId" : "listRoleTypes", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleTypeList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ "...", "..." ] } }, "description" : "List of role types the service supports." } } } }, "/cm/service/commands/enterMaintenanceMode" : { "post" : { "tags" : [ "MgmtServiceResource" ], "summary" : "Put Cloudera Management Service into maintenance mode.", "description" : "Put Cloudera Management Service into maintenance mode. This is a\nsynchronous command. The result is known immediately upon return.\n\n
Available since API v18.
", "operationId" : "enterMaintenanceMode", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/cm/service/commands/exitMaintenanceMode" : { "post" : { "tags" : [ "MgmtServiceResource" ], "summary" : "Take Cloudera Management Service out of maintenance mode.", "description" : "Take Cloudera Management Service out of maintenance mode. This is a\nsynchronous command. The result is known immediately upon return.\n\nAvailable since API v18.
", "operationId" : "exitMaintenanceMode", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/cm/service/commands/restart" : { "post" : { "tags" : [ "MgmtServiceResource" ], "summary" : "Restart the Cloudera Management Services.", "description" : "Restart the Cloudera Management Services.", "operationId" : "restartCommand", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "A reference to the submitted command." } } } }, "/cm/service/commands/start" : { "post" : { "tags" : [ "MgmtServiceResource" ], "summary" : "Start the Cloudera Management Services.", "description" : "Start the Cloudera Management Services.", "operationId" : "startCommand", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "A reference to the submitted command." } } } }, "/cm/service/commands/stop" : { "post" : { "tags" : [ "MgmtServiceResource" ], "summary" : "Stop the Cloudera Management Services.", "description" : "Stop the Cloudera Management Services.", "operationId" : "stopCommand", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "A reference to the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/nameservices" : { "get" : { "tags" : [ "NameservicesResource" ], "summary" : "List the nameservices of an HDFS service.", "description" : "List the nameservices of an HDFS service.", "operationId" : "listNameservices", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiNameserviceList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "active" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "activeFailoverController" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTED" }, "standBy" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "NA" }, "standByFailoverController" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "NA" }, "secondary" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPED" }, "mountPoints" : [ "...", "..." ], "healthSummary" : "BAD", "healthChecks" : [ { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ] }, { "name" : "...", "active" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "BUSY" }, "activeFailoverController" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "BUSY" }, "standBy" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "BUSY" }, "standByFailoverController" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "secondary" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPING" }, "mountPoints" : [ "...", "..." ], "healthSummary" : "HISTORY_NOT_AVAILABLE", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true } ] } ] } }, "description" : "List of nameservices." } } } }, "/clusters/{clusterName}/services/{serviceName}/nameservices/{nameservice}" : { "get" : { "tags" : [ "NameservicesResource" ], "summary" : "Retrieve information about a nameservice.", "description" : "Retrieve information about a nameservice.", "operationId" : "readNameservice", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "nameservice", "in" : "path", "required" : true, "type" : "string", "description" : "The nameservice to retrieve." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view to materialize. Defaults to 'full'." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiNameservice" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "active" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "activeFailoverController" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTED" }, "standBy" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTED" }, "standByFailoverController" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTING" }, "secondary" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "mountPoints" : [ "...", "..." ], "healthSummary" : "NOT_AVAILABLE", "healthChecks" : [ { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true } ] } }, "description" : "Details of the nameservice." } } } }, "/clusters/{clusterName}/services/{serviceName}/nameservices/{nameservice}/metrics" : { "get" : { "deprecated" : true, "tags" : [ "NameservicesResource" ], "summary" : "Fetch metric readings for a particular nameservice.", "description" : "Fetch metric readings for a particular nameservice.\n\nBy default, this call will look up all metrics available. If only specific\nmetrics are desired, use the metrics parameter.\n
\nBy default, the returned results correspond to a 5 minute window based on\nthe provided end time (which defaults to the current server time). The\nfrom and to parameters can be used to control the window\nbeing queried. A maximum window of 3 hours is enforced.\n
\nWhen requesting a \"full\" view, aside from the extended properties of the\nreturned metric data, the collection will also contain information about\nall metrics available, even if no readings are available in the requested\nwindow.", "operationId" : "getMetrics", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "nameservice", "in" : "path", "required" : true, "type" : "string", "description" : "The nameservice." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "from", "in" : "query", "type" : "string", "description" : "Start of the period to query." }, { "name" : "metrics", "in" : "query", "type" : "array", "items" : { "type" : "string" }, "collectionFormat" : "multi", "description" : "Filter for which metrics to query." }, { "name" : "to", "in" : "query", "default" : "now", "type" : "string", "description" : "End of the period to query." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiMetricList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "context" : "...", "unit" : "...", "data" : [ { "timestamp" : "...", "value" : 12345.0 }, { "timestamp" : "...", "value" : 12345.0 } ], "displayName" : "...", "description" : "..." }, { "name" : "...", "context" : "...", "unit" : "...", "data" : [ { "timestamp" : "...", "value" : 12345.0 }, { "timestamp" : "...", "value" : 12345.0 } ], "displayName" : "...", "description" : "..." } ] } }, "description" : "List of readings from the monitors." } } } }, "/clusters/{clusterName}/parcels/products/{product}/versions/{version}" : { "get" : { "tags" : [ "ParcelResource" ], "summary" : "Retrieves detailed information about a parcel.", "description" : "Retrieves detailed information about a parcel.", "operationId" : "readParcel", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "product", "in" : "path", "required" : true, "type" : "string", "description" : "the product" }, { "name" : "version", "in" : "path", "required" : true, "type" : "string", "description" : "the version" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiParcel" }, "headers" : {}, "examples" : { "application/json" : { "product" : "...", "version" : "...", "stage" : "...", "state" : { "progress" : 12345, "totalProgress" : 12345, "count" : 12345, "totalCount" : 12345, "errors" : [ "...", "..." ], "warnings" : [ "...", "..." ] }, "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "displayName" : "...", "description" : "..." } }, "description" : "the parcel" } } } }, "/clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/activate" : { "post" : { "tags" : [ "ParcelResource" ], "summary" : "A synchronous command that activates the parcel on the cluster.", "description" : "A synchronous command that activates the parcel on the cluster.\n
\nSince it is synchronous, the result is known immediately upon return.", "operationId" : "activateCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "product", "in" : "path", "required" : true, "type" : "string", "description" : "the product" }, { "name" : "version", "in" : "path", "required" : true, "type" : "string", "description" : "the version" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "synchronous command result" } } } }, "/clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/cancelDistribution" : { "post" : { "tags" : [ "ParcelResource" ], "summary" : "A synchronous command that cancels the parcel distribution.", "description" : "A synchronous command that cancels the parcel distribution.\n
\nSince it is synchronous, the result is known immediately upon return.", "operationId" : "cancelDistributionCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "product", "in" : "path", "required" : true, "type" : "string", "description" : "the product" }, { "name" : "version", "in" : "path", "required" : true, "type" : "string", "description" : "the version" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "synchronous command result" } } } }, "/clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/cancelDownload" : { "post" : { "tags" : [ "ParcelResource" ], "summary" : "A synchronous command that cancels the parcel download.", "description" : "A synchronous command that cancels the parcel download.\n
\nSince it is synchronous, the result is known immediately upon return.", "operationId" : "cancelDownloadCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "product", "in" : "path", "required" : true, "type" : "string", "description" : "the product" }, { "name" : "version", "in" : "path", "required" : true, "type" : "string", "description" : "the version" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "synchronous command result" } } } }, "/clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/deactivate" : { "post" : { "tags" : [ "ParcelResource" ], "summary" : "A synchronous command that deactivates the parcel on the cluster.", "description" : "A synchronous command that deactivates the parcel on the cluster.\n
\nSince it is synchronous, the result is known immediately upon return.", "operationId" : "deactivateCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "product", "in" : "path", "required" : true, "type" : "string", "description" : "the product" }, { "name" : "version", "in" : "path", "required" : true, "type" : "string", "description" : "the version" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "synchronous command result" } } } }, "/clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/removeDownload" : { "post" : { "tags" : [ "ParcelResource" ], "summary" : "A synchronous command that removes the downloaded parcel.", "description" : "A synchronous command that removes the downloaded parcel.\n
\nSince it is synchronous, the result is known immediately upon return.", "operationId" : "removeDownloadCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "product", "in" : "path", "required" : true, "type" : "string", "description" : "the product" }, { "name" : "version", "in" : "path", "required" : true, "type" : "string", "description" : "the version" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "synchronous command result" } } } }, "/clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/startDistribution" : { "post" : { "tags" : [ "ParcelResource" ], "summary" : "A synchronous command that starts the distribution of the parcel\nto the cluster.", "description" : "A synchronous command that starts the distribution of the parcel\nto the cluster.\n
\nSince it is synchronous, the result is known immediately upon return.\nIn order to see the progress of the distribution, a call\nto readParcel() needs to be made.", "operationId" : "startDistributionCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "product", "in" : "path", "required" : true, "type" : "string", "description" : "the product" }, { "name" : "version", "in" : "path", "required" : true, "type" : "string", "description" : "the version" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "synchronous command result" } } } }, "/clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/startDownload" : { "post" : { "tags" : [ "ParcelResource" ], "summary" : "A synchronous command that starts the parcel download.", "description" : "A synchronous command that starts the parcel download.\n
\nSince it is synchronous, the result is known immediately upon return.\nIn order to see the progress of the download, a call\nto readParcel() needs to be made.", "operationId" : "startDownloadCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "product", "in" : "path", "required" : true, "type" : "string", "description" : "the product" }, { "name" : "version", "in" : "path", "required" : true, "type" : "string", "description" : "the version" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "synchronous command result" } } } }, "/clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/startRemovalOfDistribution" : { "post" : { "tags" : [ "ParcelResource" ], "summary" : "A synchronous command that removes the distribution from the hosts in\nthe cluster.", "description" : "A synchronous command that removes the distribution from the hosts in\nthe cluster.\n
\nSince it is synchronous, the result is known immediately upon return.\nIn order to see the progress of the removal, a call\nto readParcel() needs to be made.", "operationId" : "startRemovalOfDistributionCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "product", "in" : "path", "required" : true, "type" : "string", "description" : "the product" }, { "name" : "version", "in" : "path", "required" : true, "type" : "string", "description" : "the version" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "synchronous command result" } } } }, "/clusters/{clusterName}/parcels" : { "get" : { "tags" : [ "ParcelsResource" ], "summary" : "Lists all parcels that the cluster has access to.", "description" : "Lists all parcels that the cluster has access to.", "operationId" : "readParcels", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiParcelList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "product" : "...", "version" : "...", "stage" : "...", "state" : { "progress" : 12345, "totalProgress" : 12345, "count" : 12345, "totalCount" : 12345, "errors" : [ "...", "..." ], "warnings" : [ "...", "..." ] }, "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "displayName" : "...", "description" : "..." }, { "product" : "...", "version" : "...", "stage" : "...", "state" : { "progress" : 12345, "totalProgress" : 12345, "count" : 12345, "totalCount" : 12345, "errors" : [ "...", "..." ], "warnings" : [ "...", "..." ] }, "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "displayName" : "...", "description" : "..." } ] } }, "description" : "List of parcels." } } } }, "/clusters/{clusterName}/parcels/usage" : { "get" : { "tags" : [ "ParcelsResource" ], "summary" : "Retrieve details parcel usage information for the cluster.", "description" : "Retrieve details parcel usage information for the cluster. This describes\nwhich processes, roles and hosts are using which parcels.", "operationId" : "getParcelUsage", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiParcelUsage" }, "headers" : {}, "examples" : { "application/json" : { "racks" : [ { "hosts" : [ { "hostRef" : {}, "roles" : [ {}, {} ] }, { "hostRef" : {}, "roles" : [ {}, {} ] } ], "rackId" : "..." }, { "hosts" : [ { "hostRef" : {}, "roles" : [ {}, {} ] }, { "hostRef" : {}, "roles" : [ {}, {} ] } ], "rackId" : "..." } ], "parcels" : [ { "parcelRef" : { "clusterName" : "...", "parcelName" : "...", "parcelVersion" : "...", "parcelDisplayName" : "..." }, "processCount" : 12345, "activated" : true }, { "parcelRef" : { "clusterName" : "...", "parcelName" : "...", "parcelVersion" : "...", "parcelDisplayName" : "..." }, "processCount" : 12345, "activated" : true } ] } }, "description" : "The parcel usage information." } } } }, "/clusters/{clusterName}/services/{serviceName}/roles/{roleName}/process" : { "get" : { "tags" : [ "ProcessResource" ], "description" : "", "operationId" : "getProcess", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiProcess" }, "headers" : {}, "examples" : { "application/json" : { "configFiles" : [ "...", "..." ] } }, "description" : "The process associated with this resource." } } } }, "/clusters/{clusterName}/services/{serviceName}/roles/{roleName}/process/configFiles/{configFileName}" : { "get" : { "tags" : [ "ProcessResource" ], "summary" : "Returns the contents of the specified config file.", "description" : "Returns the contents of the specified config file.\nA multi-level file name (e.g. hadoop-conf/hdfs-site.xml) is\nacceptable here.", "operationId" : "getConfigFile", "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "configFileName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the config file to get." }, { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "type" : "file", "description" : "" }, "headers" : {}, "examples" : {}, "description" : "Contents of the specified config file" } } } }, "/clusters/{clusterName}/services/{serviceName}/replications" : { "delete" : { "tags" : [ "ReplicationsResource" ], "summary" : "Deletes all existing replication schedules.", "description" : "Deletes all existing replication schedules.\n
\nAvailable since API v3. Only available with Cloudera Manager Enterprise\nEdition.", "operationId" : "deleteAllSchedules", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiReplicationScheduleList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "KEEP_DATA_IN_CLOUD", "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : {}, "peerState" : "ENABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ {}, {} ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : {}, "status" : "DISABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : {} }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "DAY", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "METADATA_ONLY", "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : {}, "peerState" : "ENABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ {}, {} ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : {}, "status" : "DISABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : {} }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "DAY", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true } ] } }, "description" : "List of deleted replication schedules." } } }, "get" : { "tags" : [ "ReplicationsResource" ], "summary" : "Retrieves information about replication schedules.", "description" : "Retrieves information about replication schedules.", "operationId" : "readSchedules", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "maxCommands", "in" : "query", "default" : "0", "type" : "integer", "description" : "Maximum number of commands to include in the history of replication\nschedules. By default, it has no limit. Pass 0 to explicitly set\nto unlimited." }, { "name" : "maxErrors", "in" : "query", "default" : "0", "type" : "integer", "description" : "Maximum number of errors per Hive replication command. By default, it has\nno limit. Pass 0 to explicitly set to unlimited." }, { "name" : "maxSchedules", "in" : "query", "default" : "0", "type" : "integer", "description" : "Maximum number of replication schedules to be included in the response.\nBy default, it has no limit. Pass 0 to explicitly set to unlimited." }, { "name" : "maxTables", "in" : "query", "default" : "0", "type" : "integer", "description" : "Maximum number of tables per Hive replication command. By default, it has\nno limit. Pass 0 to explicitly set to unlimited." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view to materialize." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiReplicationScheduleList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "METADATA_AND_DATA", "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : {}, "peerState" : "ENABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ {}, {} ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : {}, "status" : "ENABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : {} }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "WEEK", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "hdfsResult" : {}, "ozoneResult" : {}, "hiveResult" : {}, "hiveOnTezResult" : {}, "hbaseInfo" : {}, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "KEEP_DATA_IN_CLOUD", "sourceService" : {}, "tableFilters" : [ {}, {} ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : {}, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : {}, "peerState" : "DISABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ {}, {} ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : {}, "status" : "FAILED_ADMIN", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : {} }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "MONTH", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true } ] } }, "description" : "List of replication schedules." } } }, "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Creates one or more replication schedules.", "description" : "Creates one or more replication schedules.\n
\nAvailable since API v3. Only available with Cloudera Manager Enterprise\nEdition.",
"operationId" : "createSchedules",
"consumes" : [
"application/json"
],
"produces" : [
"application/json"
],
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : "The service name."
},
{
"name" : "body",
"in" : "body",
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiReplicationScheduleList"
},
"description" : "List of the replication schedules to create."
}
],
"responses" : {
"201" : {
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiReplicationScheduleList"
},
"headers" : {},
"examples" : {
"application/json" : {
"items" : [
{
"hdfsArguments" : {
"sourceService" : {},
"sourcePath" : "...",
"destinationPath" : "...",
"mapreduceServiceName" : "...",
"schedulerPoolName" : "...",
"userName" : "...",
"sourceUser" : "...",
"numMaps" : 12345,
"dryRun" : true,
"bandwidthPerMap" : 12345,
"abortOnError" : true,
"removeMissingFiles" : true,
"preserveReplicationCount" : true,
"preserveBlockSize" : true,
"preservePermissions" : true,
"logPath" : "...",
"skipChecksumChecks" : true,
"skipListingChecksumChecks" : true,
"skipTrash" : true,
"replicationStrategy" : "DYNAMIC",
"preserveXAttrs" : true,
"exclusionFilters" : [
"...",
"..."
],
"raiseSnapshotDiffFailures" : true,
"deleteLatestSourceSnapshotOnJobFailure" : true,
"destinationCloudAccount" : "..."
},
"hiveArguments" : {
"sourceService" : {},
"tableFilters" : [
{},
{}
],
"exportDir" : "...",
"force" : true,
"replicateData" : true,
"hdfsArguments" : {},
"replicateImpalaMetadata" : true,
"runInvalidateMetadata" : true,
"dryRun" : true,
"numThreads" : 12345,
"sentryMigration" : true,
"skipUrlPermissions" : true
},
"hdfsCloudArguments" : {
"sourceAccount" : "...",
"destinationAccount" : "...",
"sourceService" : {},
"sourcePath" : "...",
"destinationPath" : "...",
"mapreduceServiceName" : "...",
"schedulerPoolName" : "...",
"userName" : "...",
"sourceUser" : "...",
"numMaps" : 12345,
"dryRun" : true,
"bandwidthPerMap" : 12345,
"abortOnError" : true,
"removeMissingFiles" : true,
"preserveReplicationCount" : true,
"preserveBlockSize" : true,
"preservePermissions" : true,
"logPath" : "...",
"skipChecksumChecks" : true,
"skipListingChecksumChecks" : true,
"skipTrash" : true,
"replicationStrategy" : "STATIC",
"preserveXAttrs" : true,
"exclusionFilters" : [
"...",
"..."
],
"raiseSnapshotDiffFailures" : true,
"deleteLatestSourceSnapshotOnJobFailure" : true,
"destinationCloudAccount" : "..."
},
"ozoneReplicationArguments" : {
"originalSourcePath" : "...",
"originalDestinationPath" : "...",
"sourceService" : {},
"sourcePath" : "...",
"destinationPath" : "...",
"mapreduceServiceName" : "...",
"schedulerPoolName" : "...",
"userName" : "...",
"sourceUser" : "...",
"numMaps" : 12345,
"dryRun" : true,
"bandwidthPerMap" : 12345,
"abortOnError" : true,
"removeMissingFiles" : true,
"preserveReplicationCount" : true,
"preserveBlockSize" : true,
"preservePermissions" : true,
"logPath" : "...",
"skipChecksumChecks" : true,
"skipListingChecksumChecks" : true,
"skipTrash" : true,
"replicationStrategy" : "DYNAMIC",
"preserveXAttrs" : true,
"exclusionFilters" : [
"...",
"..."
],
"raiseSnapshotDiffFailures" : true,
"deleteLatestSourceSnapshotOnJobFailure" : true,
"destinationCloudAccount" : "..."
},
"history" : [
{
"hdfsResult" : {},
"ozoneResult" : {},
"hiveResult" : {},
"hiveOnTezResult" : {},
"hbaseInfo" : {},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
{
"hdfsResult" : {},
"ozoneResult" : {},
"hiveResult" : {},
"hiveOnTezResult" : {},
"hbaseInfo" : {},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
}
],
"active" : true,
"hiveCloudArguments" : {
"sourceAccount" : "...",
"destinationAccount" : "...",
"cloudRootPath" : "...",
"replicationOption" : "METADATA_AND_DATA",
"sourceService" : {},
"tableFilters" : [
{},
{}
],
"exportDir" : "...",
"force" : true,
"replicateData" : true,
"hdfsArguments" : {},
"replicateImpalaMetadata" : true,
"runInvalidateMetadata" : true,
"dryRun" : true,
"numThreads" : 12345,
"sentryMigration" : true,
"skipUrlPermissions" : true
},
"hbaseArguments" : {
"sourceHBaseService" : {},
"peerState" : "ENABLED",
"hbaseClusterKey" : "...",
"endPointClassName" : "...",
"tables" : [
{},
{}
],
"replicationProperties" : {
"property1" : "...",
"property2" : "..."
},
"sourceAccount" : "...",
"sourceSchedulerPool" : "...",
"numMappers" : 12345,
"snapshotScratchLocation" : "...",
"validateReplicationSetup" : true
},
"hive3Arguments" : {
"sourceHiveService" : {},
"status" : "FAILED_ADMIN",
"rangerReplication" : true,
"atlasReplication" : true,
"externalTableReplication" : true,
"externalTableBaseDir" : "...",
"distcpOnTarget" : true,
"numMaps" : 12345,
"bandwidthPerMap" : 12345,
"policyOptions" : {
"property1" : "...",
"property2" : "..."
},
"sourceDbName" : "...",
"targetDbName" : "...",
"policyName" : "...",
"scheduleClause" : "...",
"runAs" : "...",
"hiveOp" : "...",
"hiveUpdateOp" : "...",
"excludeSource" : true,
"excludeTarget" : true,
"failoverStatus" : "...",
"cloudArgs" : {}
},
"id" : 12345,
"displayName" : "...",
"description" : "...",
"startTime" : "...",
"endTime" : "...",
"interval" : 12345,
"intervalUnit" : "MONTH",
"nextRun" : "...",
"paused" : true,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true
},
{
"hdfsArguments" : {
"sourceService" : {},
"sourcePath" : "...",
"destinationPath" : "...",
"mapreduceServiceName" : "...",
"schedulerPoolName" : "...",
"userName" : "...",
"sourceUser" : "...",
"numMaps" : 12345,
"dryRun" : true,
"bandwidthPerMap" : 12345,
"abortOnError" : true,
"removeMissingFiles" : true,
"preserveReplicationCount" : true,
"preserveBlockSize" : true,
"preservePermissions" : true,
"logPath" : "...",
"skipChecksumChecks" : true,
"skipListingChecksumChecks" : true,
"skipTrash" : true,
"replicationStrategy" : "STATIC",
"preserveXAttrs" : true,
"exclusionFilters" : [
"...",
"..."
],
"raiseSnapshotDiffFailures" : true,
"deleteLatestSourceSnapshotOnJobFailure" : true,
"destinationCloudAccount" : "..."
},
"hiveArguments" : {
"sourceService" : {},
"tableFilters" : [
{},
{}
],
"exportDir" : "...",
"force" : true,
"replicateData" : true,
"hdfsArguments" : {},
"replicateImpalaMetadata" : true,
"runInvalidateMetadata" : true,
"dryRun" : true,
"numThreads" : 12345,
"sentryMigration" : true,
"skipUrlPermissions" : true
},
"hdfsCloudArguments" : {
"sourceAccount" : "...",
"destinationAccount" : "...",
"sourceService" : {},
"sourcePath" : "...",
"destinationPath" : "...",
"mapreduceServiceName" : "...",
"schedulerPoolName" : "...",
"userName" : "...",
"sourceUser" : "...",
"numMaps" : 12345,
"dryRun" : true,
"bandwidthPerMap" : 12345,
"abortOnError" : true,
"removeMissingFiles" : true,
"preserveReplicationCount" : true,
"preserveBlockSize" : true,
"preservePermissions" : true,
"logPath" : "...",
"skipChecksumChecks" : true,
"skipListingChecksumChecks" : true,
"skipTrash" : true,
"replicationStrategy" : "DYNAMIC",
"preserveXAttrs" : true,
"exclusionFilters" : [
"...",
"..."
],
"raiseSnapshotDiffFailures" : true,
"deleteLatestSourceSnapshotOnJobFailure" : true,
"destinationCloudAccount" : "..."
},
"ozoneReplicationArguments" : {
"originalSourcePath" : "...",
"originalDestinationPath" : "...",
"sourceService" : {},
"sourcePath" : "...",
"destinationPath" : "...",
"mapreduceServiceName" : "...",
"schedulerPoolName" : "...",
"userName" : "...",
"sourceUser" : "...",
"numMaps" : 12345,
"dryRun" : true,
"bandwidthPerMap" : 12345,
"abortOnError" : true,
"removeMissingFiles" : true,
"preserveReplicationCount" : true,
"preserveBlockSize" : true,
"preservePermissions" : true,
"logPath" : "...",
"skipChecksumChecks" : true,
"skipListingChecksumChecks" : true,
"skipTrash" : true,
"replicationStrategy" : "DYNAMIC",
"preserveXAttrs" : true,
"exclusionFilters" : [
"...",
"..."
],
"raiseSnapshotDiffFailures" : true,
"deleteLatestSourceSnapshotOnJobFailure" : true,
"destinationCloudAccount" : "..."
},
"history" : [
{
"hdfsResult" : {},
"ozoneResult" : {},
"hiveResult" : {},
"hiveOnTezResult" : {},
"hbaseInfo" : {},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
{
"hdfsResult" : {},
"ozoneResult" : {},
"hiveResult" : {},
"hiveOnTezResult" : {},
"hbaseInfo" : {},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
}
],
"active" : true,
"hiveCloudArguments" : {
"sourceAccount" : "...",
"destinationAccount" : "...",
"cloudRootPath" : "...",
"replicationOption" : "METADATA_ONLY",
"sourceService" : {},
"tableFilters" : [
{},
{}
],
"exportDir" : "...",
"force" : true,
"replicateData" : true,
"hdfsArguments" : {},
"replicateImpalaMetadata" : true,
"runInvalidateMetadata" : true,
"dryRun" : true,
"numThreads" : 12345,
"sentryMigration" : true,
"skipUrlPermissions" : true
},
"hbaseArguments" : {
"sourceHBaseService" : {},
"peerState" : "ENABLED",
"hbaseClusterKey" : "...",
"endPointClassName" : "...",
"tables" : [
{},
{}
],
"replicationProperties" : {
"property1" : "...",
"property2" : "..."
},
"sourceAccount" : "...",
"sourceSchedulerPool" : "...",
"numMappers" : 12345,
"snapshotScratchLocation" : "...",
"validateReplicationSetup" : true
},
"hive3Arguments" : {
"sourceHiveService" : {},
"status" : "ENABLED",
"rangerReplication" : true,
"atlasReplication" : true,
"externalTableReplication" : true,
"externalTableBaseDir" : "...",
"distcpOnTarget" : true,
"numMaps" : 12345,
"bandwidthPerMap" : 12345,
"policyOptions" : {
"property1" : "...",
"property2" : "..."
},
"sourceDbName" : "...",
"targetDbName" : "...",
"policyName" : "...",
"scheduleClause" : "...",
"runAs" : "...",
"hiveOp" : "...",
"hiveUpdateOp" : "...",
"excludeSource" : true,
"excludeTarget" : true,
"failoverStatus" : "...",
"cloudArgs" : {}
},
"id" : 12345,
"displayName" : "...",
"description" : "...",
"startTime" : "...",
"endTime" : "...",
"interval" : 12345,
"intervalUnit" : "WEEK",
"nextRun" : "...",
"paused" : true,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true
}
]
}
},
"description" : "List of newly added replication schedules."
}
}
}
},
"/clusters/{clusterName}/services/{serviceName}/replications/createCloudCredstoreOnHdfs" : {
"post" : {
"tags" : [
"ReplicationsResource"
],
"summary" : "Creates a credstore provider jceks file on HDFS for the given service.",
"description" : "Creates a credstore provider jceks file on HDFS for the given service.\nThe file will store credential information for the given sourceAccount.",
"operationId" : "createCloudCredstoreOnHdfs",
"produces" : [
"application/json"
],
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : "The service name."
},
{
"name" : "force",
"in" : "query",
"type" : "boolean",
"description" : "if the jceks file already exists on HDFS and this parameter is set to true\nthen it will be recreated, otherwise left untouched"
},
{
"name" : "sourceAccount",
"in" : "query",
"type" : "string",
"description" : "the External Account that has been already added to this CM,\nfor which the credstore provider jceks file will be generated"
}
],
"responses" : {
"201" : {
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiCommand"
},
"headers" : {},
"examples" : {
"application/json" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "NOT_AVAILABLE",
"roleStatus" : "STOPPING"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "GOOD",
"roleStatus" : "STOPPED"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {},
"children" : {
"items" : [
{},
{}
]
},
"canRetry" : true
},
"children" : {
"items" : [
{
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
{
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
}
]
},
"canRetry" : true
}
},
"description" : "command for creating the Hive3 credstore"
}
}
}
},
"/clusters/{clusterName}/services/{serviceName}/replications/createCredstore" : {
"post" : {
"deprecated" : true,
"tags" : [
"ReplicationsResource"
],
"summary" : "Use the following API endpoint instead:.",
"description" : "Use the following API endpoint instead: \ncom.cloudera.api.v50.ReplicationsResourceV50#createCloudCredstoreOnHdfs(String, boolean)",
"operationId" : "createCredstore",
"produces" : [
"application/json"
],
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : "The service name."
},
{
"name" : "credstoreDirPath",
"in" : "query",
"type" : "string",
"description" : ""
},
{
"name" : "force",
"in" : "query",
"type" : "boolean",
"description" : ""
},
{
"name" : "sourceAccount",
"in" : "query",
"type" : "string",
"description" : ""
}
],
"responses" : {
"201" : {
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiCommand"
},
"headers" : {},
"examples" : {
"application/json" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "CONCERNING",
"roleStatus" : "NA"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "BAD",
"roleStatus" : "STOPPING"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {},
"children" : {
"items" : [
{},
{}
]
},
"canRetry" : true
},
"children" : {
"items" : [
{
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
{
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
}
]
},
"canRetry" : true
}
},
"description" : ""
}
}
}
},
"/clusters/{clusterName}/services/{serviceName}/replications/generateCloudReplCredstorePassword" : {
"post" : {
"tags" : [
"ReplicationsResource"
],
"summary" : "(Re)generates the cloud credential provider password, used by the given service,\nfor replicating to the cloud.",
"description" : "(Re)generates the cloud credential provider password, used by the given service,\nfor replicating to the cloud.
\nCalling this API endpoint may cause staleness for the given service.
\nNOTE: If this API endpoint REGENERATED the credstore password successfully and\nthere are existing credstore provider jceks files on HDFS, protected by this password,\nthen these jceks files should be recreated by using the following API endpoint:\n#recreateCloudCredstoresOnHdfs().",
"operationId" : "generateCloudReplCredstorePassword",
"produces" : [
"application/json"
],
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : "The service name."
},
{
"name" : "passwordGenerateMode",
"in" : "query",
"type" : "string",
"enum" : [
"FORCE",
"GENERATE_IF_NULL",
"REGENERATE_IF_SET"
],
"description" : "the CloudReplPasswordGenerateMode to be used\nfor regenerating the password."
}
],
"responses" : {
"201" : {
"schema" : {
"description" : "",
"type" : "boolean"
},
"headers" : {},
"examples" : {},
"description" : "true if the credential provider password was regenerated,\notherwise false if it was untouched."
}
}
}
},
"/clusters/{clusterName}/services/{serviceName}/replications/hbaseReplicationSecurityTool" : {
"post" : {
"tags" : [
"ReplicationsResource"
],
"summary" : "Run the hbase replication security tool.",
"description" : "Run the hbase replication security tool\n
\nThe replication security tool is invoked against the provided arguments\n
", "operationId" : "runHBaseReplicationSecurityTool", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "type" : "object", "additionalProperties" : { "type" : "string" } }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/hbaseReplicationValidationTool" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Executes a command, which validates if HBase replication works properly\nfor the given hbasePeerId.", "description" : "Executes a command, which validates if HBase replication works properly\nfor the given hbasePeerId", "operationId" : "runHBaseReplicationValidationTool", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "hbasePeerId", "in" : "query", "type" : "string", "description" : "The HBase peer ID to be validated" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "command to run hbase replication validation tool" } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/hdfsCopyListing" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Run the hdfs copy listing command.", "description" : "Run the hdfs copy listing command\n
\nThe copy listing command will be triggered with the provided arguments\n
\nAvailable since API v18. Only available with Cloudera Manager Enterprise\nEdition.", "operationId" : "runCopyListing", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "type" : "string" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/hiveReplicationQuery" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Execute a hive replication query on local HS2 service instance.", "description" : "Execute a hive replication query on local HS2 service instance\n
\nThe command executes hive replication query on local HS2 instance\nwith the provided arguments\n
", "operationId" : "runHiveReplicationQuery", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHive3ReplicationArguments" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/isHive3ReverseDirectionEnabled" : { "get" : { "tags" : [ "ReplicationsResource" ], "summary" : "This API endpoint checks if there is an ENABLED Hive3 replication policy\non this server that replicates for the reverse direction.", "description" : "This API endpoint checks if there is an ENABLED Hive3 replication policy\non this server that replicates for the reverse direction.\nBidirectional Hive3 replication policies are allowed,\nbut only one direction can be ENABLED at the same time.", "operationId" : "isHive3ReverseDirectionEnabled", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "clusterUuidOnRemote", "in" : "query", "type" : "string", "description" : "the uuid of the cluster on the remote CM server" }, { "name" : "serviceNameOnRemote", "in" : "query", "type" : "string", "description" : "the Hive3 service name on the remote CM server,\nmore specifically on the cluster specified by clusterUuidOnRemote" }, { "name" : "sourceDbNameOnRemote", "in" : "query", "type" : "string", "description" : "the name of the source database on the remote CM server" }, { "name" : "targetDbNameOnRemote", "in" : "query", "type" : "string", "description" : "the name of the target database on the remote CM server" } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "boolean" }, "headers" : {}, "examples" : {}, "description" : "true if there is an ENABLED Hive3 replication policy on this server,\nthat replicates the given databases but for the reverse direction, otherwise false." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/recreateCloudCredstoresOnHdfs" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Recreates the existing credential provider jceks files on HDFS,\nthat are used by the given service, for replicating to the cloud.", "description" : "Recreates the existing credential provider jceks files on HDFS,\nthat are used by the given service, for replicating to the cloud.", "operationId" : "recreateCloudCredstoresOnHdfs", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "command for recreating the credential provider jceks files" } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/replicationState" : { "get" : { "tags" : [ "ReplicationsResource" ], "summary" : "returns the replication state.", "description" : "returns the replication state. for example if incremental export\nis enabled, etc", "operationId" : "getReplicationState", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "view to materialize" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiReplicationState" }, "headers" : {}, "examples" : { "application/json" : { "incrementalExportEnabled" : true } }, "description" : "replicate state object." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/rescheduleHive3ReplicationMetricsGetter" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Set the Hive3 Replication Metrics Getter next start time.", "description" : "Set the Hive3 Replication Metrics Getter next start time.\n
\n(Re)set the Hive3 Replication Metrics Getter next start time.\nShould be only used if the Getter needs to be manually started.\n
", "operationId" : "rescheduleHive3ReplicationMetricsGetter", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "nextStartMins", "in" : "query", "default" : "5", "type" : "integer", "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "type" : "boolean" }, "headers" : {}, "examples" : {}, "description" : "success or not." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}" : { "delete" : { "tags" : [ "ReplicationsResource" ], "summary" : "Deletes an existing replication schedule.", "description" : "Deletes an existing replication schedule.\n
\nAvailable since API v3. Only available with Cloudera Manager Enterprise\nEdition.", "operationId" : "deleteSchedule", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "scheduleId", "in" : "path", "required" : true, "type" : "integer", "description" : "Id of an existing replication schedule." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiReplicationSchedule" }, "headers" : {}, "examples" : { "application/json" : { "hdfsArguments" : { "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "tableFilters" : [ { "database" : "...", "tableName" : "..." }, { "database" : "...", "tableName" : "..." } ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "ozoneResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "hiveResult" : { "phase" : "...", "tableCount" : 12345, "tables" : [ {}, {} ], "impalaUDFCount" : 12345, "hiveUDFCount" : 12345, "impalaUDFs" : [ {}, {} ], "hiveUDFs" : [ {}, {} ], "errorCount" : 12345, "errors" : [ {}, {} ], "dataReplicationResult" : {}, "dryRun" : true, "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "directoryForMetadata" : "...", "statsAvailable" : true, "dbProcessed" : 12345, "tableProcessed" : 12345, "partitionProcessed" : 12345, "functionProcessed" : 12345, "indexProcessed" : 12345, "statsProcessed" : 12345, "dbExpected" : 12345, "tableExpected" : 12345, "partitionExpected" : 12345, "functionExpected" : 12345, "indexExpected" : 12345, "statsExpected" : 12345 }, "hiveOnTezResult" : { "type" : "...", "status" : "...", "error" : "...", "tablesCurrent" : 12345, "tablesTotal" : 12345, "functionsCurrent" : 12345, "functionsTotal" : 12345, "eventsCurrent" : 12345, "eventsTotal" : 12345, "policiesCurrent" : 12345, "policiesTotal" : 12345, "entitiesCurrent" : 12345, "entitiesTotal" : 12345, "origin" : "SOURCE" }, "hbaseInfo" : { "replicationOperations" : [ "...", "..." ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "hdfsResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "ozoneResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "hiveResult" : { "phase" : "...", "tableCount" : 12345, "tables" : [ {}, {} ], "impalaUDFCount" : 12345, "hiveUDFCount" : 12345, "impalaUDFs" : [ {}, {} ], "hiveUDFs" : [ {}, {} ], "errorCount" : 12345, "errors" : [ {}, {} ], "dataReplicationResult" : {}, "dryRun" : true, "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "directoryForMetadata" : "...", "statsAvailable" : true, "dbProcessed" : 12345, "tableProcessed" : 12345, "partitionProcessed" : 12345, "functionProcessed" : 12345, "indexProcessed" : 12345, "statsProcessed" : 12345, "dbExpected" : 12345, "tableExpected" : 12345, "partitionExpected" : 12345, "functionExpected" : 12345, "indexExpected" : 12345, "statsExpected" : 12345 }, "hiveOnTezResult" : { "type" : "...", "status" : "...", "error" : "...", "tablesCurrent" : 12345, "tablesTotal" : 12345, "functionsCurrent" : 12345, "functionsTotal" : 12345, "eventsCurrent" : 12345, "eventsTotal" : 12345, "policiesCurrent" : 12345, "policiesTotal" : 12345, "entitiesCurrent" : 12345, "entitiesTotal" : 12345, "origin" : "SOURCE" }, "hbaseInfo" : { "replicationOperations" : [ "...", "..." ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "KEEP_DATA_IN_CLOUD", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "tableFilters" : [ { "database" : "...", "tableName" : "..." }, { "database" : "...", "tableName" : "..." } ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "peerState" : "ENABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ { "tableName" : "...", "initialSnapshot" : true, "snapshotSucceeded" : true }, { "tableName" : "...", "initialSnapshot" : true, "snapshotSucceeded" : true } ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "status" : "ENABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : { "sourceAccount" : "..." } }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "WEEK", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true } }, "description" : "The deleted replication schedule." } } }, "get" : { "tags" : [ "ReplicationsResource" ], "summary" : "Returns information for a specific replication schedule.", "description" : "Returns information for a specific replication schedule.\n
\nAvailable since API v3. Only available with Cloudera Manager Enterprise\nEdition.", "operationId" : "readSchedule", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "scheduleId", "in" : "path", "required" : true, "type" : "integer", "description" : "Id of an existing replication schedule." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view to materialize." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiReplicationSchedule" }, "headers" : {}, "examples" : { "application/json" : { "hdfsArguments" : { "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "tableFilters" : [ { "database" : "...", "tableName" : "..." }, { "database" : "...", "tableName" : "..." } ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "ozoneResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "hiveResult" : { "phase" : "...", "tableCount" : 12345, "tables" : [ {}, {} ], "impalaUDFCount" : 12345, "hiveUDFCount" : 12345, "impalaUDFs" : [ {}, {} ], "hiveUDFs" : [ {}, {} ], "errorCount" : 12345, "errors" : [ {}, {} ], "dataReplicationResult" : {}, "dryRun" : true, "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "directoryForMetadata" : "...", "statsAvailable" : true, "dbProcessed" : 12345, "tableProcessed" : 12345, "partitionProcessed" : 12345, "functionProcessed" : 12345, "indexProcessed" : 12345, "statsProcessed" : 12345, "dbExpected" : 12345, "tableExpected" : 12345, "partitionExpected" : 12345, "functionExpected" : 12345, "indexExpected" : 12345, "statsExpected" : 12345 }, "hiveOnTezResult" : { "type" : "...", "status" : "...", "error" : "...", "tablesCurrent" : 12345, "tablesTotal" : 12345, "functionsCurrent" : 12345, "functionsTotal" : 12345, "eventsCurrent" : 12345, "eventsTotal" : 12345, "policiesCurrent" : 12345, "policiesTotal" : 12345, "entitiesCurrent" : 12345, "entitiesTotal" : 12345, "origin" : "SOURCE" }, "hbaseInfo" : { "replicationOperations" : [ "...", "..." ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "hdfsResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "ozoneResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "hiveResult" : { "phase" : "...", "tableCount" : 12345, "tables" : [ {}, {} ], "impalaUDFCount" : 12345, "hiveUDFCount" : 12345, "impalaUDFs" : [ {}, {} ], "hiveUDFs" : [ {}, {} ], "errorCount" : 12345, "errors" : [ {}, {} ], "dataReplicationResult" : {}, "dryRun" : true, "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "directoryForMetadata" : "...", "statsAvailable" : true, "dbProcessed" : 12345, "tableProcessed" : 12345, "partitionProcessed" : 12345, "functionProcessed" : 12345, "indexProcessed" : 12345, "statsProcessed" : 12345, "dbExpected" : 12345, "tableExpected" : 12345, "partitionExpected" : 12345, "functionExpected" : 12345, "indexExpected" : 12345, "statsExpected" : 12345 }, "hiveOnTezResult" : { "type" : "...", "status" : "...", "error" : "...", "tablesCurrent" : 12345, "tablesTotal" : 12345, "functionsCurrent" : 12345, "functionsTotal" : 12345, "eventsCurrent" : 12345, "eventsTotal" : 12345, "policiesCurrent" : 12345, "policiesTotal" : 12345, "entitiesCurrent" : 12345, "entitiesTotal" : 12345, "origin" : "TARGET" }, "hbaseInfo" : { "replicationOperations" : [ "...", "..." ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "METADATA_ONLY", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "tableFilters" : [ { "database" : "...", "tableName" : "..." }, { "database" : "...", "tableName" : "..." } ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "peerState" : "ENABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ { "tableName" : "...", "initialSnapshot" : true, "snapshotSucceeded" : true }, { "tableName" : "...", "initialSnapshot" : true, "snapshotSucceeded" : true } ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "status" : "DISABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : { "sourceAccount" : "..." } }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "WEEK", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true } }, "description" : "Replication schedule." } } }, "put" : { "tags" : [ "ReplicationsResource" ], "summary" : "Updates an existing replication schedule.", "description" : "Updates an existing replication schedule.\n
\nAvailable since API v3. Only available with Cloudera Manager Enterprise\nEdition.", "operationId" : "updateSchedule", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "scheduleId", "in" : "path", "required" : true, "type" : "integer", "description" : "Id of an existing replication schedule." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiReplicationSchedule" }, "description" : "" } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiReplicationSchedule" }, "headers" : {}, "examples" : { "application/json" : { "hdfsArguments" : { "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "tableFilters" : [ { "database" : "...", "tableName" : "..." }, { "database" : "...", "tableName" : "..." } ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "ozoneResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "hiveResult" : { "phase" : "...", "tableCount" : 12345, "tables" : [ {}, {} ], "impalaUDFCount" : 12345, "hiveUDFCount" : 12345, "impalaUDFs" : [ {}, {} ], "hiveUDFs" : [ {}, {} ], "errorCount" : 12345, "errors" : [ {}, {} ], "dataReplicationResult" : {}, "dryRun" : true, "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "directoryForMetadata" : "...", "statsAvailable" : true, "dbProcessed" : 12345, "tableProcessed" : 12345, "partitionProcessed" : 12345, "functionProcessed" : 12345, "indexProcessed" : 12345, "statsProcessed" : 12345, "dbExpected" : 12345, "tableExpected" : 12345, "partitionExpected" : 12345, "functionExpected" : 12345, "indexExpected" : 12345, "statsExpected" : 12345 }, "hiveOnTezResult" : { "type" : "...", "status" : "...", "error" : "...", "tablesCurrent" : 12345, "tablesTotal" : 12345, "functionsCurrent" : 12345, "functionsTotal" : 12345, "eventsCurrent" : 12345, "eventsTotal" : 12345, "policiesCurrent" : 12345, "policiesTotal" : 12345, "entitiesCurrent" : 12345, "entitiesTotal" : 12345, "origin" : "TARGET" }, "hbaseInfo" : { "replicationOperations" : [ "...", "..." ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "hdfsResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "ozoneResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "hiveResult" : { "phase" : "...", "tableCount" : 12345, "tables" : [ {}, {} ], "impalaUDFCount" : 12345, "hiveUDFCount" : 12345, "impalaUDFs" : [ {}, {} ], "hiveUDFs" : [ {}, {} ], "errorCount" : 12345, "errors" : [ {}, {} ], "dataReplicationResult" : {}, "dryRun" : true, "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "directoryForMetadata" : "...", "statsAvailable" : true, "dbProcessed" : 12345, "tableProcessed" : 12345, "partitionProcessed" : 12345, "functionProcessed" : 12345, "indexProcessed" : 12345, "statsProcessed" : 12345, "dbExpected" : 12345, "tableExpected" : 12345, "partitionExpected" : 12345, "functionExpected" : 12345, "indexExpected" : 12345, "statsExpected" : 12345 }, "hiveOnTezResult" : { "type" : "...", "status" : "...", "error" : "...", "tablesCurrent" : 12345, "tablesTotal" : 12345, "functionsCurrent" : 12345, "functionsTotal" : 12345, "eventsCurrent" : 12345, "eventsTotal" : 12345, "policiesCurrent" : 12345, "policiesTotal" : 12345, "entitiesCurrent" : 12345, "entitiesTotal" : 12345, "origin" : "TARGET" }, "hbaseInfo" : { "replicationOperations" : [ "...", "..." ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "KEEP_DATA_IN_CLOUD", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "tableFilters" : [ { "database" : "...", "tableName" : "..." }, { "database" : "...", "tableName" : "..." } ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "peerState" : "DISABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ { "tableName" : "...", "initialSnapshot" : true, "snapshotSucceeded" : true }, { "tableName" : "...", "initialSnapshot" : true, "snapshotSucceeded" : true } ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "status" : "DISABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : { "sourceAccount" : "..." } }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true } }, "description" : "The replication schedule after the update." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/operations/addReplicationPeer" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Starts a command that adds a new replication peer to HBase.", "description" : "Starts a command that adds a new replication peer to HBase.", "operationId" : "addHBaseReplicationPeer", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHBaseAddReplicationPeerInput" }, "description" : "Information for peer creation." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the started command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/operations/addTablesToHBasePeer" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Starts a command that adds tables and column families to an existing HBase replication peer.", "description" : "Starts a command that adds tables and column families to an existing HBase replication peer.", "operationId" : "addTablesToHBasePeer", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHBasePeerIdWithTableCFs" }, "description" : "Arguments for the operation." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the started command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/operations/checkTables" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Starts a command that checks if the specified tables exist in HBase.", "description" : "Starts a command that checks if the specified tables exist in HBase.", "operationId" : "checkHBaseTablesExist", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHBaseTableNames" }, "description" : "Names of the tables to be checked." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the started command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/operations/createTable" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Starts a command that creates a new table in HBase.", "description" : "Starts a command that creates a new table in HBase.", "operationId" : "createHBaseTable", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHBaseCreateTable" }, "description" : "Arguments for table creation." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the started command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/operations/fetchColumnFamilies" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Starts a command that fetches column families for the desired tables.", "description" : "Starts a command that fetches column families for the desired tables.", "operationId" : "fetchHBaseColumnFamilies", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHBaseTableNames" }, "description" : "Names of tables to query for column families." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the started command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/operations/fetchHBasePeerInfo" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Starts a command that fetches information about an HBase peer by its ID.", "description" : "Starts a command that fetches information about an HBase peer by its ID.", "operationId" : "fetchHBasePeerInfo", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHBasePeerId" }, "description" : "ID of the fetched peer." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the started command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/operations/listNamespaces" : { "get" : { "tags" : [ "ReplicationsResource" ], "summary" : "Starts a command that lists all namespaces in HBase.", "description" : "Starts a command that lists all namespaces in HBase.", "operationId" : "listHBaseNamespaces", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the started command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/operations/listPeers" : { "get" : { "tags" : [ "ReplicationsResource" ], "summary" : "Starts a command that retrieves all peers registered in the HBase service.", "description" : "Starts a command that retrieves all peers registered in the HBase service.", "operationId" : "listHBasePeers", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the started command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/operations/listTables" : { "get" : { "tags" : [ "ReplicationsResource" ], "summary" : "Starts a command that lists tables from the HBase service.", "description" : "Starts a command that lists tables from the HBase service.", "operationId" : "listHBaseTables", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the started command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/operations/removeHBasePeer" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Starts a command that removes the specified HBase replication peer from the local HBase\nservice.", "description" : "Starts a command that removes the specified HBase replication peer from the local HBase\nservice.", "operationId" : "removeHBasePeer", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHBasePeerId" }, "description" : "ID of the peer to be removed." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the started command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/operations/removeTablesFromHBasePeer" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Starts a command that removes tables and column families from an existing HBase replication\npeer.", "description" : "Starts a command that removes tables and column families from an existing HBase replication\npeer.", "operationId" : "removeTablesFromHBasePeer", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHBasePeerIdWithTableCFs" }, "description" : "Arguments for removing tables from HBase replication peer." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the started command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/operations/setCFsReplicationScope" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Starts a command that set the replication scope of the provided column families to the\ndesired value.", "description" : "Starts a command that set the replication scope of the provided column families to the\ndesired value.", "operationId" : "setCFsReplicationScope", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHBaseSetCFsReplicationScope" }, "description" : "Arguments for setting the replication scope." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the started command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/operations/updateReplicationPeerState" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Starts a command that updates the state of an existing HBase replication peer.", "description" : "Starts a command that updates the state of an existing HBase replication peer.", "operationId" : "updateHBaseReplicationPeerState", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHBaseUpdateReplicationPeerState" }, "description" : "Arguments for operation." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the started command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/collectDiagnosticData" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Collect diagnostic data for a schedule, optionally for a subset of commands\non that schedule, matched by schedule ID.", "description" : "Collect diagnostic data for a schedule, optionally for a subset of commands\non that schedule, matched by schedule ID.\n\nThe returned command's resultDataUrl property, upon the commands completion,\nwill refer to the generated diagnostic data.\nAvailable since API v11.", "operationId" : "collectDiagnosticData", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "scheduleId", "in" : "path", "required" : true, "type" : "integer", "description" : "Schedule ID" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "view to materialize" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiReplicationDiagnosticsCollectionArgs" }, "description" : "Replication collection arguments" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Command generated to collect the diagnostics data." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/forcedDelete" : { "delete" : { "tags" : [ "ReplicationsResource" ], "summary" : "Deletes an existing replication schedule only from the DB.", "description" : "Deletes an existing replication schedule only from the DB.\n
\nOnly the DB schedule reference is deleted with no further cleanup on the source or target side.\nTypically this endpoint can be used when the source cluster is not available any more and normal\npolicy delete fails during cleanup.\n\nAvailable since API v46. Only available with Cloudera Manager Enterprise\nEdition.", "operationId" : "forceDeleteSchedule", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "scheduleId", "in" : "path", "required" : true, "type" : "integer", "description" : "Id of an existing replication schedule." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiReplicationSchedule" }, "headers" : {}, "examples" : { "application/json" : { "hdfsArguments" : { "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "hiveArguments" : { "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "tableFilters" : [ { "database" : "...", "tableName" : "..." }, { "database" : "...", "tableName" : "..." } ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hdfsCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "ozoneReplicationArguments" : { "originalSourcePath" : "...", "originalDestinationPath" : "...", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "STATIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "history" : [ { "hdfsResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "ozoneResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "hiveResult" : { "phase" : "...", "tableCount" : 12345, "tables" : [ {}, {} ], "impalaUDFCount" : 12345, "hiveUDFCount" : 12345, "impalaUDFs" : [ {}, {} ], "hiveUDFs" : [ {}, {} ], "errorCount" : 12345, "errors" : [ {}, {} ], "dataReplicationResult" : {}, "dryRun" : true, "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "directoryForMetadata" : "...", "statsAvailable" : true, "dbProcessed" : 12345, "tableProcessed" : 12345, "partitionProcessed" : 12345, "functionProcessed" : 12345, "indexProcessed" : 12345, "statsProcessed" : 12345, "dbExpected" : 12345, "tableExpected" : 12345, "partitionExpected" : 12345, "functionExpected" : 12345, "indexExpected" : 12345, "statsExpected" : 12345 }, "hiveOnTezResult" : { "type" : "...", "status" : "...", "error" : "...", "tablesCurrent" : 12345, "tablesTotal" : 12345, "functionsCurrent" : 12345, "functionsTotal" : 12345, "eventsCurrent" : 12345, "eventsTotal" : 12345, "policiesCurrent" : 12345, "policiesTotal" : 12345, "entitiesCurrent" : 12345, "entitiesTotal" : 12345, "origin" : "TARGET" }, "hbaseInfo" : { "replicationOperations" : [ "...", "..." ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "hdfsResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "ozoneResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "hiveResult" : { "phase" : "...", "tableCount" : 12345, "tables" : [ {}, {} ], "impalaUDFCount" : 12345, "hiveUDFCount" : 12345, "impalaUDFs" : [ {}, {} ], "hiveUDFs" : [ {}, {} ], "errorCount" : 12345, "errors" : [ {}, {} ], "dataReplicationResult" : {}, "dryRun" : true, "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "directoryForMetadata" : "...", "statsAvailable" : true, "dbProcessed" : 12345, "tableProcessed" : 12345, "partitionProcessed" : 12345, "functionProcessed" : 12345, "indexProcessed" : 12345, "statsProcessed" : 12345, "dbExpected" : 12345, "tableExpected" : 12345, "partitionExpected" : 12345, "functionExpected" : 12345, "indexExpected" : 12345, "statsExpected" : 12345 }, "hiveOnTezResult" : { "type" : "...", "status" : "...", "error" : "...", "tablesCurrent" : 12345, "tablesTotal" : 12345, "functionsCurrent" : 12345, "functionsTotal" : 12345, "eventsCurrent" : 12345, "eventsTotal" : 12345, "policiesCurrent" : 12345, "policiesTotal" : 12345, "entitiesCurrent" : 12345, "entitiesTotal" : 12345, "origin" : "SOURCE" }, "hbaseInfo" : { "replicationOperations" : [ "...", "..." ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ], "active" : true, "hiveCloudArguments" : { "sourceAccount" : "...", "destinationAccount" : "...", "cloudRootPath" : "...", "replicationOption" : "KEEP_DATA_IN_CLOUD", "sourceService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "tableFilters" : [ { "database" : "...", "tableName" : "..." }, { "database" : "...", "tableName" : "..." } ], "exportDir" : "...", "force" : true, "replicateData" : true, "hdfsArguments" : { "sourceService" : {}, "sourcePath" : "...", "destinationPath" : "...", "mapreduceServiceName" : "...", "schedulerPoolName" : "...", "userName" : "...", "sourceUser" : "...", "numMaps" : 12345, "dryRun" : true, "bandwidthPerMap" : 12345, "abortOnError" : true, "removeMissingFiles" : true, "preserveReplicationCount" : true, "preserveBlockSize" : true, "preservePermissions" : true, "logPath" : "...", "skipChecksumChecks" : true, "skipListingChecksumChecks" : true, "skipTrash" : true, "replicationStrategy" : "DYNAMIC", "preserveXAttrs" : true, "exclusionFilters" : [ "...", "..." ], "raiseSnapshotDiffFailures" : true, "deleteLatestSourceSnapshotOnJobFailure" : true, "destinationCloudAccount" : "..." }, "replicateImpalaMetadata" : true, "runInvalidateMetadata" : true, "dryRun" : true, "numThreads" : 12345, "sentryMigration" : true, "skipUrlPermissions" : true }, "hbaseArguments" : { "sourceHBaseService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "peerState" : "ENABLED", "hbaseClusterKey" : "...", "endPointClassName" : "...", "tables" : [ { "tableName" : "...", "initialSnapshot" : true, "snapshotSucceeded" : true }, { "tableName" : "...", "initialSnapshot" : true, "snapshotSucceeded" : true } ], "replicationProperties" : { "property1" : "...", "property2" : "..." }, "sourceAccount" : "...", "sourceSchedulerPool" : "...", "numMappers" : 12345, "snapshotScratchLocation" : "...", "validateReplicationSetup" : true }, "hive3Arguments" : { "sourceHiveService" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "status" : "DISABLED", "rangerReplication" : true, "atlasReplication" : true, "externalTableReplication" : true, "externalTableBaseDir" : "...", "distcpOnTarget" : true, "numMaps" : 12345, "bandwidthPerMap" : 12345, "policyOptions" : { "property1" : "...", "property2" : "..." }, "sourceDbName" : "...", "targetDbName" : "...", "policyName" : "...", "scheduleClause" : "...", "runAs" : "...", "hiveOp" : "...", "hiveUpdateOp" : "...", "excludeSource" : true, "excludeTarget" : true, "failoverStatus" : "...", "cloudArgs" : { "sourceAccount" : "..." } }, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "WEEK", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true } }, "description" : "The deleted replication schedule." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/history" : { "get" : { "tags" : [ "ReplicationsResource" ], "summary" : "Returns a list of commands triggered by a schedule.", "description" : "Returns a list of commands triggered by a schedule.", "operationId" : "readHistory", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "scheduleId", "in" : "path", "required" : true, "type" : "integer", "description" : "Id of an existing replication schedule." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "limit", "in" : "query", "default" : "20", "type" : "integer", "description" : "Maximum number of commands to retrieve." }, { "name" : "offset", "in" : "query", "default" : "0", "type" : "integer", "description" : "Index of first command to retrieve." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view to materialize." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiReplicationCommandList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "hdfsResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "ozoneResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "hiveResult" : { "phase" : "...", "tableCount" : 12345, "tables" : [ {}, {} ], "impalaUDFCount" : 12345, "hiveUDFCount" : 12345, "impalaUDFs" : [ {}, {} ], "hiveUDFs" : [ {}, {} ], "errorCount" : 12345, "errors" : [ {}, {} ], "dataReplicationResult" : {}, "dryRun" : true, "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "directoryForMetadata" : "...", "statsAvailable" : true, "dbProcessed" : 12345, "tableProcessed" : 12345, "partitionProcessed" : 12345, "functionProcessed" : 12345, "indexProcessed" : 12345, "statsProcessed" : 12345, "dbExpected" : 12345, "tableExpected" : 12345, "partitionExpected" : 12345, "functionExpected" : 12345, "indexExpected" : 12345, "statsExpected" : 12345 }, "hiveOnTezResult" : { "type" : "...", "status" : "...", "error" : "...", "tablesCurrent" : 12345, "tablesTotal" : 12345, "functionsCurrent" : 12345, "functionsTotal" : 12345, "eventsCurrent" : 12345, "eventsTotal" : 12345, "policiesCurrent" : 12345, "policiesTotal" : 12345, "entitiesCurrent" : 12345, "entitiesTotal" : 12345, "origin" : "TARGET" }, "hbaseInfo" : { "replicationOperations" : [ "...", "..." ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "hdfsResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "ozoneResult" : { "progress" : 12345, "throughput" : 12345.0, "remainingTime" : 12345, "estimatedCompletionTime" : "...", "counters" : [ {}, {} ], "numFilesDryRun" : 12345, "numBytesDryRun" : 12345, "numFilesExpected" : 12345, "numBytesExpected" : 12345, "numFilesCopied" : 12345, "numBytesCopied" : 12345, "numFilesSkipped" : 12345, "numBytesSkipped" : 12345, "numFilesDeleted" : 12345, "numFilesCopyFailed" : 12345, "numBytesCopyFailed" : 12345, "setupError" : "...", "jobId" : "...", "jobDetailsUri" : "...", "dryRun" : true, "snapshottedDirs" : [ "...", "..." ], "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "failedFiles" : [ "...", "..." ] }, "hiveResult" : { "phase" : "...", "tableCount" : 12345, "tables" : [ {}, {} ], "impalaUDFCount" : 12345, "hiveUDFCount" : 12345, "impalaUDFs" : [ {}, {} ], "hiveUDFs" : [ {}, {} ], "errorCount" : 12345, "errors" : [ {}, {} ], "dataReplicationResult" : {}, "dryRun" : true, "runAsUser" : "...", "runOnSourceAsUser" : "...", "logPath" : "...", "directoryForMetadata" : "...", "statsAvailable" : true, "dbProcessed" : 12345, "tableProcessed" : 12345, "partitionProcessed" : 12345, "functionProcessed" : 12345, "indexProcessed" : 12345, "statsProcessed" : 12345, "dbExpected" : 12345, "tableExpected" : 12345, "partitionExpected" : 12345, "functionExpected" : 12345, "indexExpected" : 12345, "statsExpected" : 12345 }, "hiveOnTezResult" : { "type" : "...", "status" : "...", "error" : "...", "tablesCurrent" : 12345, "tablesTotal" : 12345, "functionsCurrent" : 12345, "functionsTotal" : 12345, "eventsCurrent" : 12345, "eventsTotal" : 12345, "policiesCurrent" : 12345, "policiesTotal" : 12345, "entitiesCurrent" : 12345, "entitiesTotal" : 12345, "origin" : "SOURCE" }, "hbaseInfo" : { "replicationOperations" : [ "...", "..." ] }, "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "List of commands for the schedule." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/run" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Run the schedule immediately.", "description" : "Run the schedule immediately.\n
\nThe replication command will be triggered with the configured arguments,\nand will be recorded in the schedule's history.\n
\nAvailable since API v3. Only available with Cloudera Manager Enterprise\nEdition.", "operationId" : "runSchedule", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "scheduleId", "in" : "path", "required" : true, "type" : "integer", "description" : "Id of an existing replication schedule." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "dryRun", "in" : "query", "default" : "false", "type" : "boolean", "description" : "Whether to execute a dry run." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/replications/{scheduleId}/runHBaseReplicationRetryFailedSnapshots" : { "post" : { "tags" : [ "ReplicationsResource" ], "summary" : "Executes a command to run a HBase replication retry on failed snapshots\nfor the given schedule ID.", "description" : "Executes a command to run a HBase replication retry on failed snapshots\nfor the given schedule ID", "operationId" : "runHBaseReplicationRetryFailedSnapshots", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "scheduleId", "in" : "path", "required" : true, "type" : "integer", "description" : "The HBase schedule ID to retry on" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "command to run hbase replication retry on failed snapshots" } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsBootstrapStandBy" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Bootstrap HDFS stand-by NameNodes.", "description" : "Bootstrap HDFS stand-by NameNodes.\n
\nSubmit a request to synchronize HDFS NameNodes with their assigned HA\npartners. The command requires that the target NameNodes are part of\nexisting HA pairs, which can be accomplished by setting the nameservice\nconfiguration parameter in the NameNode's configuration.\n
\nThe HA partner must already be formatted and running for this command\nto run.", "operationId" : "hdfsBootstrapStandByCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The names of the stand-by NameNodes to bootstrap." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsEnterSafemode" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Enter safemode for namenodes.", "description" : "Enter safemode for namenodes\n
\nAvailable since API v4.", "operationId" : "hdfsEnterSafemode", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "NameNodes for which to enter safemode." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "List of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsFinalizeMetadataUpgrade" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Finalize HDFS NameNode metadata upgrade.", "description" : "Finalize HDFS NameNode metadata upgrade.\n\nAvailable since API v3.", "operationId" : "hdfsFinalizeMetadataUpgrade", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "NameNodes for which to finalize the upgrade." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "List of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsFormat" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Format HDFS NameNodes.", "description" : "Format HDFS NameNodes.\n\nSubmit a format request to a list of NameNodes on a service. Note that\ntrying to format a previously formatted NameNode will fail.\n
\nNote about high availability: when two NameNodes are working in an HA\npair, only one of them should be formatted.\n
\nBulk command operations are not atomic, and may contain partial failures.\nThe returned list will contain references to all successful commands, and\na list of error messages identifying the roles on which the command\nfailed.", "operationId" : "formatCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The names of the NameNodes to format." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsInitializeAutoFailover" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Initialize HDFS HA failover controller metadata.", "description" : "Initialize HDFS HA failover controller metadata.\n
\nThe controllers being initialized must already exist and be properly\nconfigured. The command will make sure the needed data is initialized\nfor the controller to work.\n
\nOnly one controller per nameservice needs to be initialized.", "operationId" : "hdfsInitializeAutoFailoverCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The names of the controllers to initialize." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsInitializeSharedDir" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Initialize HDFS NameNodes' shared edit directory.", "description" : "Initialize HDFS NameNodes' shared edit directory.\n
\nShared edit directories are used when two HDFS NameNodes are operating as\na high-availability pair. This command initializes the shared directory to\ninclude the necessary metadata.\n
\nThe provided role names should reflect one of the NameNodes in the\nrespective HA pair; the role must be stopped and its data directory must\nalready have been formatted. The shared edits directory must be empty for\nthis command to succeed.", "operationId" : "hdfsInitializeSharedDirCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The names of the NameNodes." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsLeaveSafemode" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Leave safemode for namenodes.", "description" : "Leave safemode for namenodes\n
\nAvailable since API v4.", "operationId" : "hdfsLeaveSafemode", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "NameNodes for which to leave safemode." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "List of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/hdfsSaveNamespace" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Save namespace for namenodes.", "description" : "Save namespace for namenodes\n\nAvailable since API v4.", "operationId" : "hdfsSaveNamespace", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "NameNodes for which to save namespace." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "List of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/hueSyncDb" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Create / update the Hue database schema.", "description" : "Create / update the Hue database schema.\n\nThis command is to be run whenever a new database has been specified or,\nas necessary, after an upgrade.\n
\nThis request should be sent to Hue servers only.", "operationId" : "syncHueDbCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The names of the Hue server roles." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/jmapDump" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Run the jmapDump diagnostic command.", "description" : "Run the jmapDump diagnostic command. The command runs the jmap utility to\ncapture a dump of the role's java heap.\n
\nAvailable since API v8.", "operationId" : "jmapDump", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "the names of the roles to jmap." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "List of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/jmapHisto" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Run the jmapHisto diagnostic command.", "description" : "Run the jmapHisto diagnostic command. The command runs the jmap utility to\ncapture a histogram of the objects on the role's java heap.\n\nAvailable since API v8.", "operationId" : "jmapHisto", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "the names of the roles to jmap." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "List of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/jstack" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Run the jstack diagnostic command.", "description" : "Run the jstack diagnostic command. The command runs the jstack utility to\ncapture a role's java thread stacks.\n\nAvailable since API v8.", "operationId" : "jstack", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "the names of the roles to jstack." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "List of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/lsof" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Run the lsof diagnostic command.", "description" : "Run the lsof diagnostic command. This command runs the lsof utility to\nlist a role's open files.\n\nAvailable since API v8.", "operationId" : "lsof", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "the names of the roles to lsof." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "List of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/refresh" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Refresh a role's data.", "description" : "Refresh a role's data.\n\nFor MapReduce services, this command should be executed on JobTracker\nroles. It refreshes the role's queue and node information.\n
\nFor HDFS services, this command should be executed on NameNode or\nDataNode roles. For NameNodes, it refreshes the role's node list.\nFor DataNodes, it refreshes the role's data directory list and other\nconfiguration.\n
\nFor YARN services, this command should be executed on ResourceManager\nroles. It refreshes the role's queue and node information.\n
\nAvailable since API v1. DataNode data directories refresh available\nsince API v10.", "operationId" : "refreshCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The names of the roles." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/restart" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Restart a set of role instances.", "description" : "Restart a set of role instances\n
\nBulk command operations are not atomic, and may contain partial failures.\nThe returned list will contain references to all successful commands, and\na list of error messages identifying the roles on which the command\nfailed.", "operationId" : "restartCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The name of the roles to restart." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A reference to the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/start" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Start a set of role instances.", "description" : "Start a set of role instances.\n
\nBulk command operations are not atomic, and may contain partial failures.\nThe returned list will contain references to all successful commands, and\na list of error messages identifying the roles on which the command\nfailed.", "operationId" : "startCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The names of the roles to start." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A reference to the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/stop" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Stop a set of role instances.", "description" : "Stop a set of role instances.\n
\nBulk command operations are not atomic, and may contain partial failures.\nThe returned list will contain references to all successful commands, and\na list of error messages identifying the roles on which the command\nfailed.", "operationId" : "stopCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The role type." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A reference to the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/zooKeeperCleanup" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Cleanup a list of ZooKeeper server roles.", "description" : "Cleanup a list of ZooKeeper server roles.\n
\nThis command removes snapshots and transaction log files kept by\nZooKeeper for backup purposes. Refer to the ZooKeeper documentation\nfor more details.", "operationId" : "zooKeeperCleanupCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The names of the roles." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/zooKeeperInit" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Initialize a list of ZooKeeper server roles.", "description" : "Initialize a list of ZooKeeper server roles.\n
\nThis applies to ZooKeeper services from CDH4. Before ZooKeeper server\nroles can be used, they need to be initialized.", "operationId" : "zooKeeperInitCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The names of the roles." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "A list of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleCommands/{commandName}" : { "post" : { "tags" : [ "RoleCommandsResource" ], "summary" : "Execute a role command by name.", "description" : "Execute a role command by name.\n
\nAvailable since API v6.", "operationId" : "roleCommandByName", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "commandName", "in" : "path", "required" : true, "type" : "string", "description" : "the name of command to execute." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "the roles to run this command on." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiBulkCommandList" }, "headers" : {}, "examples" : { "application/json" : { "errors" : [ "...", "..." ], "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true } ] } }, "description" : "List of submitted commands." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleConfigGroups" : { "get" : { "tags" : [ "RoleConfigGroupsResource" ], "summary" : "Returns the information for all role config groups for\na given cluster and service.", "description" : "Returns the information for all role config groups for\na given cluster and service.\n\nAvailable since API v3.", "operationId" : "readRoleConfigGroups", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleConfigGroupList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } }, { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } ] } }, "description" : "The list of role config groups for the given service." } } }, "post" : { "tags" : [ "RoleConfigGroupsResource" ], "summary" : "Creates new role config groups.", "description" : "Creates new role config groups.\nIt is not allowed to create base groups (base must be set to false.)\n
\nAvailable since API v3.", "operationId" : "createRoleConfigGroups", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleConfigGroupList" }, "description" : "The list of groups to be created." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleConfigGroupList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } }, { "name" : "...", "roleType" : "...", "base" : true, "config" : { "items" : [ {}, {} ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } ] } }, "description" : "The list of new role config groups." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleConfigGroups/roles" : { "put" : { "tags" : [ "RoleConfigGroupsResource" ], "summary" : "Moves roles to the base role config group.", "description" : "Moves roles to the base role config group.\n\nThe roles can be moved from any role config group belonging to the same\nservice. The role type of the roles may vary. Each role will be moved to\nits corresponding base group depending on its role type.\n
\nAvailable since API v3.", "operationId" : "moveRolesToBaseGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The names of the roles to move." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "NA", "commissionState" : "DECOMMISSIONING", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "CONCERNING", "explanation" : "...", "suppressed" : true } ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "CONTROL_PLANE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "DOWN", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "NA", "commissionState" : "OFFLINING", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true } ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "CLUSTER" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "UNKNOWN", "entityStatus" : "HISTORY_NOT_AVAILABLE", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] } }, "description" : "The roles which have been moved successfully." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}" : { "delete" : { "tags" : [ "RoleConfigGroupsResource" ], "summary" : "Deletes a role config group.", "description" : "Deletes a role config group.\n
\nAvailable since API v3.", "operationId" : "deleteRoleConfigGroup", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the group to delete." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleConfigGroup" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "roleType" : "...", "base" : true, "config" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } }, "description" : "The deleted role config group." } } }, "get" : { "tags" : [ "RoleConfigGroupsResource" ], "summary" : "Returns the information for a role config group.", "description" : "Returns the information for a role config group.\n
\nAvailable since API v3.", "operationId" : "readRoleConfigGroup", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the requested group." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleConfigGroup" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "roleType" : "...", "base" : true, "config" : { "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } }, "description" : "The requested role config group." } } }, "put" : { "tags" : [ "RoleConfigGroupsResource" ], "summary" : "Updates an existing role config group.", "description" : "Updates an existing role config group\n
\nAvailable since API v3.", "operationId" : "updateRoleConfigGroup", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the group to update." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "message", "in" : "query", "type" : "string", "description" : "The optional message describing the changes." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleConfigGroup" }, "description" : "The updated role config group." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleConfigGroup" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "roleType" : "...", "base" : true, "config" : { "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, "displayName" : "...", "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." } } }, "description" : "Role updated role config group." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}/config" : { "get" : { "tags" : [ "RoleConfigGroupsResource" ], "summary" : "Returns the current revision of the config\nfor the specified role config group.", "description" : "Returns the current revision of the config\nfor the specified role config group.\n
\nAvailable since API v3.", "operationId" : "readConfig", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the role config group." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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 } ] } }, "description" : "The current configuration of the role config group." } } }, "put" : { "tags" : [ "RoleConfigGroupsResource" ], "summary" : "Updates the config for the given role config group.", "description" : "Updates the config for the given role config group.", "operationId" : "updateConfig", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the role config group." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "message", "in" : "query", "type" : "string", "description" : "Optional message describing the changes." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "description" : "The new config information for the group." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "The updated config of the role config group." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleConfigGroups/{roleConfigGroupName}/roles" : { "get" : { "tags" : [ "RoleConfigGroupsResource" ], "summary" : "Returns all roles in the given role config group.", "description" : "Returns all roles in the given role config group.\n
\nAvailable since API v3.", "operationId" : "readRoles", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the role config group." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "STARTING", "commissionState" : "DECOMMISSIONING", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "ROLE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "STOPPING", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "UNKNOWN", "commissionState" : "OFFLINING", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "BAD", "explanation" : "...", "suppressed" : true } ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "ROLE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "HISTORY_NOT_AVAILABLE", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] } }, "description" : "The roles in the role config group." } } }, "put" : { "tags" : [ "RoleConfigGroupsResource" ], "summary" : "Moves roles to the specified role config group.", "description" : "Moves roles to the specified role config group.\n\nThe roles can be moved from any role config group belonging\nto the same service. The role type of the destination group\nmust match the role type of the roles.\n
\nAvailable since API v3.", "operationId" : "moveRoles", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleConfigGroupName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the group the roles will be moved to." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "The names of the roles to move." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "NA", "commissionState" : "DECOMMISSIONING", "healthSummary" : "BAD", "configStalenessStatus" : "STALE_REFRESHABLE", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "ROLE" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "STANDALONE", "entityStatus" : "HISTORY_NOT_AVAILABLE", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] }, { "name" : "...", "type" : "...", "hostRef" : { "hostId" : "...", "hostname" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleState" : "HISTORY_NOT_AVAILABLE", "commissionState" : "COMMISSIONED", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "CLUSTER" ], "config" : { "items" : [ {}, {} ] }, "roleConfigGroupRef" : { "roleConfigGroupName" : "..." }, "zooKeeperServerMode" : "STANDALONE", "entityStatus" : "DOWN", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ] } ] } }, "description" : "The roles which have been moved successfully." } } } }, "/clusters/{clusterName}/services/{serviceName}/roles" : { "get" : { "tags" : [ "RolesResource" ], "summary" : "Lists all roles of a given service.", "description" : "Lists all roles of a given service.", "operationId" : "readRoles", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "filter", "in" : "query", "default" : "", "type" : "string", "description" : "Optional query to filter the roles by.\n
\nThe query specifies the intersection of a list of constraints,\njoined together with semicolons (without spaces). For example:\nhostname==host1.abc.com;type==DATANODE\n
\n\nCurrently supports filtering by:\n| Service Type | \nAvailable Role Types | \n
|---|---|
| HDFS (CDH3) | \nNAMENODE, DATANODE, SECONDARYNAMENODE, BALANCER, GATEWAY | \n
| HDFS (CDH4) | \nNAMENODE, DATANODE, SECONDARYNAMENODE, BALANCER, HTTPFS,\nFAILOVERCONTROLLER, GATEWAY, JOURNALNODE | \n
| HDFS (CDH5) | \nNAMENODE, DATANODE, SECONDARYNAMENODE, BALANCER, HTTPFS,\nFAILOVERCONTROLLER, GATEWAY, JOURNALNODE, NFSGATEWAY | \nMAPREDUCE | \nJOBTRACKER, TASKTRACKER, GATEWAY, FAILOVERCONTROLLER, | \n\nHBASE | \nMASTER, REGIONSERVER, GATEWAY, HBASETHRIFTSERVER, HBASERESTSERVER | \n\n
| YARN | \nRESOURCEMANAGER, NODEMANAGER, JOBHISTORY, GATEWAY | \n
| OOZIE | \nOOZIE_SERVER | \n
| ZOOKEEPER | \nSERVER | \n
| HUE (CDH3) | \nHUE_SERVER, BEESWAX_SERVER, KT_RENEWER, JOBSUBD | \n
| HUE (CDH4) | \nHUE_SERVER, BEESWAX_SERVER, KT_RENEWER | \n
| HUE (CDH5) | \nHUE_SERVER, KT_RENEWER | \n
| HUE (CDH5 5.5+) | \nHUE_SERVER, KT_RENEWER, HUE_LOAD_BALANCER | \n
| FLUME | \nAGENT | \n
| IMPALA (CDH4) | \nIMPALAD, STATESTORE, CATALOGSERVER | \n
| IMPALA (CDH5) | \nIMPALAD, STATESTORE, CATALOGSERVER | \n
| HIVE | \nHIVESERVER2, HIVEMETASTORE, WEBHCAT, GATEWAY | \n
| SOLR | \nSOLR_SERVER, GATEWAY | \n
| SQOOP | \nSQOOP_SERVER | \n
| SQOOP_CLIENT | \nGATEWAY | \n
| SENTRY | \nSENTRY_SERVER | \n
| ACCUMULO16 | \nGARBAGE_COLLECTOR, GATEWAY, ACCUMULO16_MASTER, MONITOR,\nACCUMULO16_TSERVER, TRACER | \n
| KMS | \nKMS | \n
| KS_INDEXER | \nHBASE_INDEXER | \n
| SPARK_ON_YARN | \nGATEWAY, SPARK_YARN_HISTORY_SERVER | \n
\nIf a value is set in the given configuration, it will be added\nto the role's configuration, replacing any existing entries.\nIf a value is unset (its value is null), the existing\nconfiguration for the attribute will be erased, if any.\n
\nAttributes that are not listed in the input will maintain their\ncurrent values in the configuration.", "operationId" : "updateRoleConfig", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to modify." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "message", "in" : "query", "type" : "string", "description" : "Optional message describing the changes." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "description" : "Configuration changes." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiConfigList" }, "headers" : {}, "examples" : { "application/json" : { "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } }, "description" : "The new service configuration." } } } }, "/clusters/{clusterName}/services/{serviceName}/roles/{roleName}/metrics" : { "get" : { "deprecated" : true, "tags" : [ "RolesResource" ], "summary" : "Fetch metric readings for a particular role.", "description" : "Fetch metric readings for a particular role.\n
\nBy default, this call will look up all metrics available for the role. If\nonly specific metrics are desired, use the metrics parameter.\n
\nBy default, the returned results correspond to a 5 minute window based on\nthe provided end time (which defaults to the current server time). The\nfrom and to parameters can be used to control the window\nbeing queried. A maximum window of 3 hours is enforced.\n
\nWhen requesting a \"full\" view, aside from the extended properties of the\nreturned metric data, the collection will also contain information about\nall metrics available for the role, even if no readings are available\nin the requested window.", "operationId" : "getMetrics", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the role." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "from", "in" : "query", "type" : "string", "description" : "Start of the period to query." }, { "name" : "metrics", "in" : "query", "type" : "array", "items" : { "type" : "string" }, "collectionFormat" : "multi", "description" : "Filter for which metrics to query." }, { "name" : "to", "in" : "query", "default" : "now", "type" : "string", "description" : "End of the period to query." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiMetricList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "context" : "...", "unit" : "...", "data" : [ { "timestamp" : "...", "value" : 12345.0 }, { "timestamp" : "...", "value" : 12345.0 } ], "displayName" : "...", "description" : "..." }, { "name" : "...", "context" : "...", "unit" : "...", "data" : [ { "timestamp" : "...", "value" : 12345.0 }, { "timestamp" : "...", "value" : 12345.0 } ], "displayName" : "...", "description" : "..." } ] } }, "description" : "List of readings from the monitors." } } } }, "/clusters/{clusterName}/services/{serviceName}/roles/{roleName}/tags" : { "delete" : { "tags" : [ "RolesResource" ], "summary" : "Remove the tags associated with the role.", "description" : "Remove the tags associated with the role. Tag names beginning with the\nprefix _cldr_ (case insensitive) are reserved for internal use by Cloudera.", "operationId" : "deleteTags", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the role to remove tags from" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "description" : "A list of tags to remove from the role" } ], "responses" : { "204" : { "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "headers" : {}, "examples" : { "application/json" : [ { "name" : "...", "value" : "..." } ] }, "description" : "A list of tags that were removed from the role" } } }, "get" : { "tags" : [ "RolesResource" ], "summary" : "Returns the tags associated with this role.", "description" : "Returns the tags associated with this role. Tag names beginning with\nthe prefix _cldr_ (case insensitive) are reserved for internal use by Cloudera.", "operationId" : "readTags", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the role" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "limit", "in" : "query", "default" : "10", "type" : "integer", "description" : "Number of tags" }, { "name" : "offset", "in" : "query", "default" : "0", "type" : "integer", "description" : "Index of the first tag to retrieve" } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "headers" : {}, "examples" : { "application/json" : [ { "name" : "...", "value" : "..." } ] }, "description" : "A list of tags associated with the role" } } }, "put" : { "tags" : [ "RolesResource" ], "summary" : "Attach tags to the role.", "description" : "Attach tags to the role. Tag names beginning with the prefix _cldr_\n(case insensitive) are reserved for internal use by Cloudera.", "operationId" : "addTags", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the role" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "description" : "List of tags to add to the role" } ], "responses" : { "204" : { "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "headers" : {}, "examples" : { "application/json" : [ { "name" : "...", "value" : "..." } ] }, "description" : "A list of tags that were added to the role" } } } }, "/clusters/{clusterName}/services/{serviceName}/roles/{roleName}/commands/enterMaintenanceMode" : { "post" : { "tags" : [ "RolesResource" ], "summary" : "Put the role into maintenance mode.", "description" : "Put the role into maintenance mode. This is a synchronous command. The\nresult is known immediately upon return.\n\n
\nAvailable since API v2.\n
", "operationId" : "enterMaintenanceMode", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role name." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/clusters/{clusterName}/services/{serviceName}/roles/{roleName}/commands/exitMaintenanceMode" : { "post" : { "tags" : [ "RolesResource" ], "summary" : "Take the role out of maintenance mode.", "description" : "Take the role out of maintenance mode. This is a synchronous command. The\nresult is known immediately upon return.\n\n\nAvailable since API v2.\n
", "operationId" : "exitMaintenanceMode", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role name." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/clusters/{clusterName}/services/{serviceName}/roles/{roleName}/commands/impalaDiagnostics" : { "post" : { "tags" : [ "RolesResource" ], "summary" : "Collects diagnostics data for an Impala role.", "description" : "Collects diagnostics data for an Impala role.\n\n\nAvailable since API v31.\n
", "operationId" : "impalaDiagnostics", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role name." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiImpalaRoleDiagnosticsArgs" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/clusters/{clusterName}/services/{serviceName}/roles/{roleName}/logs/full" : { "get" : { "tags" : [ "RolesResource" ], "summary" : "Retrieves the log file for the role's main process.", "description" : "Retrieves the log file for the role's main process.\n\nIf the role is not started, this will be the log file associated with\nthe last time the role was run.\n
\nLog files are returned as plain text (type \"text/plain\").", "operationId" : "getFullLog", "produces" : [ "text/plain" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to fetch logs from." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "string" }, "headers" : {}, "examples" : {}, "description" : "Contents of the role's log file." } } } }, "/clusters/{clusterName}/services/{serviceName}/roles/{roleName}/logs/stacks" : { "get" : { "tags" : [ "RolesResource" ], "summary" : "Retrieves the stacks log file, if any, for the role's main process.", "description" : "Retrieves the stacks log file, if any, for the role's main process. Note\nthat not all roles support periodic stacks collection.\n\nThe log files are returned as plain text (type \"text/plain\").", "operationId" : "getStacksLog", "produces" : [ "text/plain" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to fetch stacks logs from." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "string" }, "headers" : {}, "examples" : {}, "description" : "Contents of the role's log file." } } } }, "/clusters/{clusterName}/services/{serviceName}/roles/{roleName}/logs/stacksBundle" : { "get" : { "tags" : [ "RolesResource" ], "summary" : "Download a zip-compressed archive of role stacks logs.", "description" : "Download a zip-compressed archive of role stacks logs. Note that not all\nroles support periodic stacks collection.", "operationId" : "getStacksLogsBundle", "produces" : [ "application/octet-stream" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to fetch the stacks logs bundle from." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "file" }, "headers" : {}, "examples" : {}, "description" : "The archive data." } } } }, "/clusters/{clusterName}/services/{serviceName}/roles/{roleName}/logs/stderr" : { "get" : { "tags" : [ "RolesResource" ], "summary" : "Retrieves the role's standard error output.", "description" : "Retrieves the role's standard error output.\n
\nIf the role is not started, this will be the output associated with\nthe last time the role was run.\n
\nLog files are returned as plain text (type \"text/plain\").", "operationId" : "getStandardError", "produces" : [ "text/plain" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to fetch stderr from." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "string" }, "headers" : {}, "examples" : {}, "description" : "Contents of the role's standard error output." } } } }, "/clusters/{clusterName}/services/{serviceName}/roles/{roleName}/logs/stdout" : { "get" : { "tags" : [ "RolesResource" ], "summary" : "Retrieves the role's standard output.", "description" : "Retrieves the role's standard output.\n
\nIf the role is not started, this will be the output associated with\nthe last time the role was run.\n
\nLog files are returned as plain text (type \"text/plain\").", "operationId" : "getStandardOutput", "produces" : [ "text/plain" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "roleName", "in" : "path", "required" : true, "type" : "string", "description" : "The role to fetch stdout from." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "string" }, "headers" : {}, "examples" : {}, "description" : "Contents of the role's standard output." } } } }, "/clusters/{clusterName}/services" : { "get" : { "tags" : [ "ServicesResource" ], "summary" : "Lists all services registered in the cluster.", "description" : "Lists all services registered in the cluster.", "operationId" : "readServices", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiServiceList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "HISTORY_NOT_AVAILABLE", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "DISABLED", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "HISTORY_NOT_AVAILABLE", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "SERVICE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPING", "commissionState" : "DECOMMISSIONING", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "UNKNOWN", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "SERVICE", "CLUSTER" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "STOPPING", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPED", "commissionState" : "UNKNOWN", "healthSummary" : "GOOD", "configStalenessStatus" : "STALE", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "CONTROL_PLANE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_FOLLOWER", "entityStatus" : "GOOD_HEALTH", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "MINUTE", "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" : "GOOD_HEALTH", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." }, { "name" : "...", "type" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceState" : "STARTING", "healthSummary" : "DISABLED", "configStalenessStatus" : "STALE", "clientConfigStalenessStatus" : "STALE", "healthChecks" : [ { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true }, { "name" : "...", "summary" : "GOOD", "explanation" : "...", "suppressed" : true } ], "serviceUrl" : "...", "roleInstancesUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CONTROL_PLANE", "ROLE" ], "config" : { "roleTypeConfigs" : [ {}, {} ], "items" : [ {}, {} ] }, "roles" : [ { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "UNKNOWN", "commissionState" : "DECOMMISSIONING", "healthSummary" : "BAD", "configStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "haStatus" : "STANDBY", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "CLUSTER", "ROLE" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "REPLICATED_LEADER", "entityStatus" : "BAD_HEALTH", "tags" : [ {}, {} ] }, { "name" : "...", "type" : "...", "hostRef" : {}, "serviceRef" : {}, "roleState" : "STOPPING", "commissionState" : "DECOMMISSIONING", "healthSummary" : "NOT_AVAILABLE", "configStalenessStatus" : "FRESH", "healthChecks" : [ {}, {} ], "haStatus" : "ACTIVE", "roleUrl" : "...", "maintenanceMode" : true, "maintenanceOwners" : [ "HOST", "CLUSTER" ], "config" : {}, "roleConfigGroupRef" : {}, "zooKeeperServerMode" : "STANDALONE", "entityStatus" : "GOOD_HEALTH", "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" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "nextRun" : "...", "paused" : true, "alertOnStart" : true, "alertOnSuccess" : true, "alertOnFail" : true, "alertOnAbort" : true }, { "hdfsArguments" : {}, "hiveArguments" : {}, "hdfsCloudArguments" : {}, "ozoneReplicationArguments" : {}, "history" : [ {}, {} ], "active" : true, "hiveCloudArguments" : {}, "hbaseArguments" : {}, "hive3Arguments" : {}, "id" : 12345, "displayName" : "...", "description" : "...", "startTime" : "...", "endTime" : "...", "interval" : 12345, "intervalUnit" : "HOUR", "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" : "NONE", "tags" : [ { "name" : "...", "value" : "..." }, { "name" : "...", "value" : "..." } ], "serviceVersion" : "..." } ] } }, "description" : "List of services." } } }, "post" : { "tags" : [ "ServicesResource" ], "summary" : "Creates a list of services.", "description" : "Creates a list of services.\n
\nThere are typically two service creation strategies:\n
| Cluster Version | \nAvailable Service Types | \n
|---|---|
| CDH4 | \nHDFS, MAPREDUCE, HBASE, OOZIE, ZOOKEEPER, HUE, YARN, IMPALA, FLUME, HIVE, SOLR, SQOOP, KS_INDEXER | \n
| CDH5 | \nHDFS, MAPREDUCE, HBASE, OOZIE, ZOOKEEPER, HUE, YARN, IMPALA,\nFLUME, HIVE, SOLR, SQOOP, KS_INDEXER, SQOOP_CLIENT, SENTRY,\nACCUMULO16, KMS, SPARK_ON_YARN, KAFKA\n | \n
\nAvailable since API v6.\n
", "operationId" : "listServiceCommands", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommandMetadataList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "argSchema" : "..." }, { "name" : "...", "argSchema" : "..." } ] } }, "description" : "a list of command metadata objects." } } } }, "/clusters/{clusterName}/services/{serviceName}/config" : { "get" : { "tags" : [ "ServicesResource" ], "summary" : "Retrieves the configuration of a specific service.", "description" : "Retrieves the configuration of a specific service.\n\nThe \"summary\" view contains only the configured parameters, and\nconfiguration for role types that contain configured parameters.\n
\nThe \"full\" view contains all available configuration parameters for\nthe service and its role types.\nThis mode performs validation on the configuration, which could take\na few seconds on a large cluster (around 500 nodes or more).", "operationId" : "readServiceConfig", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service to query." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiServiceConfig" }, "headers" : {}, "examples" : { "application/json" : { "roleTypeConfigs" : [ { "roleType" : "...", "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, { "roleType" : "...", "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } ], "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 } ] } }, "description" : "List of service and role types configuration parameters." } } }, "put" : { "tags" : [ "ServicesResource" ], "summary" : "Updates the service configuration with the given values.", "description" : "Updates the service configuration with the given values.\n
\nIf a value is set in the given configuration, it will be added\nto the service's configuration, replacing any existing entries.\nIf a value is unset (its value is null), the existing\nconfiguration for the attribute will be erased, if any.\n
\nAttributes that are not listed in the input will maintain their\ncurrent values in the configuration.", "operationId" : "updateServiceConfig", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service to modify." }, { "name" : "message", "in" : "query", "type" : "string", "description" : "Optional message describing the changes." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiServiceConfig" }, "description" : "Configuration changes." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiServiceConfig" }, "headers" : {}, "examples" : { "application/json" : { "roleTypeConfigs" : [ { "roleType" : "...", "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" : "WARNING", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] }, { "roleType" : "...", "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" : "ERROR", "validationMessage" : "...", "validationWarningsSuppressed" : true } ] } ], "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 } ] } }, "description" : "The new service configuration." } } } }, "/clusters/{clusterName}/services/{serviceName}/impalaUtilization" : { "get" : { "tags" : [ "ServicesResource" ], "summary" : "Provides the resource utilization of the Impala service as well as the\nresource utilization per tenant.", "description" : "Provides the resource utilization of the Impala service as well as the\nresource utilization per tenant. Only available with Cloudera Manager Enterprise Edition.", "operationId" : "getImpalaUtilization", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "service name" }, { "name" : "daysOfWeek", "in" : "query", "type" : "array", "items" : { "type" : "string" }, "collectionFormat" : "multi", "description" : "The days of the week for which the user wants to report utilization.\nDays is a list of number between 1 to 7, where 1 corresponds to Mon. and 7 corresponds to Sun.\nAll 7 days are included if this is not specified." }, { "name" : "endHourOfDay", "in" : "query", "default" : "23", "type" : "integer", "description" : "The end hour of a day for which the user wants to report utilization.\nThe hour is a number between [0-23]. Default value is 23 if this is not specified." }, { "name" : "from", "in" : "query", "type" : "string", "description" : "Start of the time range to report utilization in ISO 8601 format." }, { "name" : "startHourOfDay", "in" : "query", "default" : "0", "type" : "integer", "description" : "The start hour of a day for which the user wants to report utilization.\nThe hour is a number between [0-23]. Default value is 0 if this is not specified." }, { "name" : "tenantType", "in" : "query", "default" : "POOL", "type" : "string", "description" : "The type of the tenant (POOL or USER)." }, { "name" : "to", "in" : "query", "default" : "now", "type" : "string", "description" : "End of the the time range to report utilization in ISO 8601 format (defaults to now)." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiImpalaUtilization" }, "headers" : {}, "examples" : { "application/json" : { "totalQueries" : 12345.0, "successfulQueries" : 12345.0, "oomQueries" : 12345.0, "timeOutQueries" : 12345.0, "rejectedQueries" : 12345.0, "successfulQueriesPercentage" : 12345.0, "oomQueriesPercentage" : 12345.0, "timeOutQueriesPercentage" : 12345.0, "rejectedQueriesPercentage" : 12345.0, "avgWaitTimeInQueue" : 12345.0, "peakAllocationTimestampMS" : 12345, "maxAllocatedMemory" : 12345.0, "maxAllocatedMemoryPercentage" : 12345.0, "utilizedAtMaxAllocated" : 12345.0, "utilizedAtMaxAllocatedPercentage" : 12345.0, "peakUsageTimestampMS" : 12345, "maxUtilizedMemory" : 12345.0, "maxUtilizedMemoryPercentage" : 12345.0, "allocatedAtMaxUtilized" : 12345.0, "allocatedAtMaxUtilizedPercentage" : 12345.0, "distributionUtilizedByImpalaDaemon" : { "bins" : { "items" : [ {}, {} ] } }, "distributionAllocatedByImpalaDaemon" : { "bins" : { "items" : [ {}, {} ] } }, "tenantUtilizations" : { "items" : [ { "tenantName" : "...", "totalQueries" : 12345.0, "successfulQueries" : 12345.0, "oomQueries" : 12345.0, "timeOutQueries" : 12345.0, "rejectedQueries" : 12345.0, "avgWaitTimeInQueue" : 12345.0, "peakAllocationTimestampMS" : 12345, "maxAllocatedMemory" : 12345.0, "maxAllocatedMemoryPercentage" : 12345.0, "utilizedAtMaxAllocated" : 12345.0, "utilizedAtMaxAllocatedPercentage" : 12345.0, "peakUsageTimestampMS" : 12345, "maxUtilizedMemory" : 12345.0, "maxUtilizedMemoryPercentage" : 12345.0, "allocatedAtMaxUtilized" : 12345.0, "allocatedAtMaxUtilizedPercentage" : 12345.0, "distributionUtilizedByImpalaDaemon" : {}, "distributionAllocatedByImpalaDaemon" : {}, "avgSpilledMemory" : 12345.0, "maxSpilledMemory" : 12345.0 }, { "tenantName" : "...", "totalQueries" : 12345.0, "successfulQueries" : 12345.0, "oomQueries" : 12345.0, "timeOutQueries" : 12345.0, "rejectedQueries" : 12345.0, "avgWaitTimeInQueue" : 12345.0, "peakAllocationTimestampMS" : 12345, "maxAllocatedMemory" : 12345.0, "maxAllocatedMemoryPercentage" : 12345.0, "utilizedAtMaxAllocated" : 12345.0, "utilizedAtMaxAllocatedPercentage" : 12345.0, "peakUsageTimestampMS" : 12345, "maxUtilizedMemory" : 12345.0, "maxUtilizedMemoryPercentage" : 12345.0, "allocatedAtMaxUtilized" : 12345.0, "allocatedAtMaxUtilizedPercentage" : 12345.0, "distributionUtilizedByImpalaDaemon" : {}, "distributionAllocatedByImpalaDaemon" : {}, "avgSpilledMemory" : 12345.0, "maxSpilledMemory" : 12345.0 } ] }, "errorMessage" : "..." } }, "description" : "utilization report of Impala service." } } } }, "/clusters/{clusterName}/services/{serviceName}/metrics" : { "get" : { "deprecated" : true, "tags" : [ "ServicesResource" ], "summary" : "Fetch metric readings for a particular service.", "description" : "Fetch metric readings for a particular service.\n
\nBy default, this call will look up all metrics available for the service.\nIf only specific metrics are desired, use the metrics parameter.\n
\nBy default, the returned results correspond to a 5 minute window based on\nthe provided end time (which defaults to the current server time). The\nfrom and to parameters can be used to control the window\nbeing queried. A maximum window of 3 hours is enforced.\n
\nWhen requesting a \"full\" view, aside from the extended properties of the\nreturned metric data, the collection will also contain information about\nall metrics available for the service, even if no readings are available\nin the requested window.\n
\nHDFS services that have more than one nameservice will not expose\nany metrics. Instead, the nameservices should be queried separately.\n
", "operationId" : "getMetrics", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the service." }, { "name" : "from", "in" : "query", "type" : "string", "description" : "Start of the period to query." }, { "name" : "metrics", "in" : "query", "type" : "array", "items" : { "type" : "string" }, "collectionFormat" : "multi", "description" : "Filter for which metrics to query." }, { "name" : "to", "in" : "query", "default" : "now", "type" : "string", "description" : "End of the period to query." }, { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "The view of the data to materialize,\neither \"summary\" or \"full\"." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiMetricList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "context" : "...", "unit" : "...", "data" : [ { "timestamp" : "...", "value" : 12345.0 }, { "timestamp" : "...", "value" : 12345.0 } ], "displayName" : "...", "description" : "..." }, { "name" : "...", "context" : "...", "unit" : "...", "data" : [ { "timestamp" : "...", "value" : 12345.0 }, { "timestamp" : "...", "value" : 12345.0 } ], "displayName" : "...", "description" : "..." } ] } }, "description" : "List of readings from the monitors." } } } }, "/clusters/{clusterName}/services/{serviceName}/roleTypes" : { "get" : { "tags" : [ "ServicesResource" ], "summary" : "List the supported role types for a service.", "description" : "List the supported role types for a service.", "operationId" : "listRoleTypes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service to modify." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleTypeList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ "...", "..." ] } }, "description" : "List of role types the service supports." } } } }, "/clusters/{clusterName}/services/{serviceName}/tags" : { "delete" : { "tags" : [ "ServicesResource" ], "summary" : "Remove the tags associated with the service.", "description" : "Remove the tags associated with the service. Tag names beginning with\nthe prefix _cldr_ (case insensitive) are reserved for internal use by Cloudera.", "operationId" : "deleteTags", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the service to remove tags from" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "description" : "List of tags to remove from the service" } ], "responses" : { "204" : { "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "headers" : {}, "examples" : { "application/json" : [ { "name" : "...", "value" : "..." } ] }, "description" : "A list of tags that were removed from the service" } } }, "get" : { "tags" : [ "ServicesResource" ], "summary" : "Returns the tags associated with this service.", "description" : "Returns the tags associated with this service. Tag names beginning with the\nprefix _cldr_ (case insensitive) are reserved for internal use by Cloudera.", "operationId" : "readTags", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the service" }, { "name" : "limit", "in" : "query", "default" : "10", "type" : "integer", "description" : "Number of tags" }, { "name" : "offset", "in" : "query", "default" : "0", "type" : "integer", "description" : "Index of the first tag to retrieve" } ], "responses" : { "200" : { "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "headers" : {}, "examples" : { "application/json" : [ { "name" : "...", "value" : "..." } ] }, "description" : "A list of tags associated with the service" } } }, "put" : { "tags" : [ "ServicesResource" ], "summary" : "Attach tags to the service.", "description" : "Attach tags to the service. Tag names beginning with the prefix _cldr_\n(case insensitive) are reserved for internal use by Cloudera.", "operationId" : "addTags", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the service" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "description" : "List of tags to add to the service" } ], "responses" : { "204" : { "schema" : { "description" : "", "type" : "array", "items" : { "$ref" : "#/definitions/ApiEntityTag" } }, "headers" : {}, "examples" : { "application/json" : [ { "name" : "...", "value" : "..." } ] }, "description" : "A list of tags that were added to the service" } } } }, "/clusters/{clusterName}/services/{serviceName}/yarnUtilization" : { "get" : { "tags" : [ "ServicesResource" ], "summary" : "Provides the resource utilization of the yarn service as well as the\nresource utilization per tenant.", "description" : "Provides the resource utilization of the yarn service as well as the\nresource utilization per tenant. Only available with Cloudera Manager Enterprise Edition.", "operationId" : "getYarnUtilization", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "service name" }, { "name" : "daysOfWeek", "in" : "query", "type" : "array", "items" : { "type" : "string" }, "collectionFormat" : "multi", "description" : "The days of the week for which the user wants to report utilization.\nDays is a list of number between 1 to 7, where 1 corresponds to Mon. and 7 corresponds to Sun.\nAll 7 days are included if this is not specified." }, { "name" : "endHourOfDay", "in" : "query", "default" : "23", "type" : "integer", "description" : "The end hour of a day for which the user wants to report utilization.\nThe hour is a number between [0-23]. Default value is 23 if this is not specified." }, { "name" : "from", "in" : "query", "type" : "string", "description" : "Start of the time range to report utilization in ISO 8601 format." }, { "name" : "startHourOfDay", "in" : "query", "default" : "0", "type" : "integer", "description" : "The start hour of a day for which the user wants to report utilization.\nThe hour is a number between [0-23]. Default value is 0 if this is not specified." }, { "name" : "tenantType", "in" : "query", "default" : "POOL", "type" : "string", "description" : "The type of the tenant (POOL or USER)." }, { "name" : "to", "in" : "query", "default" : "now", "type" : "string", "description" : "End of the the time range to report utilization in ISO 8601 format (defaults to now)." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiYarnUtilization" }, "headers" : {}, "examples" : { "application/json" : { "avgCpuUtilization" : 12345.0, "maxCpuUtilization" : 12345.0, "avgCpuDailyPeak" : 12345.0, "maxCpuUtilizationTimestampMs" : 12345, "avgCpuUtilizationPercentage" : 12345.0, "maxCpuUtilizationPercentage" : 12345.0, "avgCpuDailyPeakPercentage" : 12345.0, "avgMemoryUtilization" : 12345.0, "maxMemoryUtilization" : 12345.0, "avgMemoryDailyPeak" : 12345.0, "maxMemoryUtilizationTimestampMs" : 12345, "avgMemoryUtilizationPercentage" : 12345.0, "maxMemoryUtilizationPercentage" : 12345.0, "avgMemoryDailyPeakPercentage" : 12345.0, "tenantUtilizations" : { "items" : [ { "tenantName" : "...", "avgYarnCpuAllocation" : 12345.0, "avgYarnCpuUtilization" : 12345.0, "avgYarnCpuUnusedCapacity" : 12345.0, "avgYarnCpuSteadyFairShare" : 12345.0, "avgYarnPoolAllocatedCpuDuringContention" : 12345.0, "avgYarnPoolFairShareCpuDuringContention" : 12345.0, "avgYarnPoolSteadyFairShareCpuDuringContention" : 12345.0, "avgYarnContainerWaitRatio" : 12345.0, "avgYarnMemoryAllocation" : 12345.0, "avgYarnMemoryUtilization" : 12345.0, "avgYarnMemoryUnusedCapacity" : 12345.0, "avgYarnMemorySteadyFairShare" : 12345.0, "avgYarnPoolAllocatedMemoryDuringContention" : 12345.0, "avgYarnPoolFairShareMemoryDuringContention" : 12345.0, "avgYarnPoolSteadyFairShareMemoryDuringContention" : 12345.0 }, { "tenantName" : "...", "avgYarnCpuAllocation" : 12345.0, "avgYarnCpuUtilization" : 12345.0, "avgYarnCpuUnusedCapacity" : 12345.0, "avgYarnCpuSteadyFairShare" : 12345.0, "avgYarnPoolAllocatedCpuDuringContention" : 12345.0, "avgYarnPoolFairShareCpuDuringContention" : 12345.0, "avgYarnPoolSteadyFairShareCpuDuringContention" : 12345.0, "avgYarnContainerWaitRatio" : 12345.0, "avgYarnMemoryAllocation" : 12345.0, "avgYarnMemoryUtilization" : 12345.0, "avgYarnMemoryUnusedCapacity" : 12345.0, "avgYarnMemorySteadyFairShare" : 12345.0, "avgYarnPoolAllocatedMemoryDuringContention" : 12345.0, "avgYarnPoolFairShareMemoryDuringContention" : 12345.0, "avgYarnPoolSteadyFairShareMemoryDuringContention" : 12345.0 } ] }, "errorMessage" : "..." } }, "description" : "utilization report of yarn service." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/copyHdfsFile" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Copies source HDFS file to destination cluster HDFS.", "description" : "Copies source HDFS file to destination cluster HDFS", "operationId" : "copyHdfsFile", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The source HDFS service" }, { "name" : "destinationPath", "in" : "query", "type" : "string", "description" : "HDFS full path at destination" }, { "name" : "sourcePath", "in" : "query", "type" : "string", "description" : "HDFS full path at source" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiServiceRef" }, "description" : "ApiServiceRef for the destination" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/createHdfsFile" : { "post" : { "tags" : [ "ServicesResource" ], "description" : "", "operationId" : "createHdfsFile", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The HDFS service name" }, { "name" : "overwrite", "in" : "query", "default" : "false", "type" : "boolean", "description" : "If true overwrite the file" }, { "name" : "path", "in" : "query", "type" : "string", "description" : "full path to the HDFS file to be created" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "type" : "string" }, "description" : "Content to be put in the file to be created" } ], "responses" : { "201" : { "schema" : { "description" : "", "type" : "string" }, "headers" : {}, "examples" : {}, "description" : "\"CREATED\" or \"FILE_EXISTS\" will be returned" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/createOozieDb" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Creates the Oozie Database Schema in the configured database.", "description" : "Creates the Oozie Database Schema in the configured database.\nThis command does not create database. This command creates only tables\nrequired by Oozie. To create database, please refer to oozieCreateEmbeddedDatabase()\n\n\nAvailable since API v2.\n
", "operationId" : "createOozieDb", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the Oozie service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/createSolrHdfsHomeDir" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Creates the home directory of a Solr service in HDFS.", "description" : "Creates the home directory of a Solr service in HDFS.\n\n\nAvailable since API v4.", "operationId" : "createSolrHdfsHomeDirCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The Solr service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/createSqoopUserDir" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Creates the user directory of a Sqoop service in HDFS.", "description" : "Creates the user directory of a Sqoop service in HDFS.\n\n
\nAvailable since API v4.", "operationId" : "createSqoopUserDirCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The Sqoop service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/decommission" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Decommission roles of a service.", "description" : "Decommission roles of a service.\n
\nFor HBase services, the list should contain names of RegionServers to\ndecommission.\n
\nFor HDFS services, the list should contain names of DataNodes to\ndecommission.", "operationId" : "decommissionCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The HBase service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "List of role names to decommision." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/deleteHdfsPath" : { "delete" : { "tags" : [ "ServicesResource" ], "summary" : "Deletes the file or directory, specified by the given path, on the given HDFS service.", "description" : "Deletes the file or directory, specified by the given path, on the given HDFS service.", "operationId" : "deleteHdfsPath", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The HDFS service name" }, { "name" : "path", "in" : "query", "type" : "string", "description" : "path of the file or directory to be deleted" }, { "name" : "recursive", "in" : "query", "type" : "boolean", "description" : "If the path is a directory and this is set to true,\nthen deletes the directory and its contents,\notherwise the call will fail if the directory is not empty" } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/DeleteHdfsPathResult" }, "headers" : {}, "examples" : { "application/json" : "DELETED" }, "description" : "DeleteHdfsPathResult" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/deployClientConfig" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Deploy a service's client configuration.", "description" : "Deploy a service's client configuration.\n
\nThe client configuration is deployed to the hosts where the given roles\nare running.\n
\nAdded in v3: passing null for the role name list will deploy client configs\nto all known service roles.\nAdded in v6: passing an empty role name list will deploy client configs\nto all known service roles.\n\nIn Cloudera Manager 5.3 and newer, client configurations are fully managed,\nmeaning that the server maintains state about which client configurations\nshould exist and be managed by alternatives, and the agents actively\nrectify their hosts with this state. Consequently, if this API call is made\nwith a specific set of roles, Cloudera Manager will deactivate, from\nalternatives, any deployed client configs from any non-gateway roles that\nare not specified as arguments. Gateway roles are always preserved,\nand calling this API with an empty or null argument continues to deploy to\nall roles.\n", "operationId" : "deployClientConfigCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "List of role names." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/disableJtHa" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Disable high availability (HA) for JobTracker.", "description" : "Disable high availability (HA) for JobTracker.\n\nAs part of disabling HA, any services that depend on the MapReduce service\nbeing modified will be stopped. The command arguments provide options to\nspecify name of JobTracker that will be preserved. The Command will\nredeploy the client configurations for services of the cluster after HA\nhas been disabled.", "operationId" : "disableJtHaCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The MapReduce service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiDisableJtHaArguments" }, "description" : "Arguments for the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/disableRmHa" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Disable high availability (HA) for ResourceManager.", "description" : "Disable high availability (HA) for ResourceManager.\n\nAs part of disabling HA, any services that depend on the YARN service\nbeing modified will be stopped. The command arguments provide options to\nspecify name of ResourceManager that will be preserved. The command will\nredeploy the client configurations for services of the cluster after HA\nhas been disabled.", "operationId" : "disableRmHaCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The YARN service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiDisableRmHaArguments" }, "description" : "Arguments for the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/disableSentryHa" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Disable high availability (HA) for Sentry service.", "description" : "Disable high availability (HA) for Sentry service.\n\nThis command only applies to CDH 5.13+ Sentry services.\n
\nThe command will keep exactly one Sentry server, on the specified host,\nand update the ZooKeeper configs needed for Sentry.\n
\nAll services that depend on HDFS will be restarted after enabling Sentry HA.\n
\nNote: Sentry doesn't support Rolling Restart.", "operationId" : "disableSentryHaCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "A String representing the Sentry service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiDisableSentryHaArgs" }, "description" : "An instance of ApiDisableSentryHaArgs\nrepresenting the arguments to the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "the created command instance" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/enableJtHa" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Enable high availability (HA) for a JobTracker.", "description" : "Enable high availability (HA) for a JobTracker.\n
\nThis command only applies to CDH4 MapReduce services.\n
\nThe command will create a new JobTracker on the specified host and then\ncreate an active/standby pair with the existing JobTracker. Autofailover\nwill be enabled using ZooKeeper. A ZNode will be created for this purpose.\nCommand arguments provide option to forcefully create this ZNode if one\nalready exists. A node may already exists if JobTracker was previously\nenabled in HA mode but HA mode was disabled later on. The ZNode is not\ndeleted when HA is disabled.\n
\nAs part of enabling HA, any services that depends on the MapReduce service\nbeing modified will be stopped. Command will redeploy the client\nconfigurations for services of the cluster after HA has been enabled.", "operationId" : "enableJtHaCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The MapReduce service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiEnableJtHaArguments" }, "description" : "Arguments for the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/enableRmHa" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Enable high availability (HA) for a YARN ResourceManager.", "description" : "Enable high availability (HA) for a YARN ResourceManager.\n
\nThis command only applies to CDH5+ YARN services.\n
\nThe command will create a new ResourceManager on the specified host and then\ncreate an active/standby pair with the existing ResourceManager. Autofailover\nwill be enabled using ZooKeeper.\n
\nAs part of enabling HA, any services that depends on the YARN service\nbeing modified will be stopped. Command will redeploy the client\nconfigurations for services of the cluster after HA has been enabled.", "operationId" : "enableRmHaCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The YARN service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiEnableRmHaArguments" }, "description" : "Arguments for the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/enableSentryHa" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Enable high availability (HA) for Sentry service.", "description" : "Enable high availability (HA) for Sentry service.\n
\nThis command only applies to CDH 5.13+ Sentry services.\n
\nThe command will create a new Sentry server on the specified host\nand set the ZooKeeper configs needed for Sentry HA.\n
\nAs part of enabling HA, all services that depend on HDFS will be\nrestarted after enabling Sentry HA.\n
\nNote: Sentry doesn't support Rolling Restart.", "operationId" : "enableSentryHaCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "A String representing the Sentry service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiEnableSentryHaArgs" }, "description" : "An instance of ApiEnableSentryHaArgs\nrepresenting the arguments to the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "the created command instance" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/enterMaintenanceMode" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Put the service into maintenance mode.", "description" : "Put the service into maintenance mode. This is a synchronous command. The\nresult is known immediately upon return.\n\n
\nAvailable since API v2.\n
", "operationId" : "enterMaintenanceMode", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/exitMaintenanceMode" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Take the service out of maintenance mode.", "description" : "Take the service out of maintenance mode. This is a synchronous command.\nThe result is known immediately upon return.\n\n\nAvailable since API v2.\n
", "operationId" : "exitMaintenanceMode", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Synchronous command result." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/exportSentryPermissions" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Export Sentry Permissions.", "description" : "Export Sentry Permissions.", "operationId" : "exportSentryPermissionsCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/firstRun" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Prepare and start a service.", "description" : "Prepare and start a service.\n\n\nPerform all the steps needed to prepare the service and start it.\n
\n\n\nAvailable since API v7.\n
", "operationId" : "firstRun", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the cluster." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hbaseCreateRoot" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Creates the root directory of an HBase service.", "description" : "Creates the root directory of an HBase service.", "operationId" : "createHBaseRootCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The HBase service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hbaseCreateUserDirectory" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Create the HBase user directory (usually /user/hbase).", "description" : "Create the HBase user directory (usually /user/hbase).", "operationId" : "hbaseReplicationCreateUserDirectory", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The local HBase service name" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupAutomatic" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Starts an automatic HBase replication first time setup.", "description" : "Starts an automatic HBase replication first time setup. After doing some configuration\n(see #hbaseReplicationSetup(String, boolean, ApiHBaseReplicationSetupCommandArgs)),\nit restarts both the source and target clusters.", "operationId" : "hbaseReplicationFirstTimeSetupAutomatic", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The local HBase service name" }, { "name" : "force", "in" : "query", "default" : "false", "type" : "boolean", "description" : "If true, perform setup even if already setup. (Default false)" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHBaseReplicationSetupCommandArgs" }, "description" : "Replication setup parameters such as\nthe source peer, source service, passphrase for the keystore, and\noptionally the RestartType\nfor both source and target (default is rolling restart)" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Contains the command ID that executes the request" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupCleanAndReset" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Cleans and resets the HBase replication first time setup on the given source and target:.", "description" : "Cleans and resets the HBase replication first time setup on the given source and target:\n\nAvailable since API v2.\n
", "operationId" : "hdfsCreateTmpDir", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the HDFS service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hdfsDisableAutoFailover" : { "post" : { "deprecated" : true, "tags" : [ "ServicesResource" ], "summary" : "Disable auto-failover for a highly available HDFS nameservice.", "description" : "Disable auto-failover for a highly available HDFS nameservice.\n\nThe command will modify the nameservice's NameNodes configuration to\ndisable automatic failover, and delete the existing failover controllers.\n
\nThe ZooKeeper dependency of the service will not be removed.", "operationId" : "hdfsDisableAutoFailoverCommand", "consumes" : [ "text/plain", "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The HDFS service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "type" : "string" }, "description" : "The nameservice name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hdfsDisableHa" : { "post" : { "deprecated" : true, "tags" : [ "ServicesResource" ], "summary" : "Disable high availability (HA) for an HDFS NameNode.", "description" : "Disable high availability (HA) for an HDFS NameNode.\n
\nThe NameNode to be kept must be running before HA can be disabled.\n
\nAs part of disabling HA, any services that depend on the HDFS service being\nmodified will be stopped. The command arguments provide options to\nre-start these services and to re-deploy the client configurations for\nservices of the cluster after HA has been disabled.", "operationId" : "hdfsDisableHaCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The HDFS service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHdfsDisableHaArguments" }, "description" : "Arguments for the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hdfsDisableNnHa" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Disable High Availability (HA) with Automatic Failover for an HDFS NameNode.", "description" : "Disable High Availability (HA) with Automatic Failover for an HDFS NameNode.\n
\nAs part of disabling HA, any services that depend on the HDFS service being\nmodified will be stopped. The command will delete the Standby NameNode\nassociated with the specified NameNode. Any FailoverControllers associated\nwith the NameNode's nameservice are also deleted. A SecondaryNameNode\nis created on the host specified by the arugments.\n
\nIf no nameservices uses Quorum Journal after HA is disabled for the specified\nnameservice, then all JournalNodes are also deleted.\n
\nThen, HDFS service is restarted and all services that were stopped\nare started again afterwards.\nFinally, client configs for HDFS and its depedents will be re-deployed.", "operationId" : "hdfsDisableNnHaCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The HDFS service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiDisableNnHaArguments" }, "description" : "Arguments for the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hdfsEnableAutoFailover" : { "post" : { "deprecated" : true, "tags" : [ "ServicesResource" ], "summary" : "Enable auto-failover for an HDFS nameservice.", "description" : "Enable auto-failover for an HDFS nameservice.\n
\nThis command requires that the nameservice exists, and HA has been\nconfigured for that nameservice.\n
\nThe command will create the needed failover controllers, perform the\nneeded initialization and configuration, and will start the new roles.\nThe existing NameNodes which are part of the nameservice will be\nre-started in the process.\n
\nThis process may require changing the service's configuration, to add a\ndependency on the provided ZooKeeper service. This will be done if such a\ndependency has not been configured yet, and will cause roles that are\nnot affected by this command to show an \"outdated configuration\" status.\n
\nIf a ZooKeeper dependency has already been set up by some other means,\nit does not need to be provided in the command arguments.", "operationId" : "hdfsEnableAutoFailoverCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The HDFS service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHdfsFailoverArguments" }, "description" : "Arguments for the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hdfsEnableHa" : { "post" : { "deprecated" : true, "tags" : [ "ServicesResource" ], "summary" : "Enable high availability (HA) for an HDFS NameNode.", "description" : "Enable high availability (HA) for an HDFS NameNode.\n
\nThe command will set up the given \"active\" and \"stand-by\" NameNodes as\nan HA pair. Both nodes need to already exist.\n
\nIf there is a SecondaryNameNode associated with either given NameNode\ninstance, it will be deleted.\n
\nNote that while the shared edits path may be different for both nodes,\nthey need to point to the same underlying storage (e.g., an NFS share).\n
\nAs part of enabling HA, any services that depend on the HDFS service being\nmodified will be stopped. The command arguments provide options to\nre-start these services and to re-deploy the client configurations for\nservices of the cluster after HA has been enabled.", "operationId" : "hdfsEnableHaCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The HDFS service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiHdfsHaArguments" }, "description" : "Arguments for the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hdfsEnableNnHa" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Enable High Availability (HA) with Automatic Failover for an HDFS NameNode.", "description" : "Enable High Availability (HA) with Automatic Failover for an HDFS NameNode.\n
\nThe command will create a Standby NameNode for the given nameservice\nand create FailoverControllers for both Active and Standby NameNodes.\nThe SecondaryNameNode associated with the Active NameNode will be deleted.\n
\nThe command will also create JournalNodes needed for HDFS HA if they\ndo not already exist.\n
\nAs part of enabling HA, any services that depend on the HDFS service being\nmodified will be stopped. They will be restarted after HA has been enabled.\nFinally, client configs for HDFS and its depedents will be re-deployed.", "operationId" : "hdfsEnableNnHaCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The HDFS service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiEnableNnHaArguments" }, "description" : "Arguments for the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hdfsFailover" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Initiate a failover in an HDFS HA NameNode pair.", "description" : "Initiate a failover in an HDFS HA NameNode pair.\n
\nThe arguments should contain the names of the two NameNodes in\nthe HA pair. The first one should be the currently active NameNode,\nthe second one the NameNode to be made active.", "operationId" : "hdfsFailoverCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The HDFS service name." }, { "name" : "force", "in" : "query", "default" : "false", "type" : "boolean", "description" : "Whether to force failover." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "Names of the NameNodes in the HA pair." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hdfsFinalizeRollingUpgrade" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Finalizes the rolling upgrade for HDFS by updating the NameNode\nmetadata permanently to the next version.", "description" : "Finalizes the rolling upgrade for HDFS by updating the NameNode\nmetadata permanently to the next version. Should be done after\ndoing a rolling upgrade to a CDH version >= 5.2.0.\n
\nAvailable since API v8.", "operationId" : "hdfsFinalizeRollingUpgrade", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The HDFS service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hdfsRollEdits" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Roll the edits of an HDFS NameNode or Nameservice.", "description" : "Roll the edits of an HDFS NameNode or Nameservice.\n
\nAvailable since API v3.", "operationId" : "hdfsRollEditsCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The HDFS service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRollEditsArgs" }, "description" : "Arguments to the Roll Edits command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hdfsUpgradeMetadata" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Upgrade HDFS Metadata as part of a major version upgrade.", "description" : "Upgrade HDFS Metadata as part of a major version upgrade.\n
\nWhen doing a major version upgrade for HDFS, it is necessary to start HDFS\nin a special mode where it will do any necessary upgrades of stored\nmetadata. Trying to start HDFS normally will result in an error message and\nthe NameNode(s) failing to start.\n\nThe metadata upgrade must eventually be finalized, using the\nhdfsFinalizeMetadataUpgrade command on the NameNode.\n\nAvailable since API v6.", "operationId" : "hdfsUpgradeMetadataCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The HDFS service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hiveCreateHiveUserDir" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Create the Hive user directory.", "description" : "Create the Hive user directory\n\nAvailable since API v4.\n
", "operationId" : "createHiveUserDirCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The Hive service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hiveCreateHiveWarehouse" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Create the Hive warehouse directory, on Hive services.", "description" : "Create the Hive warehouse directory, on Hive services.\n\nAvailable since API v3.\n
", "operationId" : "createHiveWarehouseCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The Hive service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hiveCreateHiveWarehouseExternal" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Create the Hive warehouse external directory for Private Cloud.", "description" : "Create the Hive warehouse external directory for Private Cloud.", "operationId" : "createHiveWarehouseExternalCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The Hive service name." }, { "name" : "directory", "in" : "query", "type" : "string", "description" : "Name of the warehouse external directory." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hiveCreateMetastoreDatabase" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Create the Hive Metastore Database.", "description" : "Create the Hive Metastore Database. Only works with embedded postgresql\ndatabase.\n\nThis command is to be run whenever a new user and database needs to be\ncreated in the embedded postgresql database for a Hive service. This\ncommand should usually be followed by a call to\nhiveCreateMetastoreDatabaseTables.\n
\nAvailable since API v4.", "operationId" : "hiveCreateMetastoreDatabaseCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the Hive service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hiveCreateMetastoreDatabaseTables" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Create the Hive Metastore Database tables.", "description" : "Create the Hive Metastore Database tables.\n
\nThis command is to be run whenever a new database has been specified. Will\ndo nothing if tables already exist. Will not perform an upgrade. Only\nAvailable when all Hive Metastore Servers are stopped.\n
\nAvailable since API v3.", "operationId" : "hiveCreateMetastoreDatabaseTablesCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the Hive service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hiveUpdateMetastoreNamenodes" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Update Hive Metastore to point to a NameNode's Nameservice name instead of\nhostname.", "description" : "Update Hive Metastore to point to a NameNode's Nameservice name instead of\nhostname.\n
\nBack up the Hive Metastore Database before running this command.\n
\nThis command is to be run after enabling HDFS High Availability. Only\navailable when all Hive Metastore Servers are stopped.\n
\nAvailable since API v4.", "operationId" : "hiveUpdateMetastoreNamenodesCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the Hive service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hiveUpgradeMetastore" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Upgrade Hive Metastore as part of a major version upgrade.", "description" : "Upgrade Hive Metastore as part of a major version upgrade.\n
\nWhen doing a major version upgrade for Hive, it is necessary to upgrade\ndata in the metastore database.\n\nAvailable since API v6.", "operationId" : "hiveUpgradeMetastoreCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The Hive service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hiveValidateMetastoreSchema" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Validate the Hive Metastore Schema.", "description" : "Validate the Hive Metastore Schema.\n\nThis command checks the Hive metastore schema for any errors and corruptions.\nThis command is to be run on two instances:\n
\nAvailable since API v17.", "operationId" : "hiveValidateMetastoreSchemaCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the Hive service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hueCreateHiveWarehouse" : { "post" : { "deprecated" : true, "tags" : [ "ServicesResource" ], "summary" : "Create the Beeswax role's Hive warehouse directory, on Hue services.", "description" : "Create the Beeswax role's Hive warehouse directory, on Hue services.", "operationId" : "createBeeswaxWarehouseCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The Hue service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hueDumpDb" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Runs Hue's dumpdata command.", "description" : "Runs Hue's dumpdata command.\n\nAvailable since API v10.", "operationId" : "hueDumpDbCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the service" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hueLoadDb" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Runs Hue's loaddata command.", "description" : "Runs Hue's loaddata command.\n\nAvailable since API v10.", "operationId" : "hueLoadDbCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the service" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/hueSyncDb" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Runs Hue's syncdb command.", "description" : "Runs Hue's syncdb command.\n\nAvailable since API v10.", "operationId" : "hueSyncDbCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the service" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/impalaCreateCatalogDatabase" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : ".", "description" : "Not needed in CM 5.0.0 Release, since Impala Catalog Database\nis not yet available in CDH as of this release.\nCreate the Impala Catalog Database. Only works with embedded postgresql\ndatabase.\n
\nThis command is to be run whenever a new user and database needs to be\ncreated in the embedded postgresql database for the Impala Catalog Server.\nThis command should usually be followed by a call to\nimpalaCreateCatalogDatabaseTables.\n
\nAvailable since API v6.", "operationId" : "impalaCreateCatalogDatabaseCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the Impala service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/impalaCreateCatalogDatabaseTables" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : ".", "description" : "Not needed in CM 5.0.0 Release, since Impala Catalog Database\nis not yet available in CDH as of this release.\nCreate the Impala Catalog Database tables.\n
\nThis command is to be run whenever a new database has been specified. Will\ndo nothing if tables already exist. Will not perform an upgrade. Only\navailable when all Impala Catalog Servers are stopped.\n
\nAvailable since API v6.", "operationId" : "impalaCreateCatalogDatabaseTablesCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the Impala service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/impalaCreateUserDir" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Create the Impala user directory.", "description" : "Create the Impala user directory\n
\nAvailable since API v6.\n
", "operationId" : "createImpalaUserDirCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The Impala service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/impalaDisableLlamaHa" : { "post" : { "deprecated" : true, "tags" : [ "ServicesResource" ], "summary" : "Not Supported.", "description" : "Not Supported. Llama was removed.", "operationId" : "disableLlamaHaCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiDisableLlamaHaArguments" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/impalaDisableLlamaRm" : { "post" : { "deprecated" : true, "tags" : [ "ServicesResource" ], "summary" : "Not Supported.", "description" : "Not Supported. Llama was removed.", "operationId" : "disableLlamaRmCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/impalaEnableLlamaHa" : { "post" : { "deprecated" : true, "tags" : [ "ServicesResource" ], "summary" : "Not Supported.", "description" : "Not Supported. Llama was removed.", "operationId" : "enableLlamaHaCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiEnableLlamaHaArguments" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/impalaEnableLlamaRm" : { "post" : { "deprecated" : true, "tags" : [ "ServicesResource" ], "summary" : "Not Supported.", "description" : "Not Supported. Llama was removed.", "operationId" : "enableLlamaRmCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiEnableLlamaRmArguments" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/importMrConfigsIntoYarn" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Import MapReduce configuration into Yarn, overwriting Yarn configuration.", "description" : "Import MapReduce configuration into Yarn, overwriting Yarn configuration.\n\nYou will lose existing Yarn configuration. Read all MapReduce\nconfiguration, role assignments, and role configuration groups and update\nYarn with corresponding values. MR1 configuration will be converted into\nthe equivalent MR2 configuration.\n
\nBefore running this command, Yarn must be stopped and MapReduce must exist\nwith valid configuration.\n
\nAvailable since API v6.", "operationId" : "importMrConfigsIntoYarn", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the Yarn service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/initSolr" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Initializes the Solr service in Zookeeper.", "description" : "Initializes the Solr service in Zookeeper.\n\n
\nAvailable since API v4.", "operationId" : "initSolrCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The Solr service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/installMrFrameworkJars" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Creates an HDFS directory to hold the MapReduce2 framework JARs\n(if necessary), and uploads the framework JARs to it.", "description" : "Creates an HDFS directory to hold the MapReduce2 framework JARs\n(if necessary), and uploads the framework JARs to it.\n
\nThis command is run automatically when starting a YARN service for\nthe first time, or when upgrading an existing YARN service. It can\nalso be run manually to ensure that the latest version of the framework\nJARS is installed.\n
\nAvailable since API v30.\n
", "operationId" : "installMrFrameworkJars", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the YARN service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/installOozieShareLib" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Creates directory for Oozie user in HDFS and installs the ShareLib in it.", "description" : "Creates directory for Oozie user in HDFS and installs the ShareLib in it.\n
\nThis command should be re-run after a major version upgrade to refresh the\nShareLib to the latest version.\n\nAvailable since API v3.\n", "operationId" : "installOozieShareLib", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the Oozie service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/migrateToSentry" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Migrates the HBase Indexer policy-based permissions to Sentry,\nby invoking the SentryConfigToolIndexer.", "description" : "Migrates the HBase Indexer policy-based permissions to Sentry,\nby invoking the SentryConfigToolIndexer.\n\nNote:\n
\nAvailable since API v30.", "operationId" : "ksMigrateToSentry", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "A String representing the KeyStore Indexer service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "the created command instance" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/offline" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Offline roles of a service.", "description" : "Offline roles of a service.\n
\nCurrently the offline operation is only supported by HDFS.\n
\nFor HDFS, the offline operation will put DataNodes into HDFS IN MAINTENANCE state which\nprevents unnecessary re-replication which could occur if decommissioned.\n
\nThe timeout parameter is used to specify a timeout for offline. For HDFS, when the\ntimeout expires, the DataNode will automatically transition out of HDFS IN MAINTENANCE\nstate, back to HDFS IN SERVICE state.\n
", "operationId" : "offlineCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "timeout", "in" : "query", "type" : "integer", "description" : "Offline timeout in seconds. Offlined roles will automatically transition from offline\nstate to normal state after timeout.\nSpecify as null to get the default timeout (4 hours)." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "List of role names to offline." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/oozieCreateEmbeddedDatabase" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Create the Oozie Server Database.", "description" : "Create the Oozie Server Database. Only works with embedded postgresql\ndatabase.\n
\nThis command is to be run whenever a new user and database need to be\ncreated in the embedded postgresql database for an Oozie service. This\ncommand should usually be followed by a call to createOozieDb.\n
\nAvailable since API v10.", "operationId" : "oozieCreateEmbeddedDatabaseCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the Oozie service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/oozieDisableHa" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Disable high availability (HA) for Oozie.", "description" : "Disable high availability (HA) for Oozie.\n\nAs part of disabling HA, any services that depend on the Oozie service\nbeing modified will be stopped. The command arguments provide options to\nspecify name of Oozie Server that will be preserved. After deleting,\nother Oozie servers, all the services that were stopped are restarted.", "operationId" : "disableOozieHaCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The Oozie service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiDisableOozieHaArguments" }, "description" : "Arguments for the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/oozieDumpDatabase" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Dump the Oozie Server Database.", "description" : "Dump the Oozie Server Database.", "operationId" : "oozieDumpDatabaseCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the service" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/oozieEnableHa" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Enable high availability (HA) for Oozie service.", "description" : "Enable high availability (HA) for Oozie service.\n
\nThis command only applies to CDH5+ Oozie services.\n
\nThe command will create new Oozie Servers on the specified hosts and\nset the ZooKeeper and Load Balancer configs needed for Oozie HA.\n
\nAs part of enabling HA, any services that depends on the Oozie service\nbeing modified will be stopped and restarted after enabling Oozie HA.", "operationId" : "enableOozieHaCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The Oozie service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiEnableOozieHaArguments" }, "description" : "Arguments for the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/oozieLoadDatabase" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Load the Oozie Server Database from dump.", "description" : "Load the Oozie Server Database from dump.", "operationId" : "oozieLoadDatabaseCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the service" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/oozieUpgradeDb" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Upgrade Oozie Database schema as part of a major version upgrade.", "description" : "Upgrade Oozie Database schema as part of a major version upgrade.\n
\nWhen doing a major version upgrade for Oozie, it is necessary to upgrade\nthe schema of its database before Oozie can run successfully.\n\nAvailable since API v6.", "operationId" : "oozieUpgradeDbCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The Oozie service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/recommission" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Recommission roles of a service.", "description" : "Recommission roles of a service.\n\nThe list should contain names of slave roles to recommission.\n
\n\n\nAvailable since API v2.\n
", "operationId" : "recommissionCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the service on which to run the command." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "List of role names to recommision." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/recommissionWithStart" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Start and recommission roles of a service.", "description" : "Start and recommission roles of a service.\n\nThe list should contain names of slave roles to start and recommission.\n
\n\n\nWarning: Evolving. This method may change in the future and does not offer standard compatibility guarantees.\nOnly support by HDFS.\nDo not use without guidance from Cloudera.\n
\n\n\nAvailable since API v15.\n
", "operationId" : "recommissionWithStartCommand", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the service on which to run the command." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRoleNameList" }, "description" : "List of role names to recommision." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/restart" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Restart the service.", "description" : "Restart the service.", "operationId" : "restartCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service to start." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/rollingRestart" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Command to run rolling restart of roles in a service.", "description" : "Command to run rolling restart of roles in a service. The sequence is:\n\nAvailable since API v3. Only available with Cloudera Manager Enterprise\nEdition.", "operationId" : "rollingRestart", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiRollingRestartArgs" }, "description" : "" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/sentryCreateDatabase" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Create the Sentry Server Database.", "description" : "Create the Sentry Server Database. Only works with embedded postgresql\ndatabase.\n
\nThis command is to be run whenever a new user and database need to be\ncreated in the embedded postgresql database for a Sentry service. This\ncommand should usually be followed by a call to sentryCreateDatabaseTables.\n
\nAvailable since API v7.", "operationId" : "sentryCreateDatabaseCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the Sentry service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/sentryCreateDatabaseTables" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Create the Sentry Server Database tables.", "description" : "Create the Sentry Server Database tables.\n
\nThis command is to be run whenever a new database has been specified. Will\ndo nothing if tables already exist. Will not perform an upgrade. Only\nAvailable when Sentry Server is stopped.\n
\nAvailable since API v7.", "operationId" : "sentryCreateDatabaseTablesCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the Sentry service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/sentryUpgradeDatabaseTables" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Upgrade the Sentry Server Database tables.", "description" : "Upgrade the Sentry Server Database tables.\n
\nThis command is to be run whenever Sentry requires an upgrade to its\ndatabase tables.\n
\nAvailable since API v8.", "operationId" : "sentryUpgradeDatabaseTablesCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the Sentry service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/solrBootstrapCollections" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Bootstraps Solr Collections after the CDH upgrade.", "description" : "Bootstraps Solr Collections after the CDH upgrade.\n
\nNote: This is only needed for upgrading to CDH6.0.\n
\nAvailable since API v30.", "operationId" : "solrBootstrapCollectionsCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "A String representing the Solr service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "the created command instance" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/solrBootstrapConfig" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Bootstraps Solr config during the CDH upgrade.", "description" : "Bootstraps Solr config during the CDH upgrade.\n
\nNote: This is only needed for upgrading to CDH6.0.\n
\nAvailable since API v30.", "operationId" : "solrBootstrapConfigCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "A String representing the Solr service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "the created command instance" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/solrConfigBackup" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Backs up Solr configuration metadata before CDH upgrade.", "description" : "Backs up Solr configuration metadata before CDH upgrade.\n
\nNote:\n
\nNote:\n
\nAvailable since API v30.", "operationId" : "solrMigrateSentryPrivilegesCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "A String representing the Solr service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "the created command instance" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/solrReinitializeStateForUpgrade" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Reinitializes the Solr state by clearing the Solr HDFS\ndata directory, the Solr data directory, and the Zookeeper\nstate.", "description" : "Reinitializes the Solr state by clearing the Solr HDFS\ndata directory, the Solr data directory, and the Zookeeper\nstate.\n
\nNote:\n
\nAvailable since API v30.", "operationId" : "solrReinitializeStateForUpgradeCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "A String representing the Solr service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "the created command instance" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/solrValidateMetadata" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Validates Solr metadata and configurations.", "description" : "Validates Solr metadata and configurations.\n
\nNote: This is only needed for upgrading to CDH6.0.\n
\nAvailable since API v30.", "operationId" : "solrValidateMetadataCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "A String representing the Solr service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "the created command instance" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/sqoopCreateDatabaseTables" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Create the Sqoop2 Server Database tables.", "description" : "Create the Sqoop2 Server Database tables.\n
\nThis command is to be run whenever a new database has been specified. Will\ndo nothing if tables already exist. Will not perform an upgrade. Only\navailable when Sqoop2 Server is stopped.\n
\nAvailable since API v10.", "operationId" : "sqoopCreateDatabaseTablesCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the Sentry service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/sqoopUpgradeDb" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Upgrade Sqoop Database schema as part of a major version upgrade.", "description" : "Upgrade Sqoop Database schema as part of a major version upgrade.\n
\nWhen doing a major version upgrade for Sqoop, it is necessary to upgrade\nthe schema of its database before Sqoop can run successfully.\n\nAvailable since API v6.", "operationId" : "sqoopUpgradeDbCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The Sqoop service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/start" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Start the service.", "description" : "Start the service.", "operationId" : "startCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service to start." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "BAD", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/stop" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Stop the service.", "description" : "Stop the service.", "operationId" : "stopCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service to stop." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STARTED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/switchToMr2" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Change the cluster to use MR2 instead of MR1.", "description" : "Change the cluster to use MR2 instead of MR1. Services will be restarted.\n\nWill perform the following steps:\n
\nAvailable since API v6.", "operationId" : "switchToMr2", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the Yarn service on which to run the command." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/yarnApplicationDiagnosticsCollection" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Collect the Diagnostics data for Yarn applications.", "description" : "Collect the Diagnostics data for Yarn applications\n
\nAvailable since API v8.", "operationId" : "collectYarnApplicationDiagnostics", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "Name of the YARN service on which to run the command." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiYarnApplicationDiagnosticsCollectionArgs" }, "description" : "Arguments used for collecting diagnostics data for Yarn applications" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command" } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/yarnCreateCmContainerUsageInputDirCommand" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Creates the HDFS directory where YARN container usage metrics are\nstored by NodeManagers for CM to read and aggregate into app usage metrics.", "description" : "Creates the HDFS directory where YARN container usage metrics are\nstored by NodeManagers for CM to read and aggregate into app usage metrics.\n
\nAvailable since API v13.\n
", "operationId" : "createYarnCmContainerUsageInputDirCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The YARN service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STARTING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "CONCERNING", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/yarnCreateJobHistoryDirCommand" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Create the Yarn job history directory.", "description" : "Create the Yarn job history directory\n\nAvailable since API v6.\n
", "operationId" : "createYarnJobHistoryDirCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The YARN service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "BUSY" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/yarnFormatStateStore" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Formats the state store in ZooKeeper used for Resource Manager\nHigh Availability.", "description" : "Formats the state store in ZooKeeper used for Resource Manager\nHigh Availability. Typically used while moving from non-secure\nto secure cluster or vice-versa.\n\nAvailable since API v8.", "operationId" : "yarnFormatStateStore", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The YARN service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "HISTORY_NOT_AVAILABLE" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/yarnNodeManagerRemoteAppLogDirCommand" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Create the Yarn NodeManager remote application log directory.", "description" : "Create the Yarn NodeManager remote application log directory\n
\nAvailable since API v6.\n
", "operationId" : "createYarnNodeManagerRemoteAppLogDirCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The YARN service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/zooKeeperCleanup" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Clean up all running server instances of a ZooKeeper service.", "description" : "Clean up all running server instances of a ZooKeeper service.\n\nThis command removes snapshots and transaction log files kept by\nZooKeeper for backup purposes. Refer to the ZooKeeper documentation\nfor more details.", "operationId" : "zooKeeperCleanupCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service to start." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "HISTORY_NOT_AVAILABLE", "roleStatus" : "STOPPED" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/zooKeeperInit" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Initializes all the server instances of a ZooKeeper service.", "description" : "Initializes all the server instances of a ZooKeeper service.\n
\nZooKeeper server roles need to be initialized before they\ncan be used.", "operationId" : "zooKeeperInitCommand", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service to start." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "GOOD", "roleStatus" : "STOPPING" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/commands/{commandName}" : { "post" : { "tags" : [ "ServicesResource" ], "summary" : "Executes a command on the service specified\nby name.", "description" : "Executes a command on the service specified\nby name.\n
\nAvailable since API v6.\n
", "operationId" : "serviceCommandByName", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "commandName", "in" : "path", "required" : true, "type" : "string", "description" : "The command name." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiCommand" }, "headers" : {}, "examples" : { "application/json" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "NOT_AVAILABLE", "roleStatus" : "NA" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : { "clusterName" : "...", "displayName" : "..." }, "serviceRef" : { "peerName" : "...", "clusterName" : "...", "serviceName" : "...", "serviceDisplayName" : "...", "serviceType" : "..." }, "roleRef" : { "clusterName" : "...", "serviceName" : "...", "roleName" : "...", "healthSummary" : "DISABLED", "roleStatus" : "UNKNOWN" }, "hostRef" : { "hostId" : "...", "hostname" : "..." }, "parent" : {}, "children" : { "items" : [ {}, {} ] }, "canRetry" : true }, "children" : { "items" : [ { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true }, { "id" : 12345, "name" : "...", "startTime" : "...", "endTime" : "...", "active" : true, "success" : true, "resultMessage" : "...", "resultDataUrl" : "...", "clusterRef" : {}, "serviceRef" : {}, "roleRef" : {}, "hostRef" : {}, "parent" : {}, "children" : {}, "canRetry" : true } ] }, "canRetry" : true } }, "description" : "Information about the submitted command." } } } }, "/clusters/{clusterName}/services/{serviceName}/reports/hdfsUsageReport" : { "get" : { "tags" : [ "ServicesResource" ], "summary" : "Fetch the HDFS usage report.", "description" : "Fetch the HDFS usage report. For the requested time range, at the\nspecified aggregation intervals, the report shows HDFS disk usages\nper user.\n\nThis call supports returning JSON or CSV, as determined by the\n\"Accept\" header of application/json or text/csv.\n
\nAvailable since API v4. Only available with Cloudera Manager Enterprise\nEdition.", "operationId" : "getHdfsUsageReport", "produces" : [ "text/csv", "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The HDFS service name." }, { "name" : "aggregation", "in" : "query", "default" : "daily", "type" : "string", "enum" : [ "DAILY", "HOURLY", "WEEKLY" ], "description" : "The (optional) aggregation period for the data.\nSupports \"hourly\", \"daily\" (default) and \"weekly\"." }, { "name" : "from", "in" : "query", "type" : "string", "description" : "The (optional) start time of the report in ISO 8601 format (\ndefaults to 24 hours before \"to\" time)." }, { "name" : "nameservice", "in" : "query", "type" : "string", "description" : "The (optional) HDFS nameservice. Required for HA setup." }, { "name" : "to", "in" : "query", "default" : "now", "type" : "string", "description" : "The (optional) end time of the report in ISO 8601 format (\ndefaults to now)." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiHdfsUsageReport" }, "headers" : {}, "examples" : { "application/json" : { "lastUpdateTime" : "...", "items" : [ { "date" : "...", "user" : "...", "size" : 12345, "rawSize" : 12345, "numFiles" : 12345 }, { "date" : "...", "user" : "...", "size" : 12345, "rawSize" : 12345, "numFiles" : 12345 } ] } }, "description" : "Report data." } } } }, "/clusters/{clusterName}/services/{serviceName}/reports/mrUsageReport" : { "get" : { "tags" : [ "ServicesResource" ], "summary" : "Fetch the MR usage report.", "description" : "Fetch the MR usage report. For the requested time range, at the\nspecified aggregation intervals, the report shows job CPU usages (and other\nmetrics) per user.\n
\nThis call supports returning JSON or CSV, as determined by the\n\"Accept\" header of application/json or text/csv.\n
\nAvailable since API v4. Only available with Cloudera Manager Enterprise\nEdition.",
"operationId" : "getMrUsageReport",
"produces" : [
"text/csv",
"application/json"
],
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : "The MR service name."
},
{
"name" : "aggregation",
"in" : "query",
"default" : "daily",
"type" : "string",
"enum" : [
"DAILY",
"HOURLY",
"WEEKLY"
],
"description" : "The (optional) aggregation period for the data.\nSupports \"hourly\", \"daily\" (default) and \"weekly\"."
},
{
"name" : "from",
"in" : "query",
"type" : "string",
"description" : "The (optional) start time of the report in ISO 8601 format\n(defaults to 24 hours before \"to\" time)."
},
{
"name" : "to",
"in" : "query",
"default" : "now",
"type" : "string",
"description" : "The (optional) end time of the report in ISO 8601 format (defaults\nto now)."
}
],
"responses" : {
"200" : {
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiMrUsageReport"
},
"headers" : {},
"examples" : {
"application/json" : {
"items" : [
{
"timePeriod" : "...",
"user" : "...",
"group" : "...",
"cpuSec" : 12345,
"memoryBytes" : 12345,
"jobCount" : 12345,
"taskCount" : 12345,
"durationSec" : 12345,
"failedMaps" : 12345,
"totalMaps" : 12345,
"failedReduces" : 12345,
"totalReduces" : 12345,
"mapInputBytes" : 12345,
"mapOutputBytes" : 12345,
"hdfsBytesRead" : 12345,
"hdfsBytesWritten" : 12345,
"localBytesRead" : 12345,
"localBytesWritten" : 12345,
"dataLocalMaps" : 12345,
"rackLocalMaps" : 12345
},
{
"timePeriod" : "...",
"user" : "...",
"group" : "...",
"cpuSec" : 12345,
"memoryBytes" : 12345,
"jobCount" : 12345,
"taskCount" : 12345,
"durationSec" : 12345,
"failedMaps" : 12345,
"totalMaps" : 12345,
"failedReduces" : 12345,
"totalReduces" : 12345,
"mapInputBytes" : 12345,
"mapOutputBytes" : 12345,
"hdfsBytesRead" : 12345,
"hdfsBytesWritten" : 12345,
"localBytesRead" : 12345,
"localBytesWritten" : 12345,
"dataLocalMaps" : 12345,
"rackLocalMaps" : 12345
}
]
}
},
"description" : "Report data."
}
}
}
},
"/clusters/{clusterName}/services/{serviceName}/snapshots" : {
"post" : {
"tags" : [
"SnapshotsResource"
],
"summary" : "Creates one or more snapshot policies.",
"description" : "Creates one or more snapshot policies.",
"operationId" : "adhocSnapshot",
"consumes" : [
"application/json"
],
"produces" : [
"application/json"
],
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "body",
"in" : "body",
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiAdhocSnapshot"
},
"description" : ""
}
],
"responses" : {
"201" : {
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiCommand"
},
"headers" : {},
"examples" : {
"application/json" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "BAD",
"roleStatus" : "BUSY"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "DISABLED",
"roleStatus" : "STOPPING"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {},
"children" : {
"items" : [
{},
{}
]
},
"canRetry" : true
},
"children" : {
"items" : [
{
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
{
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
}
]
},
"canRetry" : true
}
},
"description" : "List of newly added policies."
}
}
}
},
"/clusters/{clusterName}/services/{serviceName}/snapshots/policies" : {
"get" : {
"tags" : [
"SnapshotsResource"
],
"summary" : "Returns information for all snapshot policies.",
"description" : "Returns information for all snapshot policies.",
"operationId" : "readPolicies",
"produces" : [
"application/json"
],
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "view",
"in" : "query",
"default" : "summary",
"type" : "string",
"enum" : [
"EXPORT",
"EXPORT_REDACTED",
"FULL",
"FULL_WITH_HEALTH_CHECK_EXPLANATION",
"SUMMARY"
],
"description" : "The view to materialize."
}
],
"responses" : {
"200" : {
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiSnapshotPolicyList"
},
"headers" : {},
"examples" : {
"application/json" : {
"items" : [
{
"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" : {
"tableRegExps" : [
"...",
"..."
],
"storage" : "LOCAL"
},
"hdfsArguments" : {
"pathPatterns" : [
"...",
"..."
]
},
"lastCommand" : {
"hbaseResult" : {},
"hdfsResult" : {},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
"lastSuccessfulCommand" : {
"hbaseResult" : {},
"hdfsResult" : {},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
"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" : {
"tableRegExps" : [
"...",
"..."
],
"storage" : "LOCAL"
},
"hdfsArguments" : {
"pathPatterns" : [
"...",
"..."
]
},
"lastCommand" : {
"hbaseResult" : {},
"hdfsResult" : {},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
"lastSuccessfulCommand" : {
"hbaseResult" : {},
"hdfsResult" : {},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
"paused" : true
}
]
}
},
"description" : "List of snapshot policies."
}
}
},
"post" : {
"tags" : [
"SnapshotsResource"
],
"summary" : "Creates one or more snapshot policies.",
"description" : "Creates one or more snapshot policies.",
"operationId" : "createPolicies",
"consumes" : [
"application/json"
],
"produces" : [
"application/json"
],
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "body",
"in" : "body",
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiSnapshotPolicyList"
},
"description" : "List of the snapshot policies to create."
}
],
"responses" : {
"201" : {
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiSnapshotPolicyList"
},
"headers" : {},
"examples" : {
"application/json" : {
"items" : [
{
"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" : {
"tableRegExps" : [
"...",
"..."
],
"storage" : "LOCAL"
},
"hdfsArguments" : {
"pathPatterns" : [
"...",
"..."
]
},
"lastCommand" : {
"hbaseResult" : {},
"hdfsResult" : {},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
"lastSuccessfulCommand" : {
"hbaseResult" : {},
"hdfsResult" : {},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
"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" : {
"tableRegExps" : [
"...",
"..."
],
"storage" : "LOCAL"
},
"hdfsArguments" : {
"pathPatterns" : [
"...",
"..."
]
},
"lastCommand" : {
"hbaseResult" : {},
"hdfsResult" : {},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
"lastSuccessfulCommand" : {
"hbaseResult" : {},
"hdfsResult" : {},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
"paused" : true
}
]
}
},
"description" : "List of newly added policies."
}
}
}
},
"/clusters/{clusterName}/services/{serviceName}/snapshots/policies/{policyName}" : {
"delete" : {
"tags" : [
"SnapshotsResource"
],
"summary" : "Deletes an existing snapshot policy.",
"description" : "Deletes an existing snapshot policy.",
"operationId" : "deletePolicy",
"produces" : [
"application/json"
],
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "policyName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : "Name of an existing snapshot policy."
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
}
],
"responses" : {
"204" : {
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiSnapshotPolicy"
},
"headers" : {},
"examples" : {
"application/json" : {
"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" : {
"tableRegExps" : [
"...",
"..."
],
"storage" : "LOCAL"
},
"hdfsArguments" : {
"pathPatterns" : [
"...",
"..."
]
},
"lastCommand" : {
"hbaseResult" : {
"processedTableCount" : 12345,
"processedTables" : [
"...",
"..."
],
"unprocessedTableCount" : 12345,
"unprocessedTables" : [
"...",
"..."
],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [
{},
{}
],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [
{},
{}
],
"creationErrorCount" : 12345,
"creationErrors" : [
{},
{}
],
"deletionErrorCount" : 12345,
"deletionErrors" : [
{},
{}
]
},
"hdfsResult" : {
"processedPathCount" : 12345,
"processedPaths" : [
"...",
"..."
],
"unprocessedPathCount" : 12345,
"unprocessedPaths" : [
"...",
"..."
],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [
{},
{}
],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [
{},
{}
],
"creationErrorCount" : 12345,
"creationErrors" : [
{},
{}
],
"deletionErrorCount" : 12345,
"deletionErrors" : [
{},
{}
]
},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "DISABLED",
"roleStatus" : "STARTED"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
"children" : {
"items" : [
{},
{}
]
},
"canRetry" : true
},
"lastSuccessfulCommand" : {
"hbaseResult" : {
"processedTableCount" : 12345,
"processedTables" : [
"...",
"..."
],
"unprocessedTableCount" : 12345,
"unprocessedTables" : [
"...",
"..."
],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [
{},
{}
],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [
{},
{}
],
"creationErrorCount" : 12345,
"creationErrors" : [
{},
{}
],
"deletionErrorCount" : 12345,
"deletionErrors" : [
{},
{}
]
},
"hdfsResult" : {
"processedPathCount" : 12345,
"processedPaths" : [
"...",
"..."
],
"unprocessedPathCount" : 12345,
"unprocessedPaths" : [
"...",
"..."
],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [
{},
{}
],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [
{},
{}
],
"creationErrorCount" : 12345,
"creationErrors" : [
{},
{}
],
"deletionErrorCount" : 12345,
"deletionErrors" : [
{},
{}
]
},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "DISABLED",
"roleStatus" : "STARTING"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
"children" : {
"items" : [
{},
{}
]
},
"canRetry" : true
},
"paused" : true
}
},
"description" : "The deleted snapshot policy."
}
}
},
"get" : {
"tags" : [
"SnapshotsResource"
],
"summary" : "Returns information for a specific snapshot policy.",
"description" : "Returns information for a specific snapshot policy.",
"operationId" : "readPolicy",
"produces" : [
"application/json"
],
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "policyName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : "Name of an existing snapshot policy."
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "view",
"in" : "query",
"default" : "summary",
"type" : "string",
"enum" : [
"EXPORT",
"EXPORT_REDACTED",
"FULL",
"FULL_WITH_HEALTH_CHECK_EXPLANATION",
"SUMMARY"
],
"description" : "The view to materialize."
}
],
"responses" : {
"200" : {
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiSnapshotPolicy"
},
"headers" : {},
"examples" : {
"application/json" : {
"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" : {
"tableRegExps" : [
"...",
"..."
],
"storage" : "LOCAL"
},
"hdfsArguments" : {
"pathPatterns" : [
"...",
"..."
]
},
"lastCommand" : {
"hbaseResult" : {
"processedTableCount" : 12345,
"processedTables" : [
"...",
"..."
],
"unprocessedTableCount" : 12345,
"unprocessedTables" : [
"...",
"..."
],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [
{},
{}
],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [
{},
{}
],
"creationErrorCount" : 12345,
"creationErrors" : [
{},
{}
],
"deletionErrorCount" : 12345,
"deletionErrors" : [
{},
{}
]
},
"hdfsResult" : {
"processedPathCount" : 12345,
"processedPaths" : [
"...",
"..."
],
"unprocessedPathCount" : 12345,
"unprocessedPaths" : [
"...",
"..."
],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [
{},
{}
],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [
{},
{}
],
"creationErrorCount" : 12345,
"creationErrors" : [
{},
{}
],
"deletionErrorCount" : 12345,
"deletionErrors" : [
{},
{}
]
},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "GOOD",
"roleStatus" : "STARTING"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
"children" : {
"items" : [
{},
{}
]
},
"canRetry" : true
},
"lastSuccessfulCommand" : {
"hbaseResult" : {
"processedTableCount" : 12345,
"processedTables" : [
"...",
"..."
],
"unprocessedTableCount" : 12345,
"unprocessedTables" : [
"...",
"..."
],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [
{},
{}
],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [
{},
{}
],
"creationErrorCount" : 12345,
"creationErrors" : [
{},
{}
],
"deletionErrorCount" : 12345,
"deletionErrors" : [
{},
{}
]
},
"hdfsResult" : {
"processedPathCount" : 12345,
"processedPaths" : [
"...",
"..."
],
"unprocessedPathCount" : 12345,
"unprocessedPaths" : [
"...",
"..."
],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [
{},
{}
],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [
{},
{}
],
"creationErrorCount" : 12345,
"creationErrors" : [
{},
{}
],
"deletionErrorCount" : 12345,
"deletionErrors" : [
{},
{}
]
},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "BAD",
"roleStatus" : "STARTED"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
"children" : {
"items" : [
{},
{}
]
},
"canRetry" : true
},
"paused" : true
}
},
"description" : "Snapshot policy."
}
}
},
"put" : {
"tags" : [
"SnapshotsResource"
],
"summary" : "Updates an existing snapshot policy.",
"description" : "Updates an existing snapshot policy.",
"operationId" : "updatePolicy",
"consumes" : [
"application/json"
],
"produces" : [
"application/json"
],
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "policyName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : "Name of an existing snapshot policy."
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "body",
"in" : "body",
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiSnapshotPolicy"
},
"description" : "Modified policy."
}
],
"responses" : {
"204" : {
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiSnapshotPolicy"
},
"headers" : {},
"examples" : {
"application/json" : {
"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" : {
"tableRegExps" : [
"...",
"..."
],
"storage" : "LOCAL"
},
"hdfsArguments" : {
"pathPatterns" : [
"...",
"..."
]
},
"lastCommand" : {
"hbaseResult" : {
"processedTableCount" : 12345,
"processedTables" : [
"...",
"..."
],
"unprocessedTableCount" : 12345,
"unprocessedTables" : [
"...",
"..."
],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [
{},
{}
],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [
{},
{}
],
"creationErrorCount" : 12345,
"creationErrors" : [
{},
{}
],
"deletionErrorCount" : 12345,
"deletionErrors" : [
{},
{}
]
},
"hdfsResult" : {
"processedPathCount" : 12345,
"processedPaths" : [
"...",
"..."
],
"unprocessedPathCount" : 12345,
"unprocessedPaths" : [
"...",
"..."
],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [
{},
{}
],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [
{},
{}
],
"creationErrorCount" : 12345,
"creationErrors" : [
{},
{}
],
"deletionErrorCount" : 12345,
"deletionErrors" : [
{},
{}
]
},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "BAD",
"roleStatus" : "NA"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
"children" : {
"items" : [
{},
{}
]
},
"canRetry" : true
},
"lastSuccessfulCommand" : {
"hbaseResult" : {
"processedTableCount" : 12345,
"processedTables" : [
"...",
"..."
],
"unprocessedTableCount" : 12345,
"unprocessedTables" : [
"...",
"..."
],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [
{},
{}
],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [
{},
{}
],
"creationErrorCount" : 12345,
"creationErrors" : [
{},
{}
],
"deletionErrorCount" : 12345,
"deletionErrors" : [
{},
{}
]
},
"hdfsResult" : {
"processedPathCount" : 12345,
"processedPaths" : [
"...",
"..."
],
"unprocessedPathCount" : 12345,
"unprocessedPaths" : [
"...",
"..."
],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [
{},
{}
],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [
{},
{}
],
"creationErrorCount" : 12345,
"creationErrors" : [
{},
{}
],
"deletionErrorCount" : 12345,
"deletionErrors" : [
{},
{}
]
},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "CONCERNING",
"roleStatus" : "HISTORY_NOT_AVAILABLE"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
"children" : {
"items" : [
{},
{}
]
},
"canRetry" : true
},
"paused" : true
}
},
"description" : "The snapshot policy after the update."
}
}
}
},
"/clusters/{clusterName}/services/{serviceName}/snapshots/policies/{policyName}/history" : {
"get" : {
"tags" : [
"SnapshotsResource"
],
"summary" : "Returns a list of commands triggered by a snapshot policy.",
"description" : "Returns a list of commands triggered by a snapshot policy.",
"operationId" : "readHistory",
"produces" : [
"application/json"
],
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "policyName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : "Name of an existing snapshot policy."
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : ""
},
{
"name" : "limit",
"in" : "query",
"default" : "20",
"type" : "integer",
"description" : "Maximum number of commands to retrieve."
},
{
"name" : "offset",
"in" : "query",
"default" : "0",
"type" : "integer",
"description" : "Index of first command to retrieve."
},
{
"name" : "view",
"in" : "query",
"default" : "summary",
"type" : "string",
"enum" : [
"EXPORT",
"EXPORT_REDACTED",
"FULL",
"FULL_WITH_HEALTH_CHECK_EXPLANATION",
"SUMMARY"
],
"description" : "The view to materialize."
}
],
"responses" : {
"200" : {
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiSnapshotCommandList"
},
"headers" : {},
"examples" : {
"application/json" : {
"items" : [
{
"hbaseResult" : {
"processedTableCount" : 12345,
"processedTables" : [
"...",
"..."
],
"unprocessedTableCount" : 12345,
"unprocessedTables" : [
"...",
"..."
],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [
{},
{}
],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [
{},
{}
],
"creationErrorCount" : 12345,
"creationErrors" : [
{},
{}
],
"deletionErrorCount" : 12345,
"deletionErrors" : [
{},
{}
]
},
"hdfsResult" : {
"processedPathCount" : 12345,
"processedPaths" : [
"...",
"..."
],
"unprocessedPathCount" : 12345,
"unprocessedPaths" : [
"...",
"..."
],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [
{},
{}
],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [
{},
{}
],
"creationErrorCount" : 12345,
"creationErrors" : [
{},
{}
],
"deletionErrorCount" : 12345,
"deletionErrors" : [
{},
{}
]
},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "NOT_AVAILABLE",
"roleStatus" : "UNKNOWN"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
"children" : {
"items" : [
{},
{}
]
},
"canRetry" : true
},
{
"hbaseResult" : {
"processedTableCount" : 12345,
"processedTables" : [
"...",
"..."
],
"unprocessedTableCount" : 12345,
"unprocessedTables" : [
"...",
"..."
],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [
{},
{}
],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [
{},
{}
],
"creationErrorCount" : 12345,
"creationErrors" : [
{},
{}
],
"deletionErrorCount" : 12345,
"deletionErrors" : [
{},
{}
]
},
"hdfsResult" : {
"processedPathCount" : 12345,
"processedPaths" : [
"...",
"..."
],
"unprocessedPathCount" : 12345,
"unprocessedPaths" : [
"...",
"..."
],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [
{},
{}
],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [
{},
{}
],
"creationErrorCount" : 12345,
"creationErrors" : [
{},
{}
],
"deletionErrorCount" : 12345,
"deletionErrors" : [
{},
{}
]
},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "CONCERNING",
"roleStatus" : "BUSY"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {},
"serviceRef" : {},
"roleRef" : {},
"hostRef" : {},
"parent" : {},
"children" : {},
"canRetry" : true
},
"children" : {
"items" : [
{},
{}
]
},
"canRetry" : true
}
]
}
},
"description" : "List of commands for the policy."
}
}
}
},
"/tags" : {
"get" : {
"tags" : [
"TagsResource"
],
"summary" : "Current CM entities and their tags.",
"description" : "Current CM entities and their tags. Tag names beginning with the prefix _cldr_\n(case insensitive) are reserved for internal use by Cloudera.",
"operationId" : "getTags",
"produces" : [
"application/json"
],
"parameters" : [
{
"name" : "limit",
"in" : "query",
"default" : "10",
"type" : "integer",
"description" : "Number of tags to search for. Maximum value for limit is 1000."
},
{
"name" : "offset",
"in" : "query",
"default" : "0",
"type" : "integer",
"description" : "Starting index of the list"
}
],
"responses" : {
"200" : {
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiTagToEntitiesList"
},
"headers" : {},
"examples" : {
"application/json" : {
"items" : [
{
"name" : "...",
"value" : "...",
"apiClusterRefs" : [
{
"clusterName" : "...",
"displayName" : "..."
},
{
"clusterName" : "...",
"displayName" : "..."
}
],
"apiServiceRefs" : [
{
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
{
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
}
],
"apiRoleRefs" : [
{
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "HISTORY_NOT_AVAILABLE",
"roleStatus" : "STARTING"
},
{
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "NOT_AVAILABLE",
"roleStatus" : "STOPPING"
}
],
"apiHostRefs" : [
{
"hostId" : "...",
"hostname" : "..."
},
{
"hostId" : "...",
"hostname" : "..."
}
],
"apiControlPlaneRefs" : [
{
"uuid" : "..."
},
{
"uuid" : "..."
}
]
},
{
"name" : "...",
"value" : "...",
"apiClusterRefs" : [
{
"clusterName" : "...",
"displayName" : "..."
},
{
"clusterName" : "...",
"displayName" : "..."
}
],
"apiServiceRefs" : [
{
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
{
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
}
],
"apiRoleRefs" : [
{
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "DISABLED",
"roleStatus" : "HISTORY_NOT_AVAILABLE"
},
{
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "BAD",
"roleStatus" : "NA"
}
],
"apiHostRefs" : [
{
"hostId" : "...",
"hostname" : "..."
},
{
"hostId" : "...",
"hostname" : "..."
}
],
"apiControlPlaneRefs" : [
{
"uuid" : "..."
},
{
"uuid" : "..."
}
]
}
]
}
},
"description" : "Detailed description of the current CM entities and their tags."
}
}
}
},
"/tags/{tagName}" : {
"get" : {
"tags" : [
"TagsResource"
],
"summary" : "Get Entities given the Tag name, grouped by entity type.",
"description" : "Get Entities given the Tag name, grouped by entity type.",
"operationId" : "readTagsByName",
"produces" : [
"application/json"
],
"parameters" : [
{
"name" : "tagName",
"in" : "path",
"required" : true,
"type" : "string",
"description" : "Name of the tag"
},
{
"name" : "limit",
"in" : "query",
"default" : "10",
"type" : "integer",
"description" : "Number of entries to search for. Maximum value for limit is 1000."
},
{
"name" : "offset",
"in" : "query",
"default" : "0",
"type" : "integer",
"description" : "Starting index of the list"
}
],
"responses" : {
"200" : {
"schema" : {
"description" : "",
"$ref" : "#/definitions/ApiTagToEntitiesList"
},
"headers" : {},
"examples" : {
"application/json" : {
"items" : [
{
"name" : "...",
"value" : "...",
"apiClusterRefs" : [
{
"clusterName" : "...",
"displayName" : "..."
},
{
"clusterName" : "...",
"displayName" : "..."
}
],
"apiServiceRefs" : [
{
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
{
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
}
],
"apiRoleRefs" : [
{
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "BAD",
"roleStatus" : "UNKNOWN"
},
{
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "GOOD",
"roleStatus" : "UNKNOWN"
}
],
"apiHostRefs" : [
{
"hostId" : "...",
"hostname" : "..."
},
{
"hostId" : "...",
"hostname" : "..."
}
],
"apiControlPlaneRefs" : [
{
"uuid" : "..."
},
{
"uuid" : "..."
}
]
},
{
"name" : "...",
"value" : "...",
"apiClusterRefs" : [
{
"clusterName" : "...",
"displayName" : "..."
},
{
"clusterName" : "...",
"displayName" : "..."
}
],
"apiServiceRefs" : [
{
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
{
"peerName" : "...",
"clusterName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
}
],
"apiRoleRefs" : [
{
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "CONCERNING",
"roleStatus" : "STARTING"
},
{
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "NOT_AVAILABLE",
"roleStatus" : "HISTORY_NOT_AVAILABLE"
}
],
"apiHostRefs" : [
{
"hostId" : "...",
"hostname" : "..."
},
{
"hostId" : "...",
"hostname" : "..."
}
],
"apiControlPlaneRefs" : [
{
"uuid" : "..."
},
{
"uuid" : "..."
}
]
}
]
}
},
"description" : "Get CM Entities associated with the provided tag."
}
}
}
},
"/timeseries" : {
"get" : {
"tags" : [
"TimeSeriesResource"
],
"summary" : "Retrieve time-series data from the Cloudera Manager (CM) time-series\ndata store using a tsquery.",
"description" : "Retrieve time-series data from the Cloudera Manager (CM) time-series\ndata store using a tsquery.\n\nPlease see the\n\ntsquery language documentation.\n
\n {\n \"message\": \"An error message\",\n \"causes\": [ \"A list of causes\", \"Potentially null\" ]\n }\n \n\nThe message field contains a description of the error.\nThe causes field, if not null, contains a list of causes\nfor the error.\n
\n\nNote that this never returns an echoMessage.\nInstead, the result (and all error results) has the above structure.\n
", "operationId" : "echoError", "produces" : [ "application/json" ], "parameters" : [ { "name" : "message", "in" : "query", "default" : "Default error message", "type" : "string", "description" : "The error message to echo" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiEcho" }, "headers" : {}, "examples" : { "application/json" : { "message" : "..." } }, "description" : "Will always be an exception" } } } }, "/users" : { "get" : { "tags" : [ "UsersResource" ], "summary" : "Returns a list of the user names configured in the system.", "description" : "Returns a list of the user names configured in the system.", "operationId" : "readUsers2", "produces" : [ "application/json" ], "parameters" : [ { "name" : "view", "in" : "query", "default" : "summary", "type" : "string", "enum" : [ "EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "SUMMARY" ], "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiUser2List" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "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 } ] } }, "description" : "A list of users." } } }, "post" : { "tags" : [ "UsersResource" ], "summary" : "Creates a list of users.", "description" : "Creates a list of users.\n\nWhen creating new users, the password property of each user should\nbe their plain text password. The returned user information will not\ncontain any password information.\n
", "operationId" : "createUsers2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiUser2List" }, "description" : "List of users to create." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiUser2List" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "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 } ] } }, "description" : "Information about created users." } } } }, "/users/sessions" : { "get" : { "tags" : [ "UsersResource" ], "summary" : "Return a list of the sessions associated with interactive authenticated\nusers in Cloudera Manager.", "description" : "Return a list of the sessions associated with interactive authenticated\nusers in Cloudera Manager.\n\nNote that these sessions are only associated with users who log into the\nweb interface. API users will not appear.", "operationId" : "getSessions", "produces" : [ "application/json" ], "parameters" : [], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiUserSessionList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "remoteAddr" : "...", "lastRequest" : "..." }, { "name" : "...", "remoteAddr" : "...", "lastRequest" : "..." } ] } }, "description" : "A list of user sessions" } } } }, "/users/{userName}" : { "delete" : { "tags" : [ "UsersResource" ], "summary" : "Deletes a user from the system.", "description" : "Deletes a user from the system.\n
", "operationId" : "deleteUser2", "produces" : [ "application/json" ], "parameters" : [ { "name" : "userName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the user to delete." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiUser2" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "password" : "...", "authRoles" : [ { "displayName" : "...", "name" : "...", "uuid" : "..." }, { "displayName" : "...", "name" : "...", "uuid" : "..." } ], "pwHash" : "...", "pwSalt" : 12345, "pwLogin" : true } }, "description" : "The details of the deleted user." } } }, "get" : { "tags" : [ "UsersResource" ], "summary" : "Returns detailed information about a user.", "description" : "Returns detailed information about a user.", "operationId" : "readUser2", "produces" : [ "application/json" ], "parameters" : [ { "name" : "userName", "in" : "path", "required" : true, "type" : "string", "description" : "The user to read." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiUser2" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "password" : "...", "authRoles" : [ { "displayName" : "...", "name" : "...", "uuid" : "..." }, { "displayName" : "...", "name" : "...", "uuid" : "..." } ], "pwHash" : "...", "pwSalt" : 12345, "pwLogin" : true } }, "description" : "The user's information." } } }, "put" : { "tags" : [ "UsersResource" ], "summary" : "Updates the given user's information.", "description" : "Updates the given user's information. Note that the user's name cannot\nbe changed.", "operationId" : "updateUser2", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "userName", "in" : "path", "required" : true, "type" : "string", "description" : "User name being updated." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiUser2" }, "description" : "The user information." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiUser2" }, "headers" : {}, "examples" : { "application/json" : { "name" : "...", "password" : "...", "authRoles" : [ { "displayName" : "...", "name" : "...", "uuid" : "..." }, { "displayName" : "...", "name" : "...", "uuid" : "..." } ], "pwHash" : "...", "pwSalt" : 12345, "pwLogin" : true } }, "description" : "" } } } }, "/users/expireSessions/{userName}" : { "post" : { "tags" : [ "UsersResource" ], "summary" : "Expires the sessions associated with interactive authenticated\nuser in Cloudera Manager.", "description" : "Expires the sessions associated with interactive authenticated\nuser in Cloudera Manager. This can be used by Full Admin/User Admin users only.\n\nNote that these sessions are only associated with a user who log into the\nweb interface. Sessions of an API user will not be affected.", "operationId" : "expireSessions", "parameters" : [ { "name" : "userName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "201" : { "headers" : {}, "examples" : {}, "description" : "Success" } } } }, "/clusters/{clusterName}/services/{serviceName}/watcheddir" : { "get" : { "tags" : [ "WatchedDirResource" ], "summary" : "Lists all the watched directories.", "description" : "Lists all the watched directories.\n
\nAvailable since API v14. Only available with Cloudera Manager Enterprise\nEdition.\n
", "operationId" : "listWatchedDirectories", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiWatchedDirList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "path" : "..." }, { "path" : "..." } ] } }, "description" : "List of currently watched directories." } } }, "post" : { "tags" : [ "WatchedDirResource" ], "summary" : "Adds a directory to the watching list.", "description" : "Adds a directory to the watching list.\n
\nAvailable since API v14. Only available with Cloudera Manager Enterprise\nEdition.\n
", "operationId" : "addWatchedDirectory", "consumes" : [ "application/json" ], "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." }, { "name" : "body", "in" : "body", "schema" : { "description" : "", "$ref" : "#/definitions/ApiWatchedDir" }, "description" : "The directory to be added." } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiWatchedDir" }, "headers" : {}, "examples" : { "application/json" : { "path" : "..." } }, "description" : "Added directory." } } } }, "/clusters/{clusterName}/services/{serviceName}/watcheddir/{directoryPath}" : { "delete" : { "tags" : [ "WatchedDirResource" ], "summary" : "Removes a directory from the watching list.", "description" : "Removes a directory from the watching list.\n
\nAvailable since API v14. Only available with Cloudera Manager Enterprise\nEdition.\n
", "operationId" : "removeWatchedDirectory", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "directoryPath", "in" : "path", "required" : true, "type" : "string", "description" : "The directory path to be removed." }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The service name." } ], "responses" : { "204" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiWatchedDir" }, "headers" : {}, "examples" : { "application/json" : { "path" : "..." } }, "description" : "Removed directory." } } } }, "/clusters/{clusterName}/services/{serviceName}/yarnApplications" : { "get" : { "tags" : [ "YarnApplicationsResource" ], "summary" : "Returns a list of applications that satisfy the filter.", "description" : "Returns a list of applications that satisfy the filter\n
\nAvailable since API v6.", "operationId" : "getYarnApplications", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the service" }, { "name" : "filter", "in" : "query", "default" : "", "type" : "string", "description" : "A filter to apply to the applications. A basic filter tests the\nvalue of an attribute and looks something like 'executing = true' or\n'user = root'. Multiple basic filters can be combined into a complex\nexpression using standard and / or boolean logic and parenthesis.\nAn example of a complex filter is: 'application_duration > 5s and (user = root or\nuser = myUserName')." }, { "name" : "from", "in" : "query", "type" : "string", "description" : "Start of the period to query in ISO 8601 format (defaults to 5\nminutes before the 'to' time)." }, { "name" : "limit", "in" : "query", "default" : "100", "type" : "integer", "description" : "The maximum number of applications to return. Applications will be\nreturned in the following order:\n
\nExamples of attributes include the user who ran the application and the\nnumber of maps completed by the application.\n
\nThese attributes can be used to search for specific YARN applications through\nthe getYarnApplications API. For example the 'user' attribute could be used\nin the search 'user = root'. If the attribute is numeric it can also be used\nas a metric in a tsquery (ie, 'select maps_completed from YARN_APPLICATIONS').\n
\nNote that this response is identical for all YARN services.\n
\nAvailable since API v6.", "operationId" : "getYarnApplicationAttributes", "produces" : [ "application/json" ], "parameters" : [ { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "" } ], "responses" : { "200" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiYarnApplicationAttributeList" }, "headers" : {}, "examples" : { "application/json" : { "items" : [ { "name" : "...", "type" : "...", "displayName" : "...", "supportsHistograms" : true, "description" : "..." }, { "name" : "...", "type" : "...", "displayName" : "...", "supportsHistograms" : true, "description" : "..." } ] } }, "description" : "" } } } }, "/clusters/{clusterName}/services/{serviceName}/yarnApplications/{applicationId}/kill" : { "post" : { "tags" : [ "YarnApplicationsResource" ], "summary" : "Kills an YARN Application.", "description" : "Kills an YARN Application\n
\nAvailable since API v6.", "operationId" : "killYarnApplication", "produces" : [ "application/json" ], "parameters" : [ { "name" : "applicationId", "in" : "path", "required" : true, "type" : "string", "description" : "The applicationId to kill" }, { "name" : "clusterName", "in" : "path", "required" : true, "type" : "string", "description" : "" }, { "name" : "serviceName", "in" : "path", "required" : true, "type" : "string", "description" : "The name of the service" } ], "responses" : { "201" : { "schema" : { "description" : "", "$ref" : "#/definitions/ApiYarnKillResponse" }, "headers" : {}, "examples" : { "application/json" : { "warning" : "..." } }, "description" : "A warning if there was one. Otherwise null." } } } } } }