Introduced in Cloudera Manager 7.13.2<\/p>\n
Cloudera Product Documentation<\/a><\/p>",
"version" : "7.13.2",
"title" : "Cloudera Manager API"
},
"servers": [
{
"url": "/api/v58"
}
],
"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"
}
,
{
"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"
}
,
{
"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"
}
,
{
"name" : "ExternalUserMappingsResource"
}
,
{
"name" : "HostTemplatesResource"
}
,
{
"name" : "HostsResource"
}
,
{
"name" : "ImpalaQueriesResource"
}
,
{
"name" : "MgmtRoleCommandsResource"
}
,
{
"name" : "MgmtRoleConfigGroupsResource"
}
,
{
"name" : "MgmtRolesResource"
}
,
{
"name" : "MgmtServiceResource"
}
,
{
"name" : "NameservicesResource"
}
,
{
"name" : "ParcelResource"
}
,
{
"name" : "ParcelsResource"
}
,
{
"name" : "ProcessResource"
}
,
{
"name" : "ReplicationsResource"
}
,
{
"name" : "RoleCommandsResource"
}
,
{
"name" : "RoleConfigGroupsResource"
}
,
{
"name" : "RolesResource"
}
,
{
"name" : "ServicesResource"
}
,
{
"name" : "SnapshotsResource"
}
,
{
"name" : "TagsResource"
}
,
{
"name" : "TimeSeriesResource"
}
,
{
"name" : "ToolsResource"
}
,
{
"name" : "UsersResource"
}
,
{
"name" : "WatchedDirResource"
}
,
{
"name" : "YarnApplicationsResource"
}
],
"components" : {
"schemas" : {
"ApiActivity" : {
"type" : "object",
"title" : "ApiActivity",
"properties" : {
"name" : {
"readOnly" : false,
"description" : "Activity name.",
"type" : "string"
},
"type" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiActivityType"
},
"parent" : {
"readOnly" : false,
"description" : "The name of the parent activity.",
"type" : "string"
},
"startTime" : {
"readOnly" : false,
"description" : "The start time of this activity.",
"type" : "string",
"format" : "date-time"
},
"finishTime" : {
"readOnly" : false,
"description" : "The finish time of this activity.",
"type" : "string",
"format" : "date-time"
},
"id" : {
"readOnly" : false,
"description" : "Activity id, which is unique within a MapReduce service.",
"type" : "string"
},
"status" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiActivityStatus"
},
"user" : {
"readOnly" : false,
"description" : "The user who submitted this activity.",
"type" : "string"
},
"group" : {
"readOnly" : false,
"description" : "The user-group of this activity.",
"type" : "string"
},
"inputDir" : {
"readOnly" : false,
"description" : "The input data directory of the activity. An HDFS url.",
"type" : "string"
},
"outputDir" : {
"readOnly" : false,
"description" : "The output result directory of the activity. An HDFS url.",
"type" : "string"
},
"mapper" : {
"readOnly" : false,
"description" : "The mapper class.",
"type" : "string"
},
"combiner" : {
"readOnly" : false,
"description" : "The combiner class.",
"type" : "string"
},
"reducer" : {
"readOnly" : false,
"description" : "The reducer class.",
"type" : "string"
},
"queueName" : {
"readOnly" : false,
"description" : "The scheduler queue this activity is in.",
"type" : "string"
},
"schedulerPriority" : {
"readOnly" : false,
"description" : "The scheduler priority of this activity.",
"type" : "string"
}
},
"example" : {
"name" : "...",
"type" : "MR",
"parent" : "...",
"startTime" : "...",
"finishTime" : "...",
"id" : "...",
"status" : "STARTED",
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiActivity"
}
}
}
}
],
"example" : {
"items" : [ {
"name" : "...",
"type" : "PIG",
"parent" : "...",
"startTime" : "...",
"finishTime" : "...",
"id" : "...",
"status" : "KILLED",
"user" : "...",
"group" : "...",
"inputDir" : "...",
"outputDir" : "...",
"mapper" : "...",
"combiner" : "...",
"reducer" : "...",
"queueName" : "...",
"schedulerPriority" : "..."
}, {
"name" : "...",
"type" : "UNKNOWN",
"parent" : "...",
"startTime" : "...",
"finishTime" : "...",
"id" : "...",
"status" : "UNKNOWN",
"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",
"readOnly" : false,
"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,
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "The name of the NameService to which the new NameNode(s) should be added.",
"type" : "string"
},
"newNNHostIds" : {
"readOnly" : false,
"description" : "List of host ids to which new NameNode(s) should be added.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"newNNDataDirs" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"sourceTable" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"sourceSchedulerPool" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"sourceService" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiServiceRef"
},
"sourceNumMappers" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int32"
},
"sourceBandwidthPerMap" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int32"
},
"exportSnapshotUser" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"sourceAccount" : "...",
"sourceTable" : "...",
"sourceSchedulerPool" : "...",
"sourceService" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"sourceNumMappers" : 12345,
"sourceBandwidthPerMap" : 12345,
"exportSnapshotUser" : "..."
},
"description" : "An HBase snapshot descriptor."
}
,
"ApiAdhocSnapshot" : {
"type" : "object",
"title" : "ApiAdhocSnapshot",
"properties" : {
"snapshotName" : {
"readOnly" : false,
"description" : "Snapshot name.",
"type" : "string"
},
"hbaseSnapshot" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiAdhocHBaseSnapshot"
}
},
"example" : {
"snapshotName" : "...",
"hbaseSnapshot" : {
"sourceAccount" : "...",
"sourceTable" : "...",
"sourceSchedulerPool" : "...",
"sourceService" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"sourceNumMappers" : 12345,
"sourceBandwidthPerMap" : 12345,
"exportSnapshotUser" : "..."
}
},
"description" : "An adhoc snapshot descriptor."
}
,
"ApiAtlasEntityTypes" : {
"type" : "object",
"title" : "ApiAtlasEntityTypes",
"properties" : {
"name" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"serviceType" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"category" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"name" : "...",
"serviceType" : "...",
"category" : "..."
},
"description" : "Holds information about Atlas Entities defined in Atlas Service."
}
,
"ApiAtlasReplicationArguments" : {
"type" : "object",
"title" : "ApiAtlasReplicationArguments",
"required" : ["skipLineage"],
"properties" : {
"sourceService" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiServiceRef"
},
"sourceStorageFilter" : {
"readOnly" : false,
"$ref" : "#/components/schemas/SourceStorageFilter"
},
"policyName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"stagingDir" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"atlasEntityRegexPattern" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"safetyValvesTarget" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/IcebergReplicationSafetyValve"
}
},
"matchType" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"atlasEntityType" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"type" : "string"
}
},
"skipLineage" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"fetchType" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"atlasClientAdvanceConfigs" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"example" : {
"sourceService" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"sourceStorageFilter" : "HDFS",
"policyName" : "...",
"stagingDir" : "...",
"atlasEntityRegexPattern" : "...",
"safetyValvesTarget" : {
"property1" : {
"configs" : [ {
"key" : "...",
"value" : "..."
}, {
"key" : "...",
"value" : "..."
} ]
},
"property2" : {
"configs" : [ {
"key" : "...",
"value" : "..."
}, {
"key" : "...",
"value" : "..."
} ]
}
},
"matchType" : "...",
"atlasEntityType" : [ "...", "..." ],
"skipLineage" : true,
"fetchType" : "...",
"atlasClientAdvanceConfigs" : {
"property1" : "...",
"property2" : "..."
}
},
"description" : ""
}
,
"ApiAtlasReplicationRemoteArgs" : {
"type" : "object",
"title" : "ApiAtlasReplicationRemoteArgs",
"required" : ["skipLineage"],
"properties" : {
"sourceService" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiServiceRef"
},
"safetyValvesSource" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/IcebergReplicationSafetyValve"
}
},
"altStagingLocation" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"sourceStorageFilter" : {
"readOnly" : false,
"$ref" : "#/components/schemas/SourceStorageFilter"
},
"locationMapping" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiMapEntry"
}
},
"policyOptions" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"atlasClientAdvanceConfigs" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"stagingDir" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"matchType" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"atlasEntityRegexPattern" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"atlasEntityType" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"type" : "string"
}
},
"fetchType" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"skipLineage" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"atlasChangeMarker" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"tableTypeForAtlas" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"hiveReplicationTableFilters" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHiveReplicationTableFilters"
},
"icebergReplicationTableFilters" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiIcebergReplicationTableFilters"
},
"hdfsReplicationSourcePath" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHdfsReplicationSourcePath"
}
},
"example" : {
"sourceService" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"safetyValvesSource" : {
"property1" : {
"configs" : [ {
"key" : "...",
"value" : "..."
}, {
"key" : "...",
"value" : "..."
} ]
},
"property2" : {
"configs" : [ {
"key" : "...",
"value" : "..."
}, {
"key" : "...",
"value" : "..."
} ]
}
},
"altStagingLocation" : "...",
"sourceStorageFilter" : "S3",
"locationMapping" : [ {
"key" : "...",
"value" : "..."
}, {
"key" : "...",
"value" : "..."
} ],
"policyOptions" : {
"property1" : "...",
"property2" : "..."
},
"atlasClientAdvanceConfigs" : {
"property1" : "...",
"property2" : "..."
},
"stagingDir" : "...",
"matchType" : "...",
"atlasEntityRegexPattern" : "...",
"atlasEntityType" : [ "...", "..." ],
"fetchType" : "...",
"skipLineage" : true,
"atlasChangeMarker" : "...",
"tableTypeForAtlas" : "...",
"hiveReplicationTableFilters" : {
"tableFilters" : [ {
"database" : "...",
"tableName" : "..."
}, {
"database" : "...",
"tableName" : "..."
} ]
},
"icebergReplicationTableFilters" : {
"includedTableFilters" : [ {
"database" : "...",
"tableName" : "..."
}, {
"database" : "...",
"tableName" : "..."
} ],
"excludedTableFilters" : [ {
"database" : "...",
"tableName" : "..."
}, {
"database" : "...",
"tableName" : "..."
} ]
},
"hdfsReplicationSourcePath" : {
"sourcePath" : "...",
"exclusionFilters" : [ "...", "..." ]
}
},
"description" : ""
}
,
"ApiAtlasReplicationResult" : {
"type" : "object",
"title" : "ApiAtlasReplicationResult",
"required" : ["exportStartTime", "exportEndTime", "importStartTime", "importEndTime"],
"properties" : {
"numberOfEntitiesReplicated" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int32"
},
"exportStatus" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"importStatus" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"exportStartTime" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int64"
},
"exportEndTime" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int64"
},
"importStartTime" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int64"
},
"importEndTime" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int64"
}
},
"example" : {
"numberOfEntitiesReplicated" : 12345,
"exportStatus" : "...",
"importStatus" : "...",
"exportStartTime" : 12345,
"exportEndTime" : 12345,
"importStartTime" : 12345,
"importEndTime" : 12345
},
"description" : ""
}
,
"ApiAudit" : {
"type" : "object",
"title" : "ApiAudit",
"properties" : {
"timestamp" : {
"readOnly" : false,
"description" : "When the audit event was captured.",
"type" : "string",
"format" : "date-time"
},
"service" : {
"readOnly" : false,
"description" : "Service name associated with this audit.",
"type" : "string"
},
"username" : {
"readOnly" : false,
"description" : "The user who performed this operation.",
"type" : "string"
},
"impersonator" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The IP address that the client connected from.",
"type" : "string"
},
"command" : {
"readOnly" : false,
"description" : "The command/operation that was requested.",
"type" : "string"
},
"resource" : {
"readOnly" : false,
"description" : "The resource that the operation was performed on.",
"type" : "string"
},
"operationText" : {
"readOnly" : false,
"description" : "The full text of the requested operation. E.g. the full Hive query.\n \nAvailable since API v5.",
"type" : "string"
},
"allowed" : {
"readOnly" : false,
"description" : "Whether the operation was allowed or denied by the authorization system.",
"type" : "boolean"
},
"serviceValues" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"name" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"clusters" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiClusterRef"
}
},
"users" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiUser2Ref"
}
},
"externalUserMappings" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiExternalUserMappingRef"
}
},
"baseRole" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiAuthRoleRef"
},
"uuid" : {
"readOnly" : false,
"description" : "Readonly. The UUID of the authRole.\n ",
"type" : "string"
},
"isCustom" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
}
},
"example" : {
"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
},
"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" : {
"readOnly" : false,
"description" : "The name of the authority.",
"type" : "string"
},
"description" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiAuthRole"
}
}
}
}
],
"example" : {
"items" : [ {
"displayName" : "...",
"name" : "...",
"clusters" : [ {
"clusterName" : "...",
"displayName" : "..."
}, {
"clusterName" : "...",
"displayName" : "..."
} ],
"users" : [ {
"name" : "..."
}, {
"name" : "..."
} ],
"externalUserMappings" : [ {
"uuid" : "...",
"name" : "...",
"type" : "EXTERNAL_PROGRAM"
}, {
"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" : "LDAP"
}, {
"uuid" : "...",
"name" : "...",
"type" : "EXTERNAL_PROGRAM"
} ],
"baseRole" : {
"displayName" : "...",
"name" : "...",
"uuid" : "..."
},
"uuid" : "...",
"isCustom" : true
} ]
},
"description" : "A list of auth roles."
}
,
"ApiAuthRoleMetadata" : {
"type" : "object",
"title" : "ApiAuthRoleMetadata",
"properties" : {
"displayName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"uuid" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"role" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"authorities" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiAuthRoleAuthority"
}
},
"allowedScopes" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "The display name of the authRole.\ndisplayName is optional. If a changed displayName is passed\nin, it will be ignored.",
"type" : "string"
},
"name" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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"
}
,
"ApiAwsDataSyncTaskArgs" : {
"type" : "object",
"title" : "ApiAwsDataSyncTaskArgs",
"properties" : {
"sourceLocation" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiAwsS3Location"
},
"destinationLocation" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiAwsS3Location"
},
"name" : {
"readOnly" : false,
"description" : "The name of the AWS DataSync task. If not given, then DataSync will give a name to it.",
"type" : "string"
},
"excludeFilters" : {
"readOnly" : false,
"description" : "Specifies exclude filters that define the files, objects, and folders in the source location\nthat DataSync won't transfer. For more information and examples, see:\n\nSpecifying what DataSync transfers by using filters\n<\/a>.\n \nNote that:\n \nNote that:\n \nTags<\/i> are like labels that can help manage, filter, and search for AWS resources.\nHaving it as a Map provides more flexibility and categorization, for instance:\n \nDEFAULT<\/b>: true \nDEFAULT<\/b>: true \nDEFAULT<\/b>: true",
"type" : "boolean"
},
"preserveGroupId" : {
"readOnly" : false,
"description" : "Specifies whether to preserve the POSIX group ID (GID) of the file's owner.\n \nDEFAULT<\/b>: true",
"type" : "boolean"
},
"preserveDeletedFiles" : {
"readOnly" : false,
"description" : "Specifies whether files in the destination location,\nthat don't exist in the source, should be preserved.\n \nThis option can affect the Amazon S3 storage cost. If the task deletes objects, then\nit might incur minimum storage duration charges for certain storage classes.\nFor detailed information, see:\n \nNote that if this parameter is set to false, then\n#transferMode cannot be set to TransferMode#ALL.\nWhen transferring all data, then DataSync doesn't scan the destination location\nand doesn't know what to delete.\n \nDEFAULT<\/b>: true",
"type" : "boolean"
},
"preserveDevices" : {
"readOnly" : false,
"description" : "Specifies whether DataSync should preserve the metadata of block and character devices\nin the source location and recreate the files with that device name and metadata\non the destination. DataSync copies only the name and metadata of such devices.\n \nDataSync can't copy the actual contents of these devices because they're nonterminal and\ndon't return an end-of-file (EOF) marker.\n \nDEFAULT<\/b>: false",
"type" : "boolean"
},
"preservePosixPermissions" : {
"readOnly" : false,
"description" : "Specifies whether DataSync should preserve POSIX-style permissions\n(which users or groups can access a file for a specific purpose such as\nreading, writing, or execution of the file).\n \nDEFAULT<\/b>: true",
"type" : "boolean"
},
"preserveObjectTags" : {
"readOnly" : false,
"description" : "Specifies whether to preserve object tags when transferring between object storage systems.\n \nDEFAULT<\/b>: true",
"type" : "boolean"
},
"bytesPerSecond" : {
"readOnly" : false,
"description" : "Limits the bandwidth used by a DataSync task. For example: \nDEFAULT<\/b>: null",
"type" : "integer",
"format" : "int64"
},
"taskQueueing" : {
"readOnly" : false,
"description" : "Specifies whether the transfer tasks should be put into a queue during certain scenarios when\n \nDEFAULT<\/b>: true",
"type" : "boolean"
}
},
"example" : {
"transferMode" : "CHANGED",
"verifyMode" : "NONE",
"overwriteMode" : "ALWAYS",
"preserveAtime" : true,
"preserveMtime" : true,
"preserveUserId" : true,
"preserveGroupId" : true,
"preserveDeletedFiles" : true,
"preserveDevices" : true,
"preservePosixPermissions" : true,
"preserveObjectTags" : true,
"bytesPerSecond" : 12345,
"taskQueueing" : true
},
"description" : "Options to be used for the AWS DataSync task.\nEquivalent of com.amazonaws.services.datasync.model.Options,\nbut it might not contain every possible option."
}
,
"ApiAwsDataSyncTaskSchedule" : {
"type" : "object",
"title" : "ApiAwsDataSyncTaskSchedule",
"properties" : {
"scheduleExpression" : {
"readOnly" : false,
"description" : "Specifies the task schedule by using a cron expression in UTC time.\nFor information about cron expression syntax, see the\n\nAmazon EventBridge User Guide\n<\/a>.\n \nDEFAULT<\/b>: null",
"type" : "string"
}
},
"example" : {
"scheduleExpression" : "..."
},
"description" : "Schedule to be used for the AWS DataSync task.\nEquivalent of com.amazonaws.services.datasync.model.TaskSchedule,\nbut might not contain every possible option."
}
,
"ApiAwsS3Location" : {
"type" : "object",
"title" : "ApiAwsS3Location",
"properties" : {
"s3Path" : {
"readOnly" : false,
"description" : "The S3 path for the location, for example: \"s3a://bucket/some/key\".",
"type" : "string"
},
"iamRoleArn" : {
"readOnly" : false,
"description" : "The IAM role ARN for the location, to be assumed to access the location.\nIf not provided then the caller identity role ARN will be used,\nthe one that is used to run CM.",
"type" : "string"
}
},
"example" : {
"s3Path" : "...",
"iamRoleArn" : "..."
},
"description" : "Specifies an AWS S3 location object, which encapsulates the\nS3 path and the IAM role to be assumed by the DataSync task to access the S3 path."
}
,
"ApiBatchRequest" : {
"type" : "object",
"title" : "ApiBatchRequest",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiBatchRequestElement"
}
}
}
}
],
"example" : {
"items" : [ {
"method" : "PUT",
"url" : "...",
"body" : { },
"contentType" : "...",
"acceptType" : "..."
}, {
"method" : "PUT",
"url" : "...",
"body" : { },
"contentType" : "...",
"acceptType" : "..."
} ]
},
"description" : "A batch request, comprised of one or more request elements."
}
,
"ApiBatchRequestElement" : {
"type" : "object",
"title" : "ApiBatchRequestElement",
"properties" : {
"method" : {
"readOnly" : false,
"$ref" : "#/components/schemas/HTTPMethod"
},
"url" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : "PUT",
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiBatchResponseElement"
}
},
"success" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Read-only. The HTTP status code of the response.",
"type" : "integer",
"format" : "int32"
},
"response" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiCommandList"
},
{
"properties" : {
"errors" : {
"readOnly" : false,
"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" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "BAD",
"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" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "HISTORY_NOT_AVAILABLE",
"roleStatus" : "STARTING"
},
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiRollingUpgradeClusterArgs"
},
"deployClientConfig" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Get the hostname of the host requesting certificates",
"type" : "string"
},
"csr" : {
"readOnly" : false,
"description" : "Get the certificate signing request in PEM format",
"type" : "string"
},
"token" : {
"readOnly" : false,
"description" : "Get the certificate request token",
"type" : "string"
},
"subjectAltNames" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The display name of the cluster that is shown in the UI.\n \nAvailable since API v6.",
"type" : "string"
},
"version" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiClusterVersion"
},
"fullVersion" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Readonly. Whether the cluster is in maintenance mode.\nAvailable since API v2.",
"type" : "boolean"
},
"maintenanceOwners" : {
"readOnly" : false,
"description" : "Readonly. The list of objects that trigger this cluster to be in\nmaintenance mode.\nAvailable since API v2.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiEntityType"
}
},
"services" : {
"readOnly" : false,
"description" : "Optional. Used during import/export of settings.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiService"
}
},
"parcels" : {
"readOnly" : false,
"description" : "Optional. Used during import/export of settings.\nAvailable since API v4.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiParcel"
}
},
"clusterUrl" : {
"readOnly" : false,
"description" : "Readonly. Link into the Cloudera Manager web UI for this specific cluster.\n \nAvailable since API v10.",
"type" : "string"
},
"hostsUrl" : {
"readOnly" : false,
"description" : "Readonly. Link into the Cloudera Manager web UI for host table for this cluster.\n \nAvailable since API v11.",
"type" : "string"
},
"entityStatus" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiEntityStatus"
},
"uuid" : {
"readOnly" : false,
"description" : "Readonly. The UUID of the cluster.\n \nAvailable since API v15.",
"type" : "string"
},
"dataContextRefs" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiDataContextRef"
}
},
"clusterType" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Tags associated with the cluster.\nAvailable since V41.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiEntityTag"
}
}
},
"example" : {
"name" : "...",
"displayName" : "...",
"fullVersion" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CONTROL_PLANE", "SERVICE" ],
"services" : [ {
"name" : "...",
"type" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceState" : "HISTORY_NOT_AVAILABLE",
"healthSummary" : "BAD",
"configStalenessStatus" : "STALE_REFRESHABLE",
"clientConfigStalenessStatus" : "STALE",
"healthChecks" : [ {
"name" : "...",
"summary" : "NOT_AVAILABLE",
"explanation" : "...",
"suppressed" : true
}, {
"name" : "...",
"summary" : "CONCERNING",
"explanation" : "...",
"suppressed" : true
} ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CONTROL_PLANE", "CLUSTER" ],
"config" : {
"roleTypeConfigs" : [ { }, { } ],
"items" : [ { }, { } ]
},
"roles" : [ {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "STOPPING",
"commissionState" : "UNKNOWN",
"healthSummary" : "CONCERNING",
"configStalenessStatus" : "STALE_REFRESHABLE",
"healthChecks" : [ { }, { } ],
"haStatus" : "STANDBY",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "HOST", "CLUSTER" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION",
"entityStatus" : "CONCERNING_HEALTH",
"tags" : [ { }, { } ]
}, {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "BUSY",
"commissionState" : "OFFLINED",
"healthSummary" : "BAD",
"configStalenessStatus" : "STALE",
"healthChecks" : [ { }, { } ],
"haStatus" : "STANDBY",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "SERVICE", "CONTROL_PLANE" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "STANDALONE",
"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" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"atlasReplicationArguments" : { },
"id" : 12345,
"displayName" : "...",
"description" : "...",
"startTime" : "...",
"endTime" : "...",
"interval" : 12345,
"intervalUnit" : "YEAR",
"nextRun" : "...",
"paused" : true,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true
}, {
"hdfsArguments" : { },
"hiveArguments" : { },
"hdfsCloudArguments" : { },
"ozoneReplicationArguments" : { },
"history" : [ { }, { } ],
"active" : true,
"hiveCloudArguments" : { },
"hbaseArguments" : { },
"hive3Arguments" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"atlasReplicationArguments" : { },
"id" : 12345,
"displayName" : "...",
"description" : "...",
"startTime" : "...",
"endTime" : "...",
"interval" : 12345,
"intervalUnit" : "MONTH",
"nextRun" : "...",
"paused" : true,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true
} ],
"snapshotPolicies" : [ {
"name" : "...",
"description" : "...",
"hourlySnapshots" : 12345,
"dailySnapshots" : 12345,
"weeklySnapshots" : 12345,
"monthlySnapshots" : 12345,
"yearlySnapshots" : 12345,
"minuteOfHour" : 12345,
"hoursForHourlySnapshots" : [ 12345, 12345 ],
"hourOfDay" : 12345,
"dayOfWeek" : 12345,
"dayOfMonth" : 12345,
"monthOfYear" : 12345,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true,
"hbaseArguments" : { },
"hdfsArguments" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
}, {
"name" : "...",
"description" : "...",
"hourlySnapshots" : 12345,
"dailySnapshots" : 12345,
"weeklySnapshots" : 12345,
"monthlySnapshots" : 12345,
"yearlySnapshots" : 12345,
"minuteOfHour" : 12345,
"hoursForHourlySnapshots" : [ 12345, 12345 ],
"hourOfDay" : 12345,
"dayOfWeek" : 12345,
"dayOfMonth" : 12345,
"monthOfYear" : 12345,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true,
"hbaseArguments" : { },
"hdfsArguments" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
} ],
"entityStatus" : "UNKNOWN_HEALTH",
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ],
"serviceVersion" : "..."
}, {
"name" : "...",
"type" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceState" : "UNKNOWN",
"healthSummary" : "HISTORY_NOT_AVAILABLE",
"configStalenessStatus" : "FRESH",
"clientConfigStalenessStatus" : "FRESH",
"healthChecks" : [ {
"name" : "...",
"summary" : "BAD",
"explanation" : "...",
"suppressed" : true
}, {
"name" : "...",
"summary" : "BAD",
"explanation" : "...",
"suppressed" : true
} ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CLUSTER", "ROLE" ],
"config" : {
"roleTypeConfigs" : [ { }, { } ],
"items" : [ { }, { } ]
},
"roles" : [ {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "BUSY",
"commissionState" : "COMMISSIONED",
"healthSummary" : "NOT_AVAILABLE",
"configStalenessStatus" : "STALE_REFRESHABLE",
"healthChecks" : [ { }, { } ],
"haStatus" : "ACTIVE",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "ROLE", "SERVICE" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "REPLICATED_LEADER",
"entityStatus" : "UNKNOWN_HEALTH",
"tags" : [ { }, { } ]
}, {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "NA",
"commissionState" : "COMMISSIONED",
"healthSummary" : "HISTORY_NOT_AVAILABLE",
"configStalenessStatus" : "STALE",
"healthChecks" : [ { }, { } ],
"haStatus" : "STANDBY",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CLUSTER", "HOST" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "REPLICATED_LEADER",
"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" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"atlasReplicationArguments" : { },
"id" : 12345,
"displayName" : "...",
"description" : "...",
"startTime" : "...",
"endTime" : "...",
"interval" : 12345,
"intervalUnit" : "YEAR",
"nextRun" : "...",
"paused" : true,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true
}, {
"hdfsArguments" : { },
"hiveArguments" : { },
"hdfsCloudArguments" : { },
"ozoneReplicationArguments" : { },
"history" : [ { }, { } ],
"active" : true,
"hiveCloudArguments" : { },
"hbaseArguments" : { },
"hive3Arguments" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"atlasReplicationArguments" : { },
"id" : 12345,
"displayName" : "...",
"description" : "...",
"startTime" : "...",
"endTime" : "...",
"interval" : 12345,
"intervalUnit" : "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" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
}, {
"name" : "...",
"description" : "...",
"hourlySnapshots" : 12345,
"dailySnapshots" : 12345,
"weeklySnapshots" : 12345,
"monthlySnapshots" : 12345,
"yearlySnapshots" : 12345,
"minuteOfHour" : 12345,
"hoursForHourlySnapshots" : [ 12345, 12345 ],
"hourOfDay" : 12345,
"dayOfWeek" : 12345,
"dayOfMonth" : 12345,
"monthOfYear" : 12345,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true,
"hbaseArguments" : { },
"hdfsArguments" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
} ],
"entityStatus" : "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" : "GOOD_HEALTH",
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiCluster"
}
}
}
}
],
"example" : {
"items" : [ {
"name" : "...",
"displayName" : "...",
"fullVersion" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "HOST", "CONTROL_PLANE" ],
"services" : [ {
"name" : "...",
"type" : "...",
"clusterRef" : { },
"serviceState" : "NA",
"healthSummary" : "NOT_AVAILABLE",
"configStalenessStatus" : "STALE_REFRESHABLE",
"clientConfigStalenessStatus" : "FRESH",
"healthChecks" : [ { }, { } ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CONTROL_PLANE", "CLUSTER" ],
"config" : { },
"roles" : [ { }, { } ],
"displayName" : "...",
"roleConfigGroups" : [ { }, { } ],
"replicationSchedules" : [ { }, { } ],
"snapshotPolicies" : [ { }, { } ],
"entityStatus" : "NONE",
"tags" : [ { }, { } ],
"serviceVersion" : "..."
}, {
"name" : "...",
"type" : "...",
"clusterRef" : { },
"serviceState" : "STOPPING",
"healthSummary" : "GOOD",
"configStalenessStatus" : "STALE_REFRESHABLE",
"clientConfigStalenessStatus" : "STALE",
"healthChecks" : [ { }, { } ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "HOST", "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" : "STOPPING",
"uuid" : "...",
"dataContextRefs" : [ {
"name" : "..."
}, {
"name" : "..."
} ],
"clusterType" : "...",
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ]
}, {
"name" : "...",
"displayName" : "...",
"fullVersion" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "ROLE", "ROLE" ],
"services" : [ {
"name" : "...",
"type" : "...",
"clusterRef" : { },
"serviceState" : "STOPPED",
"healthSummary" : "BAD",
"configStalenessStatus" : "STALE",
"clientConfigStalenessStatus" : "STALE_REFRESHABLE",
"healthChecks" : [ { }, { } ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CLUSTER", "SERVICE" ],
"config" : { },
"roles" : [ { }, { } ],
"displayName" : "...",
"roleConfigGroups" : [ { }, { } ],
"replicationSchedules" : [ { }, { } ],
"snapshotPolicies" : [ { }, { } ],
"entityStatus" : "CONCERNING_HEALTH",
"tags" : [ { }, { } ],
"serviceVersion" : "..."
}, {
"name" : "...",
"type" : "...",
"clusterRef" : { },
"serviceState" : "STARTED",
"healthSummary" : "DISABLED",
"configStalenessStatus" : "FRESH",
"clientConfigStalenessStatus" : "STALE_REFRESHABLE",
"healthChecks" : [ { }, { } ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "HOST", "SERVICE" ],
"config" : { },
"roles" : [ { }, { } ],
"displayName" : "...",
"roleConfigGroups" : [ { }, { } ],
"replicationSchedules" : [ { }, { } ],
"snapshotPolicies" : [ { }, { } ],
"entityStatus" : "CONCERNING_HEALTH",
"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" : "..."
} ]
} ]
},
"description" : "A list of clusters."
}
,
"ApiClusterNameList" : {
"type" : "object",
"title" : "ApiClusterNameList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
],
"example" : {
"items" : [ "...", "..." ]
},
"description" : "A list of cluster names."
}
,
"ApiClusterPerfInspectorArgs" : {
"type" : "object",
"title" : "ApiClusterPerfInspectorArgs",
"properties" : {
"pingArgs" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiPerfInspectorPingArgs"
}
},
"example" : {
"pingArgs" : {
"pingTimeoutSecs" : 10,
"pingCount" : 10,
"pingPacketSizeBytes" : 56
}
},
"description" : "Arguments used for the Cluster Performance Inspector"
}
,
"ApiClusterRef" : {
"type" : "object",
"title" : "ApiClusterRef",
"properties" : {
"clusterName" : {
"readOnly" : false,
"description" : "The name of the cluster, which uniquely identifies it in a CM installation.",
"type" : "string"
},
"displayName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The display name of the cluster that is shown in the UI.\n \nAvailable since API v6.",
"type" : "string"
},
"clusterSupportToken" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiClusterSupportToken"
}
}
}
}
],
"example" : {
"items" : [ {
"clusterName" : "...",
"displayName" : "...",
"clusterSupportToken" : "..."
}, {
"clusterName" : "...",
"displayName" : "...",
"clusterSupportToken" : "..."
} ]
},
"description" : "A list of cluster support tokens."
}
,
"ApiClusterTemplate" : {
"type" : "object",
"title" : "ApiClusterTemplate",
"properties" : {
"cdhVersion" : {
"readOnly" : false,
"description" : "CDH version",
"type" : "string"
},
"experienceVersion" : {
"readOnly" : false,
"description" : "Deprecated. Use dataServicesVersion instead.",
"type" : "string"
},
"dataServicesVersion" : {
"readOnly" : false,
"description" : "Data Services version",
"type" : "string"
},
"products" : {
"readOnly" : false,
"description" : "All the parcels that needs to be deployed and activated",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiProductVersion"
}
},
"services" : {
"readOnly" : false,
"description" : "All the services that needs to be deployed",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiClusterTemplateService"
}
},
"hostTemplates" : {
"readOnly" : false,
"description" : "All host templates",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiClusterTemplateHostTemplate"
}
},
"displayName" : {
"readOnly" : false,
"description" : "Cluster display name",
"type" : "string"
},
"cmVersion" : {
"readOnly" : false,
"description" : "CM version for which the template",
"type" : "string"
},
"instantiator" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiClusterTemplateInstantiator"
},
"repositories" : {
"readOnly" : false,
"description" : "List of all repositories registered with CM",
"type" : "array",
"items" : {
"type" : "string"
}
},
"clusterSpec" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiClusterTemplateClusterSpec"
},
"tags" : {
"readOnly" : false,
"description" : "Tags associated with the cluster",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "Config name",
"type" : "string"
},
"value" : {
"readOnly" : false,
"description" : "Config value",
"type" : "string"
},
"ref" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Host name",
"type" : "string"
},
"hostNameRange" : {
"readOnly" : false,
"description" : "Host range. Either this this or host name must be provided.",
"type" : "string"
},
"rackId" : {
"readOnly" : false,
"description" : "Rack Id",
"type" : "string"
},
"hostTemplateRefName" : {
"readOnly" : false,
"description" : "Pointing to the host template reference in the cluster template.",
"type" : "string"
},
"roleRefNames" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Reference name",
"type" : "string"
},
"roleConfigGroupsRefNames" : {
"readOnly" : false,
"description" : "List of role config groups",
"type" : "array",
"items" : {
"type" : "string"
}
},
"cardinality" : {
"readOnly" : false,
"description" : "Represent the cardinality of this host template on source. Defaults to 0.",
"type" : "integer",
"format" : "int32"
},
"tags" : {
"readOnly" : false,
"description" : "The tags to be added to hosts when this template is applied",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "Cluster name",
"type" : "string"
},
"hosts" : {
"readOnly" : false,
"description" : "All the hosts that are part of that cluster",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiClusterTemplateHostInfo"
}
},
"variables" : {
"readOnly" : false,
"description" : "All the variables the are referred by the cluster template",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiClusterTemplateVariable"
}
},
"roleConfigGroups" : {
"readOnly" : false,
"description" : "All the role config group informations for non-base RCGs.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiClusterTemplateRoleConfigGroupInfo"
}
},
"clusterSpec" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiClusterTemplateClusterSpec"
},
"keepHostTemplates" : {
"readOnly" : false,
"description" : "Keep the hosts templates from cluster template.",
"type" : "boolean"
},
"lenient" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "Role reference name",
"type" : "string"
},
"roleType" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The reference name of the role config.",
"type" : "string"
},
"roleType" : {
"readOnly" : false,
"description" : "Role type",
"type" : "string"
},
"base" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Role config group display name",
"type" : "string"
},
"configs" : {
"readOnly" : false,
"description" : "List of configurations",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "Role config group reference name. This much match the reference name from\nthe template.",
"type" : "string"
},
"name" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Reference name of the service. This could be referred by some\nconfiguration.",
"type" : "string"
},
"serviceType" : {
"readOnly" : false,
"description" : "Service type",
"type" : "string"
},
"serviceConfigs" : {
"readOnly" : false,
"description" : "Service level configuration",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiClusterTemplateConfig"
}
},
"roleConfigGroups" : {
"readOnly" : false,
"description" : "All role config groups for that service",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiClusterTemplateRoleConfigGroup"
}
},
"roles" : {
"readOnly" : false,
"description" : "List of roles for this service that are referred by some configuration.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiClusterTemplateRole"
}
},
"displayName" : {
"readOnly" : false,
"description" : "Service display name.",
"type" : "string"
},
"tags" : {
"readOnly" : false,
"description" : "Tags associated with the service",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "Variable name that are referred in cluster template",
"type" : "string"
},
"value" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Average number of CPU cores available in the cluster during the report window.",
"type" : "number"
},
"avgCpuUtilization" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiTenantUtilizationList"
},
"maxCpuUtilizationTimestampMs" : {
"readOnly" : false,
"description" : "Timestamp corresponding to maximum CPU utilization for the entire cluster\nduring the report window.",
"type" : "integer",
"format" : "int64"
},
"maxMemoryUtilizationTimestampMs" : {
"readOnly" : false,
"description" : "Timestamp corresponding to maximum memory utilization for the entire\ncluster during the report window.",
"type" : "integer",
"format" : "int64"
},
"maxWorkloadCpuTimestampMs" : {
"readOnly" : false,
"description" : "Timestamp corresponds to maximum CPU consumption by workloads that\nran on the cluster during the report window.",
"type" : "integer",
"format" : "int64"
},
"maxWorkloadMemoryTimestampMs" : {
"readOnly" : false,
"description" : "Timestamp corresponds to maximum memory resource consumption by workloads that\nran on the cluster during the report window.",
"type" : "integer",
"format" : "int64"
},
"errorMessage" : {
"readOnly" : false,
"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",
"DATA_SERVICES2",
"UNKNOWN"
],
"description" : "The CDH version of the cluster."
}
,
"ApiClustersPerfInspectorArgs" : {
"type" : "object",
"title" : "ApiClustersPerfInspectorArgs",
"properties" : {
"sourceCluster" : {
"readOnly" : false,
"description" : "Required name of the source cluster to run network diagnostics test.",
"type" : "string"
},
"targetCluster" : {
"readOnly" : false,
"description" : "Required name of the target cluster to run network diagnostics test.",
"type" : "string"
},
"pingArgs" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiPerfInspectorPingArgs"
},
"bandwidthArgs" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiPerfInspectorBandwidthArgs"
},
"policyType" : {
"readOnly" : false,
"$ref" : "#/components/schemas/PerfInspectorPolicyType"
}
},
"example" : {
"sourceCluster" : "...",
"targetCluster" : "...",
"pingArgs" : {
"pingTimeoutSecs" : 10,
"pingCount" : 10,
"pingPacketSizeBytes" : 56
},
"bandwidthArgs" : {
"runBandwidthDiagnostics" : false,
"bandwidthTimeoutSecs" : 10
},
"policyType" : "QUICK"
},
"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" : {
"readOnly" : false,
"description" : "The name of the remote CM instance. Immutable during update.",
"type" : "string"
},
"type" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiCmPeerType"
},
"url" : {
"readOnly" : false,
"description" : "The URL of the remote CM instance. Mutable during update.",
"type" : "string"
},
"username" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : "REPLICATION",
"url" : "...",
"username" : "...",
"password" : "...",
"clouderaManagerCreatedUser" : true,
"createUserWithAdminRole" : true
},
"description" : "Information about a Cloudera Manager peer instance.\n \nThe requirement and usage of username<\/i> and password<\/i> properties\nare dependent on the clouderaManagerCreatedUser<\/i> 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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiCmPeer"
}
}
}
}
],
"example" : {
"items" : [ {
"name" : "...",
"type" : "REPLICATION",
"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" : {
"readOnly" : false,
"description" : "The CM server ID.",
"type" : "string"
},
"name" : {
"readOnly" : false,
"description" : "The CM server hostname.",
"type" : "string"
},
"ipAddress" : {
"readOnly" : false,
"description" : "The IP address.",
"type" : "string"
},
"createdTime" : {
"readOnly" : false,
"description" : "The created time.",
"type" : "string",
"format" : "date-time"
},
"lastUpdatedTime" : {
"readOnly" : false,
"description" : "The last updated time.",
"type" : "string",
"format" : "date-time"
},
"haPriority" : {
"readOnly" : false,
"description" : "HA Priority for active passive mode.",
"type" : "string"
},
"isAlive" : {
"readOnly" : false,
"description" : "Is the cm server running.",
"type" : "string"
},
"ipv6Address" : {
"readOnly" : false,
"description" : "The IP address.",
"type" : "string"
}
},
"example" : {
"cmServerId" : "...",
"name" : "...",
"ipAddress" : "...",
"createdTime" : "...",
"lastUpdatedTime" : "...",
"haPriority" : "...",
"isAlive" : "...",
"ipv6Address" : "..."
},
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiCmServer"
}
}
}
}
],
"example" : {
"items" : [ {
"cmServerId" : "...",
"name" : "...",
"ipAddress" : "...",
"createdTime" : "...",
"lastUpdatedTime" : "...",
"haPriority" : "...",
"isAlive" : "...",
"ipv6Address" : "..."
}, {
"cmServerId" : "...",
"name" : "...",
"ipAddress" : "...",
"createdTime" : "...",
"lastUpdatedTime" : "...",
"haPriority" : "...",
"isAlive" : "...",
"ipv6Address" : "..."
} ]
},
"description" : "A generic list."
}
,
"ApiCollectDiagnosticDataArguments" : {
"type" : "object",
"title" : "ApiCollectDiagnosticDataArguments",
"properties" : {
"collectCMDBDump" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"bundleSizeBytes" : {
"readOnly" : false,
"description" : "The maximum approximate bundle size of the output file. Defaults to 0.",
"type" : "integer",
"format" : "int64"
},
"startTime" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The end time (in ISO 8601 format)\nof the period to collection statistics for.",
"type" : "string"
},
"includeInfoLog" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The support ticket number to attach to this data collection.",
"type" : "string"
},
"comments" : {
"readOnly" : false,
"description" : "Comments to include with this data collection.",
"type" : "string"
},
"clusterName" : {
"readOnly" : false,
"description" : "Name of the cluster to collect. If null, collects from all clusters.",
"type" : "string"
},
"enableMonitorMetricsCollection" : {
"readOnly" : false,
"description" : "Flag to enable collection of metrics for chart display.",
"type" : "boolean"
},
"roles" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The command ID.",
"type" : "integer",
"format" : "int64"
},
"name" : {
"readOnly" : false,
"description" : "The command name.",
"type" : "string"
},
"startTime" : {
"readOnly" : false,
"description" : "The start time.",
"type" : "string",
"format" : "date-time"
},
"endTime" : {
"readOnly" : false,
"description" : "The end time, if the command is finished.",
"type" : "string",
"format" : "date-time"
},
"active" : {
"readOnly" : false,
"description" : "Whether the command is currently active.",
"type" : "boolean"
},
"success" : {
"readOnly" : false,
"description" : "If the command is finished, whether it was successful.",
"type" : "boolean"
},
"resultMessage" : {
"readOnly" : false,
"description" : "If the command is finished, the result message.",
"type" : "string"
},
"resultDataUrl" : {
"readOnly" : false,
"description" : "URL to the command's downloadable result data, if any exists.",
"type" : "string"
},
"clusterRef" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiClusterRef"
},
"serviceRef" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiServiceRef"
},
"roleRef" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiRoleRef"
},
"hostRef" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHostRef"
},
"parent" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiCommand"
},
"children" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiCommandList"
},
"canRetry" : {
"readOnly" : false,
"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" : "...",
"clusterDisplayName" : "...",
"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" : "...",
"clusterDisplayName" : "...",
"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" : "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.<\/p>\n\n Asynchronous 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.<\/p>"
}
,
"ApiCommandList" : {
"type" : "object",
"title" : "ApiCommandList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
}
}
],
"example" : {
"items" : [ {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"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" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "NOT_AVAILABLE",
"roleStatus" : "HISTORY_NOT_AVAILABLE"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : { },
"children" : {
"items" : [ { }, { } ]
},
"canRetry" : true
} ]
},
"description" : "A list of commands."
}
,
"ApiCommandMetadata" : {
"type" : "object",
"title" : "ApiCommandMetadata",
"properties" : {
"name" : {
"readOnly" : false,
"description" : "The name of of the command.",
"type" : "string"
},
"argSchema" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "The list of command metadata objects.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiCommandMetadata"
}
}
}
}
],
"example" : {
"items" : [ {
"name" : "...",
"argSchema" : "..."
}, {
"name" : "...",
"argSchema" : "..."
} ]
},
"description" : "A list of command metadata."
}
,
"ApiCommandStep" : {
"type" : "object",
"title" : "ApiCommandStep",
"properties" : {
"description" : {
"readOnly" : false,
"description" : "The command step description.",
"type" : "string"
},
"startTime" : {
"readOnly" : false,
"description" : "The start time.",
"type" : "string",
"format" : "date-time"
},
"endTime" : {
"readOnly" : false,
"description" : "The end time, if the command step is finished.",
"type" : "string",
"format" : "date-time"
},
"state" : {
"readOnly" : false,
"$ref" : "#/components/schemas/State"
},
"resultMessage" : {
"readOnly" : false,
"description" : "If the command step is finished, the result message.",
"type" : "string"
},
"ignoreError" : {
"readOnly" : false,
"description" : "Whether the step will continue even upon error.",
"type" : "boolean"
},
"parallel" : {
"readOnly" : false,
"description" : "Whether the children are scattered simultaneously, i.e. parallel.\nIf not they would execute one after another, i.e. serially.",
"type" : "boolean"
},
"processes" : {
"readOnly" : false,
"description" : "List of processes executed by the command step.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiCommandStepProcess"
}
},
"clientConfigs" : {
"readOnly" : false,
"description" : "List of command step client configs.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiCommandStepProcess"
}
},
"roles" : {
"readOnly" : false,
"description" : "List of command step roles.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiRoleRef"
}
},
"clusters" : {
"readOnly" : false,
"description" : "List of clusters associated with command step.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiClusterRef"
}
},
"hosts" : {
"readOnly" : false,
"description" : "List of hosts associated with command step.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiHostRef"
}
},
"services" : {
"readOnly" : false,
"description" : "List of services associated with command step.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiServiceRef"
}
},
"children" : {
"readOnly" : false,
"description" : "List of child command steps.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiCommandStep"
}
},
"commands" : {
"readOnly" : false,
"description" : "List of subcommands.\n \nThe list contains only the summary view of the commands.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiCommand"
}
},
"remoteCommand" : {
"readOnly" : false,
"$ref" : "#/components/schemas/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" : "STARTED"
}, {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "CONCERNING",
"roleStatus" : "UNKNOWN"
} ],
"clusters" : [ {
"clusterName" : "...",
"displayName" : "..."
}, {
"clusterName" : "...",
"displayName" : "..."
} ],
"hosts" : [ {
"hostId" : "...",
"hostname" : "..."
}, {
"hostId" : "...",
"hostname" : "..."
} ],
"services" : [ {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
}, {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"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" : "CONCERNING",
"roleStatus" : "BUSY"
}, {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "DISABLED",
"roleStatus" : "STOPPING"
} ],
"clusters" : [ {
"clusterName" : "...",
"displayName" : "..."
}, {
"clusterName" : "...",
"displayName" : "..."
} ],
"hosts" : [ {
"hostId" : "...",
"hostname" : "..."
}, {
"hostId" : "...",
"hostname" : "..."
} ],
"services" : [ {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
}, {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"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" : "DISABLED",
"roleStatus" : "BUSY"
}, {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "NOT_AVAILABLE",
"roleStatus" : "BUSY"
} ],
"clusters" : [ {
"clusterName" : "...",
"displayName" : "..."
}, {
"clusterName" : "...",
"displayName" : "..."
} ],
"hosts" : [ {
"hostId" : "...",
"hostname" : "..."
}, {
"hostId" : "...",
"hostname" : "..."
} ],
"services" : [ {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
}, {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"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" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "HISTORY_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" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "HISTORY_NOT_AVAILABLE",
"roleStatus" : "BUSY"
},
"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" : {
"readOnly" : false,
"description" : "Name of the command step process.",
"type" : "string"
},
"id" : {
"readOnly" : false,
"description" : "Id of the command step process.",
"type" : "integer",
"format" : "int64"
},
"program" : {
"readOnly" : false,
"description" : "The executed program command.",
"type" : "string"
},
"args" : {
"readOnly" : false,
"description" : "JSON-encoded list of program arguments.",
"type" : "string"
},
"stdout" : {
"readOnly" : false,
"description" : "Last lines of the executed program's standard output.",
"type" : "string"
},
"stderr" : {
"readOnly" : false,
"description" : "Last lines of the executed program's standard error.",
"type" : "string"
},
"exitCode" : {
"readOnly" : false,
"description" : "The executed program's exit code.",
"type" : "integer",
"format" : "int32"
}
},
"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" : "#/components/schemas/ApiCommand"
},
{
"properties" : {
"displayName" : {
"readOnly" : false,
"description" : "The command display name.",
"type" : "string"
},
"steps" : {
"readOnly" : false,
"description" : "The steps of the command.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiCommandStep"
}
}
}
}
],
"example" : {
"displayName" : "...",
"steps" : [ {
"description" : "...",
"startTime" : "...",
"endTime" : "...",
"state" : "SUCCEEDED",
"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" : "HISTORY_NOT_AVAILABLE",
"roleStatus" : "STOPPING"
}, {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "HISTORY_NOT_AVAILABLE",
"roleStatus" : "STOPPED"
} ],
"clusters" : [ {
"clusterName" : "...",
"displayName" : "..."
}, {
"clusterName" : "...",
"displayName" : "..."
} ],
"hosts" : [ {
"hostId" : "...",
"hostname" : "..."
}, {
"hostId" : "...",
"hostname" : "..."
} ],
"services" : [ {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
}, {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"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" : "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" : "HISTORY_NOT_AVAILABLE"
}, {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "GOOD",
"roleStatus" : "UNKNOWN"
} ],
"clusters" : [ {
"clusterName" : "...",
"displayName" : "..."
}, {
"clusterName" : "...",
"displayName" : "..."
} ],
"hosts" : [ {
"hostId" : "...",
"hostname" : "..."
}, {
"hostId" : "...",
"hostname" : "..."
} ],
"services" : [ {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
}, {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"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" : "...",
"clusterDisplayName" : "...",
"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" : "...",
"clusterDisplayName" : "...",
"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" : "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.<\/p>\n\n Asynchronous 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.<\/p>"
}
,
"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" : {
"readOnly" : false,
"description" : "The name of the component.",
"type" : "string"
},
"cdhVersion" : {
"readOnly" : false,
"description" : "The CDH version on the host.",
"type" : "string"
},
"cdhRelease" : {
"readOnly" : false,
"description" : "CDH release on the host.",
"type" : "string"
},
"componentVersion" : {
"readOnly" : false,
"description" : "Component version on the host.",
"type" : "string"
},
"componentRelease" : {
"readOnly" : false,
"description" : "Component release on the host.",
"type" : "string"
},
"componentInfoSource" : {
"readOnly" : false,
"description" : "Source from which component is taken.",
"type" : "string"
},
"isActive" : {
"readOnly" : false,
"description" : "returns true if component is active.",
"type" : "boolean"
},
"componentConfig" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Readonly. The canonical name that identifies this configuration parameter.",
"type" : "string"
},
"value" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Readonly. Requires \"full\" view. The default value.",
"type" : "string"
},
"displayName" : {
"readOnly" : false,
"description" : "Readonly. Requires \"full\" view. A user-friendly name of the parameters,\nas would have been shown in the web UI.",
"type" : "string"
},
"description" : {
"readOnly" : false,
"description" : "Readonly. Requires \"full\" view. A textual description of the parameter.",
"type" : "string"
},
"relatedName" : {
"readOnly" : false,
"description" : "Readonly. Requires \"full\" view. If applicable, contains the related\nconfiguration variable used by the source project.",
"type" : "string"
},
"sensitive" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ValidationState"
},
"validationMessage" : {
"readOnly" : false,
"description" : "Readonly. Requires \"full\" view.\nA message explaining the parameter's validation state.",
"type" : "string"
},
"validationWarningsSuppressed" : {
"readOnly" : false,
"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" : "ERROR",
"validationMessage" : "...",
"validationWarningsSuppressed" : true
},
"description" : "Model for a configuration parameter.\n\nWhen an entry's value<\/i> 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<\/i> also can be used\nto unset any previously set value for the parameter, reverting to\nthe default value (if any)."
}
,
"ApiConfigEnforcement" : {
"type" : "object",
"title" : "ApiConfigEnforcement",
"properties" : {
"label" : {
"readOnly" : false,
"description" : "A label can be used to retrieve a set of configurations\nwhere this enforcement is applied. This is currently restricted\nto only those enums defined in ParamSpecLabel.java.\n\nAll these configurations having the same label must be uniform.\nIn other words, all these configurations must accept the\nsame configuration input.\n\nThere are two variations. Different configurations may have\n1. different units for numeric configurations\n2. different separators for list style configurations.",
"type" : "string"
},
"defaultValue" : {
"readOnly" : false,
"description" : "The new default value that these configurations should use instead\nof what is supplied by in Cloudera Manager by default.",
"type" : "string"
},
"unit" : {
"readOnly" : false,
"description" : "This can be MILLISECONDS, SECONDS, MINUTES, HOURS, BYTES, KILOBYTES, MEGABYTES, GIGABYTES,\nPERCENT, PAGES, TIMES, LINES. Optional.",
"type" : "string"
},
"separator" : {
"readOnly" : false,
"description" : "The new default value could be applied to configurations that require different\nseparators. We need to know the separator the supplied default value has in order\nto generate the correct default value correctly. Optional.",
"type" : "string"
}
},
"example" : {
"label" : "...",
"defaultValue" : "...",
"unit" : "...",
"separator" : "..."
},
"description" : ""
}
,
"ApiConfigList" : {
"type" : "object",
"title" : "ApiConfigList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiConfig"
}
}
}
}
],
"example" : {
"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" : "A list of configuration data."
}
,
"ApiConfigPolicy" : {
"type" : "object",
"title" : "ApiConfigPolicy",
"properties" : {
"name" : {
"readOnly" : false,
"description" : "The policy name.",
"type" : "string"
},
"version" : {
"readOnly" : false,
"description" : "The policy version. Useful to differentiate different versions\nof the same policy. Optional",
"type" : "string"
},
"description" : {
"readOnly" : false,
"description" : "A human readable version of what this policy does. Optional",
"type" : "string"
},
"configEnforcements" : {
"readOnly" : false,
"description" : "A list of configuration enforcements.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiConfigEnforcement"
}
}
},
"example" : {
"name" : "...",
"version" : "...",
"description" : "...",
"configEnforcements" : [ {
"label" : "...",
"defaultValue" : "...",
"unit" : "...",
"separator" : "..."
}, {
"label" : "...",
"defaultValue" : "...",
"unit" : "...",
"separator" : "..."
} ]
},
"description" : ""
}
,
"ApiConfigRecord" : {
"type" : "object",
"title" : "ApiConfigRecord",
"properties" : {
"name" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"value" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"rcg" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiRoleConfigGroupRef"
},
"service" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiServiceRef"
},
"applicability" : {
"readOnly" : false,
"$ref" : "#/components/schemas/AutoConfigApplicability"
}
},
"example" : {
"name" : "...",
"value" : "...",
"rcg" : {
"roleConfigGroupName" : "..."
},
"service" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"applicability" : "UNAFFECTED_CONFIGURED_BY_USER"
},
"description" : "This class is differentiated from ApiConfig in the following way:\nApiConfig is used in a hierarchical structure where you have\nApiService -> ApiRoleConfigGroup or ApiRole\n\nApiConfigRecord is used for a flat representation, so it contains\nall the coordinates identifying the owner of the config"
}
,
"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" : {
"readOnly" : false,
"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",
"format" : "int64"
},
"datanodeWebPort" : {
"readOnly" : false,
"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",
"format" : "int64"
}
},
"example" : {
"datanodeTransceiverPort" : 12345,
"datanodeWebPort" : 12345
},
"description" : "Arguments used to configure a cluster for Kerberos."
}
,
"ApiControlPlane" : {
"type" : "object",
"title" : "ApiControlPlane",
"properties" : {
"namespace" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The universally unique ID of this control plane in Cloudera Manager",
"type" : "string"
},
"remoteRepoUrl" : {
"readOnly" : false,
"description" : "The url of the remote repository where the artifacts used to install the control plane are hosted",
"type" : "string"
},
"version" : {
"readOnly" : false,
"description" : "The CDP version of the control plane",
"type" : "string"
},
"manifest" : {
"readOnly" : false,
"description" : "The content of the manifest.json of the control plane",
"type" : "string"
},
"valuesYaml" : {
"readOnly" : false,
"description" : "The content of the values.yaml used to configure the control plane",
"type" : "string"
},
"tags" : {
"readOnly" : false,
"description" : "Tags associated with the control plane.\nAvailable since V46.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiEntityTag"
}
},
"kubernetesType" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "A list of installed control planes",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"cmPass" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"cmAddress" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"clusterName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"envName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The content of the public CA certificate.",
"type" : "string"
},
"certContent" : {
"readOnly" : false,
"description" : "The content of the private client certificate.",
"type" : "string"
},
"keyContent" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Returns the dashboard name.",
"type" : "string"
},
"json" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiDashboard"
}
}
}
}
],
"example" : {
"items" : [ {
"name" : "...",
"json" : "..."
}, {
"name" : "...",
"json" : "..."
} ]
},
"description" : "A list of dashboard definitions."
}
,
"ApiDataContext" : {
"type" : "object",
"title" : "ApiDataContext",
"properties" : {
"name" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"displayName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"nameservice" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"createdTime" : {
"readOnly" : false,
"description" : "",
"type" : "string",
"format" : "date-time"
},
"lastModifiedTime" : {
"readOnly" : false,
"description" : "",
"type" : "string",
"format" : "date-time"
},
"services" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiServiceRef"
}
},
"servicesDetails" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiService"
}
},
"supportedServiceTypes" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"type" : "string"
}
},
"allowedClusterVersions" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiMapEntry"
}
},
"configStalenessStatus" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiConfigStalenessStatus"
},
"clientConfigStalenessStatus" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiConfigStalenessStatus"
},
"healthSummary" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHealthSummary"
}
},
"example" : {
"name" : "...",
"displayName" : "...",
"nameservice" : "...",
"createdTime" : "...",
"lastModifiedTime" : "...",
"services" : [ {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
}, {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
} ],
"servicesDetails" : [ {
"name" : "...",
"type" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceState" : "STARTED",
"healthSummary" : "GOOD",
"configStalenessStatus" : "STALE",
"clientConfigStalenessStatus" : "STALE_REFRESHABLE",
"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" : [ { }, { } ],
"items" : [ { }, { } ]
},
"roles" : [ {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "NA",
"commissionState" : "UNKNOWN",
"healthSummary" : "NOT_AVAILABLE",
"configStalenessStatus" : "FRESH",
"healthChecks" : [ { }, { } ],
"haStatus" : "UNKNOWN",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CLUSTER", "HOST" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "REPLICATED_OBSERVER",
"entityStatus" : "NONE",
"tags" : [ { }, { } ]
}, {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "HISTORY_NOT_AVAILABLE",
"commissionState" : "OFFLINING",
"healthSummary" : "DISABLED",
"configStalenessStatus" : "STALE",
"healthChecks" : [ { }, { } ],
"haStatus" : "UNKNOWN",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CLUSTER", "SERVICE" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "STANDALONE",
"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" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"atlasReplicationArguments" : { },
"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" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"atlasReplicationArguments" : { },
"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" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
}, {
"name" : "...",
"description" : "...",
"hourlySnapshots" : 12345,
"dailySnapshots" : 12345,
"weeklySnapshots" : 12345,
"monthlySnapshots" : 12345,
"yearlySnapshots" : 12345,
"minuteOfHour" : 12345,
"hoursForHourlySnapshots" : [ 12345, 12345 ],
"hourOfDay" : 12345,
"dayOfWeek" : 12345,
"dayOfMonth" : 12345,
"monthOfYear" : 12345,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true,
"hbaseArguments" : { },
"hdfsArguments" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
} ],
"entityStatus" : "CONCERNING_HEALTH",
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ],
"serviceVersion" : "..."
}, {
"name" : "...",
"type" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceState" : "STARTED",
"healthSummary" : "GOOD",
"configStalenessStatus" : "FRESH",
"clientConfigStalenessStatus" : "FRESH",
"healthChecks" : [ {
"name" : "...",
"summary" : "NOT_AVAILABLE",
"explanation" : "...",
"suppressed" : true
}, {
"name" : "...",
"summary" : "CONCERNING",
"explanation" : "...",
"suppressed" : true
} ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "ROLE", "SERVICE" ],
"config" : {
"roleTypeConfigs" : [ { }, { } ],
"items" : [ { }, { } ]
},
"roles" : [ {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "UNKNOWN",
"commissionState" : "OFFLINING",
"healthSummary" : "NOT_AVAILABLE",
"configStalenessStatus" : "STALE",
"healthChecks" : [ { }, { } ],
"haStatus" : "STANDBY",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CLUSTER", "CONTROL_PLANE" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "REPLICATED_LEADER",
"entityStatus" : "STARTING",
"tags" : [ { }, { } ]
}, {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "STARTING",
"commissionState" : "OFFLINING",
"healthSummary" : "GOOD",
"configStalenessStatus" : "STALE_REFRESHABLE",
"healthChecks" : [ { }, { } ],
"haStatus" : "STANDBY",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "HOST", "CONTROL_PLANE" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "STANDALONE",
"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" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"atlasReplicationArguments" : { },
"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" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"atlasReplicationArguments" : { },
"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" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
}, {
"name" : "...",
"description" : "...",
"hourlySnapshots" : 12345,
"dailySnapshots" : 12345,
"weeklySnapshots" : 12345,
"monthlySnapshots" : 12345,
"yearlySnapshots" : 12345,
"minuteOfHour" : 12345,
"hoursForHourlySnapshots" : [ 12345, 12345 ],
"hourOfDay" : 12345,
"dayOfWeek" : 12345,
"dayOfMonth" : 12345,
"monthOfYear" : 12345,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true,
"hbaseArguments" : { },
"hdfsArguments" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
} ],
"entityStatus" : "BAD_HEALTH",
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ],
"serviceVersion" : "..."
} ],
"supportedServiceTypes" : [ "...", "..." ],
"allowedClusterVersions" : [ {
"key" : "...",
"value" : "..."
}, {
"key" : "...",
"value" : "..."
} ],
"configStalenessStatus" : "STALE_REFRESHABLE",
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiDataContext"
}
}
}
}
],
"example" : {
"items" : [ {
"name" : "...",
"displayName" : "...",
"nameservice" : "...",
"createdTime" : "...",
"lastModifiedTime" : "...",
"services" : [ {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
}, {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
} ],
"servicesDetails" : [ {
"name" : "...",
"type" : "...",
"clusterRef" : { },
"serviceState" : "STARTING",
"healthSummary" : "NOT_AVAILABLE",
"configStalenessStatus" : "STALE",
"clientConfigStalenessStatus" : "FRESH",
"healthChecks" : [ { }, { } ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CONTROL_PLANE", "SERVICE" ],
"config" : { },
"roles" : [ { }, { } ],
"displayName" : "...",
"roleConfigGroups" : [ { }, { } ],
"replicationSchedules" : [ { }, { } ],
"snapshotPolicies" : [ { }, { } ],
"entityStatus" : "DOWN",
"tags" : [ { }, { } ],
"serviceVersion" : "..."
}, {
"name" : "...",
"type" : "...",
"clusterRef" : { },
"serviceState" : "HISTORY_NOT_AVAILABLE",
"healthSummary" : "CONCERNING",
"configStalenessStatus" : "STALE",
"clientConfigStalenessStatus" : "STALE",
"healthChecks" : [ { }, { } ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "HOST", "HOST" ],
"config" : { },
"roles" : [ { }, { } ],
"displayName" : "...",
"roleConfigGroups" : [ { }, { } ],
"replicationSchedules" : [ { }, { } ],
"snapshotPolicies" : [ { }, { } ],
"entityStatus" : "STOPPED",
"tags" : [ { }, { } ],
"serviceVersion" : "..."
} ],
"supportedServiceTypes" : [ "...", "..." ],
"allowedClusterVersions" : [ {
"key" : "...",
"value" : "..."
}, {
"key" : "...",
"value" : "..."
} ],
"configStalenessStatus" : "STALE",
"clientConfigStalenessStatus" : "FRESH",
"healthSummary" : "DISABLED"
}, {
"name" : "...",
"displayName" : "...",
"nameservice" : "...",
"createdTime" : "...",
"lastModifiedTime" : "...",
"services" : [ {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
}, {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
} ],
"servicesDetails" : [ {
"name" : "...",
"type" : "...",
"clusterRef" : { },
"serviceState" : "STARTED",
"healthSummary" : "NOT_AVAILABLE",
"configStalenessStatus" : "FRESH",
"clientConfigStalenessStatus" : "FRESH",
"healthChecks" : [ { }, { } ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CONTROL_PLANE", "HOST" ],
"config" : { },
"roles" : [ { }, { } ],
"displayName" : "...",
"roleConfigGroups" : [ { }, { } ],
"replicationSchedules" : [ { }, { } ],
"snapshotPolicies" : [ { }, { } ],
"entityStatus" : "DISABLED_HEALTH",
"tags" : [ { }, { } ],
"serviceVersion" : "..."
}, {
"name" : "...",
"type" : "...",
"clusterRef" : { },
"serviceState" : "HISTORY_NOT_AVAILABLE",
"healthSummary" : "CONCERNING",
"configStalenessStatus" : "FRESH",
"clientConfigStalenessStatus" : "STALE_REFRESHABLE",
"healthChecks" : [ { }, { } ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "ROLE", "HOST" ],
"config" : { },
"roles" : [ { }, { } ],
"displayName" : "...",
"roleConfigGroups" : [ { }, { } ],
"replicationSchedules" : [ { }, { } ],
"snapshotPolicies" : [ { }, { } ],
"entityStatus" : "STOPPING",
"tags" : [ { }, { } ],
"serviceVersion" : "..."
} ],
"supportedServiceTypes" : [ "...", "..." ],
"allowedClusterVersions" : [ {
"key" : "...",
"value" : "..."
}, {
"key" : "...",
"value" : "..."
} ],
"configStalenessStatus" : "STALE_REFRESHABLE",
"clientConfigStalenessStatus" : "STALE",
"healthSummary" : "NOT_AVAILABLE"
} ]
},
"description" : "List of ApiDataContext"
}
,
"ApiDataContextRef" : {
"type" : "object",
"title" : "ApiDataContextRef",
"properties" : {
"name" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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",
"format" : "date-time"
},
"clusters" : {
"readOnly" : false,
"description" : "List of clusters in the system including their services, roles and\ncomplete config values.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiCluster"
}
},
"hosts" : {
"readOnly" : false,
"description" : "List of hosts in the system",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiHost"
}
},
"users" : {
"readOnly" : false,
"description" : "List of all users in the system",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiUser"
}
},
"versionInfo" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiVersionInfo"
},
"managementService" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiService"
},
"managerSettings" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiConfigList"
},
"allHostsConfig" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiConfigList"
},
"peers" : {
"readOnly" : false,
"description" : "The list of peers configured in Cloudera Manager.\nAvailable since API v3.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiCmPeer"
}
},
"hostTemplates" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHostTemplateList"
}
},
"example" : {
"timestamp" : "...",
"clusters" : [ {
"name" : "...",
"displayName" : "...",
"fullVersion" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CLUSTER", "ROLE" ],
"services" : [ {
"name" : "...",
"type" : "...",
"clusterRef" : { },
"serviceState" : "UNKNOWN",
"healthSummary" : "DISABLED",
"configStalenessStatus" : "STALE_REFRESHABLE",
"clientConfigStalenessStatus" : "STALE",
"healthChecks" : [ { }, { } ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "HOST", "HOST" ],
"config" : { },
"roles" : [ { }, { } ],
"displayName" : "...",
"roleConfigGroups" : [ { }, { } ],
"replicationSchedules" : [ { }, { } ],
"snapshotPolicies" : [ { }, { } ],
"entityStatus" : "STOPPED",
"tags" : [ { }, { } ],
"serviceVersion" : "..."
}, {
"name" : "...",
"type" : "...",
"clusterRef" : { },
"serviceState" : "STOPPED",
"healthSummary" : "GOOD",
"configStalenessStatus" : "FRESH",
"clientConfigStalenessStatus" : "STALE",
"healthChecks" : [ { }, { } ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "HOST", "ROLE" ],
"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" : "STOPPED",
"uuid" : "...",
"dataContextRefs" : [ {
"name" : "..."
}, {
"name" : "..."
} ],
"clusterType" : "...",
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ]
}, {
"name" : "...",
"displayName" : "...",
"fullVersion" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "ROLE", "HOST" ],
"services" : [ {
"name" : "...",
"type" : "...",
"clusterRef" : { },
"serviceState" : "STOPPED",
"healthSummary" : "DISABLED",
"configStalenessStatus" : "STALE_REFRESHABLE",
"clientConfigStalenessStatus" : "STALE_REFRESHABLE",
"healthChecks" : [ { }, { } ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CONTROL_PLANE", "CONTROL_PLANE" ],
"config" : { },
"roles" : [ { }, { } ],
"displayName" : "...",
"roleConfigGroups" : [ { }, { } ],
"replicationSchedules" : [ { }, { } ],
"snapshotPolicies" : [ { }, { } ],
"entityStatus" : "CONCERNING_HEALTH",
"tags" : [ { }, { } ],
"serviceVersion" : "..."
}, {
"name" : "...",
"type" : "...",
"clusterRef" : { },
"serviceState" : "UNKNOWN",
"healthSummary" : "HISTORY_NOT_AVAILABLE",
"configStalenessStatus" : "FRESH",
"clientConfigStalenessStatus" : "STALE",
"healthChecks" : [ { }, { } ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "HOST", "SERVICE" ],
"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" : "STARTING",
"uuid" : "...",
"dataContextRefs" : [ {
"name" : "..."
}, {
"name" : "..."
} ],
"clusterType" : "...",
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ]
} ],
"hosts" : [ {
"hostId" : "...",
"ipAddress" : "...",
"ipv6Address" : "...",
"hostname" : "...",
"rackId" : "...",
"lastHeartbeat" : "...",
"roleRefs" : [ {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "GOOD",
"roleStatus" : "STARTED"
}, {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "BAD",
"roleStatus" : "STARTING"
} ],
"healthSummary" : "BAD",
"healthChecks" : [ {
"name" : "...",
"summary" : "BAD",
"explanation" : "...",
"suppressed" : true
}, {
"name" : "...",
"summary" : "GOOD",
"explanation" : "...",
"suppressed" : true
} ],
"isParcelInfoAvailable" : true,
"hostUrl" : "...",
"maintenanceMode" : true,
"commissionState" : "DECOMMISSIONING",
"maintenanceOwners" : [ "SERVICE", "SERVICE" ],
"config" : {
"items" : [ { }, { } ]
},
"numCores" : 12345,
"numPhysicalCores" : 12345,
"totalPhysMemBytes" : 12345,
"entityStatus" : "UNKNOWN",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"distribution" : {
"distributionType" : "RHEL9_PPC64LE",
"name" : "...",
"version" : "..."
},
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ]
}, {
"hostId" : "...",
"ipAddress" : "...",
"ipv6Address" : "...",
"hostname" : "...",
"rackId" : "...",
"lastHeartbeat" : "...",
"roleRefs" : [ {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "BAD",
"roleStatus" : "UNKNOWN"
}, {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "HISTORY_NOT_AVAILABLE",
"roleStatus" : "STARTING"
} ],
"healthSummary" : "BAD",
"healthChecks" : [ {
"name" : "...",
"summary" : "DISABLED",
"explanation" : "...",
"suppressed" : true
}, {
"name" : "...",
"summary" : "NOT_AVAILABLE",
"explanation" : "...",
"suppressed" : true
} ],
"isParcelInfoAvailable" : true,
"hostUrl" : "...",
"maintenanceMode" : true,
"commissionState" : "COMMISSIONED",
"maintenanceOwners" : [ "SERVICE", "HOST" ],
"config" : {
"items" : [ { }, { } ]
},
"numCores" : 12345,
"numPhysicalCores" : 12345,
"totalPhysMemBytes" : 12345,
"entityStatus" : "CONCERNING_HEALTH",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"distribution" : {
"distributionType" : "UBUNTU_NOBLE",
"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" : "STOPPED",
"healthSummary" : "HISTORY_NOT_AVAILABLE",
"configStalenessStatus" : "STALE_REFRESHABLE",
"clientConfigStalenessStatus" : "FRESH",
"healthChecks" : [ {
"name" : "...",
"summary" : "HISTORY_NOT_AVAILABLE",
"explanation" : "...",
"suppressed" : true
}, {
"name" : "...",
"summary" : "NOT_AVAILABLE",
"explanation" : "...",
"suppressed" : true
} ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "ROLE", "CLUSTER" ],
"config" : {
"roleTypeConfigs" : [ { }, { } ],
"items" : [ { }, { } ]
},
"roles" : [ {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "UNKNOWN",
"commissionState" : "OFFLINING",
"healthSummary" : "NOT_AVAILABLE",
"configStalenessStatus" : "FRESH",
"healthChecks" : [ { }, { } ],
"haStatus" : "UNKNOWN",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CLUSTER", "CLUSTER" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "REPLICATED_LEADER_ELECTION",
"entityStatus" : "DOWN",
"tags" : [ { }, { } ]
}, {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "UNKNOWN",
"commissionState" : "UNKNOWN",
"healthSummary" : "NOT_AVAILABLE",
"configStalenessStatus" : "STALE_REFRESHABLE",
"healthChecks" : [ { }, { } ],
"haStatus" : "ACTIVE",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CLUSTER", "CONTROL_PLANE" ],
"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" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"atlasReplicationArguments" : { },
"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" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"atlasReplicationArguments" : { },
"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" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
}, {
"name" : "...",
"description" : "...",
"hourlySnapshots" : 12345,
"dailySnapshots" : 12345,
"weeklySnapshots" : 12345,
"monthlySnapshots" : 12345,
"yearlySnapshots" : 12345,
"minuteOfHour" : 12345,
"hoursForHourlySnapshots" : [ 12345, 12345 ],
"hourOfDay" : 12345,
"dayOfWeek" : 12345,
"dayOfMonth" : 12345,
"monthOfYear" : 12345,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true,
"hbaseArguments" : { },
"hdfsArguments" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
} ],
"entityStatus" : "UNKNOWN",
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ],
"serviceVersion" : "..."
},
"managerSettings" : {
"items" : [ {
"name" : "...",
"value" : "...",
"required" : true,
"default" : "...",
"displayName" : "...",
"description" : "...",
"relatedName" : "...",
"sensitive" : true,
"validationState" : "WARNING",
"validationMessage" : "...",
"validationWarningsSuppressed" : true
}, {
"name" : "...",
"value" : "...",
"required" : true,
"default" : "...",
"displayName" : "...",
"description" : "...",
"relatedName" : "...",
"sensitive" : true,
"validationState" : "OK",
"validationMessage" : "...",
"validationWarningsSuppressed" : true
} ]
},
"allHostsConfig" : {
"items" : [ {
"name" : "...",
"value" : "...",
"required" : true,
"default" : "...",
"displayName" : "...",
"description" : "...",
"relatedName" : "...",
"sensitive" : true,
"validationState" : "OK",
"validationMessage" : "...",
"validationWarningsSuppressed" : true
}, {
"name" : "...",
"value" : "...",
"required" : true,
"default" : "...",
"displayName" : "...",
"description" : "...",
"relatedName" : "...",
"sensitive" : true,
"validationState" : "OK",
"validationMessage" : "...",
"validationWarningsSuppressed" : true
} ]
},
"peers" : [ {
"name" : "...",
"type" : "REPLICATION",
"url" : "...",
"username" : "...",
"password" : "...",
"clouderaManagerCreatedUser" : true,
"createUserWithAdminRole" : true
}, {
"name" : "...",
"type" : "REPLICATION",
"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" : {
"readOnly" : false,
"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",
"format" : "date-time"
},
"clusters" : {
"readOnly" : false,
"description" : "List of clusters in the system including their services, roles and\ncomplete config values.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiCluster"
}
},
"hosts" : {
"readOnly" : false,
"description" : "List of hosts in the system",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiHost"
}
},
"authRoles" : {
"readOnly" : false,
"description" : "List of all auth roles in the system\nAvailable from v32",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiAuthRole"
}
},
"externalUserMappings" : {
"readOnly" : false,
"description" : "List of all external user mappings in the system\nAvailable from v32",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiExternalUserMapping"
}
},
"users" : {
"readOnly" : false,
"description" : "List of all users in the system",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiUser2"
}
},
"versionInfo" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiVersionInfo"
},
"managementService" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiService"
},
"managerSettings" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiConfigList"
},
"allHostsConfig" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiConfigList"
},
"peers" : {
"readOnly" : false,
"description" : "The list of peers configured in Cloudera Manager.\nAvailable since API v3.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiCmPeer"
}
},
"hostTemplates" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHostTemplateList"
},
"dataContexts" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiDataContextList"
}
},
"example" : {
"timestamp" : "...",
"clusters" : [ {
"name" : "...",
"displayName" : "...",
"fullVersion" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "ROLE", "SERVICE" ],
"services" : [ {
"name" : "...",
"type" : "...",
"clusterRef" : { },
"serviceState" : "STARTING",
"healthSummary" : "NOT_AVAILABLE",
"configStalenessStatus" : "FRESH",
"clientConfigStalenessStatus" : "STALE",
"healthChecks" : [ { }, { } ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CLUSTER", "CLUSTER" ],
"config" : { },
"roles" : [ { }, { } ],
"displayName" : "...",
"roleConfigGroups" : [ { }, { } ],
"replicationSchedules" : [ { }, { } ],
"snapshotPolicies" : [ { }, { } ],
"entityStatus" : "STARTING",
"tags" : [ { }, { } ],
"serviceVersion" : "..."
}, {
"name" : "...",
"type" : "...",
"clusterRef" : { },
"serviceState" : "UNKNOWN",
"healthSummary" : "NOT_AVAILABLE",
"configStalenessStatus" : "STALE",
"clientConfigStalenessStatus" : "STALE_REFRESHABLE",
"healthChecks" : [ { }, { } ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CONTROL_PLANE", "CONTROL_PLANE" ],
"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" : "STOPPED",
"uuid" : "...",
"dataContextRefs" : [ {
"name" : "..."
}, {
"name" : "..."
} ],
"clusterType" : "...",
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ]
}, {
"name" : "...",
"displayName" : "...",
"fullVersion" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CLUSTER", "SERVICE" ],
"services" : [ {
"name" : "...",
"type" : "...",
"clusterRef" : { },
"serviceState" : "HISTORY_NOT_AVAILABLE",
"healthSummary" : "HISTORY_NOT_AVAILABLE",
"configStalenessStatus" : "FRESH",
"clientConfigStalenessStatus" : "STALE_REFRESHABLE",
"healthChecks" : [ { }, { } ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CONTROL_PLANE", "ROLE" ],
"config" : { },
"roles" : [ { }, { } ],
"displayName" : "...",
"roleConfigGroups" : [ { }, { } ],
"replicationSchedules" : [ { }, { } ],
"snapshotPolicies" : [ { }, { } ],
"entityStatus" : "STOPPING",
"tags" : [ { }, { } ],
"serviceVersion" : "..."
}, {
"name" : "...",
"type" : "...",
"clusterRef" : { },
"serviceState" : "UNKNOWN",
"healthSummary" : "NOT_AVAILABLE",
"configStalenessStatus" : "STALE_REFRESHABLE",
"clientConfigStalenessStatus" : "FRESH",
"healthChecks" : [ { }, { } ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "SERVICE", "SERVICE" ],
"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" : "..."
} ]
} ],
"hosts" : [ {
"hostId" : "...",
"ipAddress" : "...",
"ipv6Address" : "...",
"hostname" : "...",
"rackId" : "...",
"lastHeartbeat" : "...",
"roleRefs" : [ {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "GOOD",
"roleStatus" : "UNKNOWN"
}, {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "NOT_AVAILABLE",
"roleStatus" : "STOPPED"
} ],
"healthSummary" : "NOT_AVAILABLE",
"healthChecks" : [ {
"name" : "...",
"summary" : "BAD",
"explanation" : "...",
"suppressed" : true
}, {
"name" : "...",
"summary" : "BAD",
"explanation" : "...",
"suppressed" : true
} ],
"isParcelInfoAvailable" : true,
"hostUrl" : "...",
"maintenanceMode" : true,
"commissionState" : "DECOMMISSIONING",
"maintenanceOwners" : [ "ROLE", "CONTROL_PLANE" ],
"config" : {
"items" : [ { }, { } ]
},
"numCores" : 12345,
"numPhysicalCores" : 12345,
"totalPhysMemBytes" : 12345,
"entityStatus" : "UNKNOWN",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"distribution" : {
"distributionType" : "RHEL9",
"name" : "...",
"version" : "..."
},
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ]
}, {
"hostId" : "...",
"ipAddress" : "...",
"ipv6Address" : "...",
"hostname" : "...",
"rackId" : "...",
"lastHeartbeat" : "...",
"roleRefs" : [ {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "NOT_AVAILABLE",
"roleStatus" : "BUSY"
}, {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "NOT_AVAILABLE",
"roleStatus" : "UNKNOWN"
} ],
"healthSummary" : "NOT_AVAILABLE",
"healthChecks" : [ {
"name" : "...",
"summary" : "HISTORY_NOT_AVAILABLE",
"explanation" : "...",
"suppressed" : true
}, {
"name" : "...",
"summary" : "DISABLED",
"explanation" : "...",
"suppressed" : true
} ],
"isParcelInfoAvailable" : true,
"hostUrl" : "...",
"maintenanceMode" : true,
"commissionState" : "UNKNOWN",
"maintenanceOwners" : [ "CLUSTER", "HOST" ],
"config" : {
"items" : [ { }, { } ]
},
"numCores" : 12345,
"numPhysicalCores" : 12345,
"totalPhysMemBytes" : 12345,
"entityStatus" : "CONCERNING_HEALTH",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"distribution" : {
"distributionType" : "DEBIAN_WHEEZY",
"name" : "...",
"version" : "..."
},
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ]
} ],
"authRoles" : [ {
"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" : "LDAP"
}, {
"uuid" : "...",
"name" : "...",
"type" : "EXTERNAL_PROGRAM"
} ],
"baseRole" : {
"displayName" : "...",
"name" : "...",
"uuid" : "..."
},
"uuid" : "...",
"isCustom" : true
} ],
"externalUserMappings" : [ {
"name" : "...",
"type" : "LDAP",
"uuid" : "...",
"authRoles" : [ {
"displayName" : "...",
"name" : "...",
"uuid" : "..."
}, {
"displayName" : "...",
"name" : "...",
"uuid" : "..."
} ]
}, {
"name" : "...",
"type" : "EXTERNAL_PROGRAM",
"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" : "STARTING",
"healthSummary" : "DISABLED",
"configStalenessStatus" : "FRESH",
"clientConfigStalenessStatus" : "STALE_REFRESHABLE",
"healthChecks" : [ {
"name" : "...",
"summary" : "CONCERNING",
"explanation" : "...",
"suppressed" : true
}, {
"name" : "...",
"summary" : "CONCERNING",
"explanation" : "...",
"suppressed" : true
} ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CONTROL_PLANE", "HOST" ],
"config" : {
"roleTypeConfigs" : [ { }, { } ],
"items" : [ { }, { } ]
},
"roles" : [ {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "BUSY",
"commissionState" : "OFFLINING",
"healthSummary" : "NOT_AVAILABLE",
"configStalenessStatus" : "STALE",
"healthChecks" : [ { }, { } ],
"haStatus" : "ACTIVE",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "SERVICE", "SERVICE" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "STANDALONE",
"entityStatus" : "STARTING",
"tags" : [ { }, { } ]
}, {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "STARTING",
"commissionState" : "DECOMMISSIONED",
"healthSummary" : "GOOD",
"configStalenessStatus" : "STALE",
"healthChecks" : [ { }, { } ],
"haStatus" : "STANDBY",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "SERVICE", "CLUSTER" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "STANDALONE",
"entityStatus" : "CONCERNING_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" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"atlasReplicationArguments" : { },
"id" : 12345,
"displayName" : "...",
"description" : "...",
"startTime" : "...",
"endTime" : "...",
"interval" : 12345,
"intervalUnit" : "YEAR",
"nextRun" : "...",
"paused" : true,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true
}, {
"hdfsArguments" : { },
"hiveArguments" : { },
"hdfsCloudArguments" : { },
"ozoneReplicationArguments" : { },
"history" : [ { }, { } ],
"active" : true,
"hiveCloudArguments" : { },
"hbaseArguments" : { },
"hive3Arguments" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"atlasReplicationArguments" : { },
"id" : 12345,
"displayName" : "...",
"description" : "...",
"startTime" : "...",
"endTime" : "...",
"interval" : 12345,
"intervalUnit" : "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" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
}, {
"name" : "...",
"description" : "...",
"hourlySnapshots" : 12345,
"dailySnapshots" : 12345,
"weeklySnapshots" : 12345,
"monthlySnapshots" : 12345,
"yearlySnapshots" : 12345,
"minuteOfHour" : 12345,
"hoursForHourlySnapshots" : [ 12345, 12345 ],
"hourOfDay" : 12345,
"dayOfWeek" : 12345,
"dayOfMonth" : 12345,
"monthOfYear" : 12345,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true,
"hbaseArguments" : { },
"hdfsArguments" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
} ],
"entityStatus" : "STOPPED",
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ],
"serviceVersion" : "..."
},
"managerSettings" : {
"items" : [ {
"name" : "...",
"value" : "...",
"required" : true,
"default" : "...",
"displayName" : "...",
"description" : "...",
"relatedName" : "...",
"sensitive" : true,
"validationState" : "WARNING",
"validationMessage" : "...",
"validationWarningsSuppressed" : true
}, {
"name" : "...",
"value" : "...",
"required" : true,
"default" : "...",
"displayName" : "...",
"description" : "...",
"relatedName" : "...",
"sensitive" : true,
"validationState" : "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" : "ERROR",
"validationMessage" : "...",
"validationWarningsSuppressed" : true
} ]
},
"peers" : [ {
"name" : "...",
"type" : "REPLICATION",
"url" : "...",
"username" : "...",
"password" : "...",
"clouderaManagerCreatedUser" : true,
"createUserWithAdminRole" : true
}, {
"name" : "...",
"type" : "REPLICATION",
"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" : "STALE",
"clientConfigStalenessStatus" : "STALE_REFRESHABLE",
"healthSummary" : "CONCERNING"
}, {
"name" : "...",
"displayName" : "...",
"nameservice" : "...",
"createdTime" : "...",
"lastModifiedTime" : "...",
"services" : [ { }, { } ],
"servicesDetails" : [ { }, { } ],
"supportedServiceTypes" : [ "...", "..." ],
"allowedClusterVersions" : [ { }, { } ],
"configStalenessStatus" : "FRESH",
"clientConfigStalenessStatus" : "FRESH",
"healthSummary" : "BAD"
} ]
}
},
"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."
}
,
"ApiDisableCatalogStatestoreHaArguments" : {
"type" : "object",
"title" : "ApiDisableCatalogStatestoreHaArguments",
"properties" : {
"activeCatalogName" : {
"readOnly" : false,
"description" : "Name of the Catalog role that will be active after HA is disabled.",
"type" : "string"
},
"activeStatestoreName" : {
"readOnly" : false,
"description" : "Name of the Statestore role that will be active after HA is disabled.",
"type" : "string"
}
},
"example" : {
"activeCatalogName" : "...",
"activeStatestoreName" : "..."
},
"description" : "Arguments used for the \"disable Catalog Statestore HA\" command.\nThe \"disable Catalog Statestore HA\" command includes disabling catalog\nand statestore HA, therefore the arguments of it include\nthe required catalog and statestore information."
}
,
"ApiDisableJtHaArguments" : {
"type" : "object",
"title" : "ApiDisableJtHaArguments",
"properties" : {
"activeName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Name of the NamdeNode role that is going to be active after\nHigh Availability is disabled.",
"type" : "string"
},
"snnHostId" : {
"readOnly" : false,
"description" : "Id of the host where the new SecondaryNameNode will be created.",
"type" : "string"
},
"snnCheckpointDirList" : {
"readOnly" : false,
"description" : "List of directories used for checkpointing by the new SecondaryNameNode.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"snnName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"message" : "..."
},
"description" : "The echoMessage carries a message to be echoed back from the API service."
}
,
"ApiEcsDownloadAndDistributeArgs" : {
"type" : "object",
"title" : "ApiEcsDownloadAndDistributeArgs",
"properties" : {
"workDir" : {
"readOnly" : false,
"description" : "Gets the working directory for the download and distribution process.",
"type" : "string"
},
"packageName" : {
"readOnly" : false,
"description" : "Gets the name of the file to be downloaded and distributed.",
"type" : "string"
},
"remoteRepoUrl" : {
"readOnly" : false,
"description" : "Gets the URL of the remote repository from which to download the file.",
"type" : "string"
}
},
"example" : {
"workDir" : "...",
"packageName" : "...",
"remoteRepoUrl" : "..."
},
"description" : "Represents arguments for downloading and distributing a file from ECS parcel.\nThis class encapsulates parameters needed for the download and distribution process."
}
,
"ApiEnableCatalogStatestoreHaArguments" : {
"type" : "object",
"title" : "ApiEnableCatalogStatestoreHaArguments",
"properties" : {
"newCatalogHostId" : {
"readOnly" : false,
"description" : "HostId of the host on which the second Catalog role will be created.",
"type" : "string"
},
"newCatalogRoleName" : {
"readOnly" : false,
"description" : "Name of the second Catalog role to be created.",
"type" : "string"
},
"newStatestoreHostId" : {
"readOnly" : false,
"description" : "HostId of the host on which the second Statestore role will be created.",
"type" : "string"
},
"newStatestoreRoleName" : {
"readOnly" : false,
"description" : "Name of the second Statestore role to be created.",
"type" : "string"
}
},
"example" : {
"newCatalogHostId" : "...",
"newCatalogRoleName" : "...",
"newStatestoreHostId" : "...",
"newStatestoreRoleName" : "..."
},
"description" : "Arguments used for the \"enable Catalog StateStore HA\" command.\nThe \"enable Catalog Statestore HA\" command includes enabling catalog\nand statestore HA, therefore the arguments of it include\nthe required catalog and statestore information."
}
,
"ApiEnableCspArguments" : {
"type" : "object",
"title" : "ApiEnableCspArguments",
"properties" : {
"cspType" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"cspStoragePath" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"cspSecretPath" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"cspAddress" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"cspType" : "...",
"cspStoragePath" : "...",
"cspSecretPath" : "...",
"cspAddress" : "..."
},
"description" : ""
}
,
"ApiEnableJtHaArguments" : {
"type" : "object",
"title" : "ApiEnableJtHaArguments",
"properties" : {
"newJtHostId" : {
"readOnly" : false,
"description" : "Id of host on which second JobTracker role will be added.",
"type" : "string"
},
"forceInitZNode" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Name of the second JobTracker role to be created (Optional)",
"type" : "string"
},
"fc1RoleName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "HostId of the host on which the second Llama role will be created.",
"type" : "string"
},
"newLlamaRoleName" : {
"readOnly" : false,
"description" : "Name of the second Llama role to be created (optional).",
"type" : "string"
},
"zkServiceName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "HostId of the host on which the first Llama role will be created.",
"type" : "string"
},
"llama1RoleName" : {
"readOnly" : false,
"description" : "Name of the first Llama role to be created (optional).",
"type" : "string"
},
"llama2HostId" : {
"readOnly" : false,
"description" : "HostId of the host on which the second Llama role will be created.",
"type" : "string"
},
"llama2RoleName" : {
"readOnly" : false,
"description" : "Name of the second Llama role to be created (optional).",
"type" : "string"
},
"zkServiceName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Name of the NameNode role that is going to be made Highly Available.",
"type" : "string"
},
"standbyNnName" : {
"readOnly" : false,
"description" : "Name of the new Standby NameNode role that will be created during the\ncommand (Optional).",
"type" : "string"
},
"standbyNnHostId" : {
"readOnly" : false,
"description" : "Id of the host on which new Standby NameNode will be created.",
"type" : "string"
},
"standbyNameDirList" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Name of the FailoverController role to be created on\nActive NameNode's host (Optional).",
"type" : "string"
},
"standbyFcName" : {
"readOnly" : false,
"description" : "Name of the FailoverController role to be created on\nStandby NameNode's host (Optional).",
"type" : "string"
},
"zkServiceName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiJournalNodeArguments"
}
},
"forceInitZNode" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "IDs of the hosts on which new Oozie Servers will be added.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"newOozieServerRoleNames" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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",
"format" : "int64"
},
"loadBalancerSslPort" : {
"readOnly" : false,
"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",
"format" : "int64"
},
"loadBalancerHostPort" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Id of host on which second ResourceManager role will be added.",
"type" : "string"
},
"newRmRoleName" : {
"readOnly" : false,
"description" : "Name of the second ResourceManager role to be created (Optional)",
"type" : "string"
},
"zkServiceName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Id of host on which new Sentry Server role will be added.",
"type" : "string"
},
"newSentryRoleName" : {
"readOnly" : false,
"description" : "Name of the new Sentry Server role to be created. This is an\noptional argument.",
"type" : "string"
},
"zkServiceName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "Name for the endPoint.",
"type" : "string"
},
"version" : {
"readOnly" : false,
"description" : "Endpoint specific version.",
"type" : "string"
},
"serviceConfigs" : {
"readOnly" : false,
"description" : "Additional configs for the endPoint.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiMapEntry"
}
},
"endPointHostList" : {
"readOnly" : false,
"description" : "List hosts (uris) for this endPoint.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiEndPointHost"
}
},
"serviceType" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Uri for the endPoint.",
"type" : "string"
},
"endPointConfigs" : {
"readOnly" : false,
"description" : "EndPointHost specific configs.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiMapEntry"
}
},
"type" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"value" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "A unique ID for this event.",
"type" : "string"
},
"content" : {
"readOnly" : false,
"description" : "The content payload of this event.",
"type" : "string"
},
"timeOccurred" : {
"readOnly" : false,
"description" : "When the event was generated.",
"type" : "string",
"format" : "date-time"
},
"timeReceived" : {
"readOnly" : false,
"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",
"format" : "date-time"
},
"category" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiEventCategory"
},
"severity" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiEventSeverity"
},
"alert" : {
"readOnly" : false,
"description" : "Whether the event is promoted to an alert according to configuration. Defaults to false",
"type" : "boolean"
},
"attributes" : {
"readOnly" : false,
"description" : "A list of key-value attribute pairs.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiEventAttribute"
}
}
},
"example" : {
"id" : "...",
"content" : "...",
"timeOccurred" : "...",
"timeReceived" : "...",
"category" : "UNKNOWN",
"severity" : "UNKNOWN",
"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" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"values" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"totalResults" : {
"readOnly" : false,
"description" : "The total number of matched results. Some are possibly not shown due\nto pagination.",
"type" : "integer",
"format" : "int64"
},
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiEvent"
}
}
}
}
],
"example" : {
"totalResults" : 12345,
"items" : [ {
"id" : "...",
"content" : "...",
"timeOccurred" : "...",
"timeReceived" : "...",
"category" : "LOG_EVENT",
"severity" : "CRITICAL",
"alert" : true,
"attributes" : [ {
"name" : "...",
"values" : [ "...", "..." ]
}, {
"name" : "...",
"values" : [ "...", "..." ]
} ]
}, {
"id" : "...",
"content" : "...",
"timeOccurred" : "...",
"timeReceived" : "...",
"category" : "AUDIT_EVENT",
"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" : {
"readOnly" : false,
"description" : "Represents the intial name of the account; used to uniquely identify this account.",
"type" : "string"
},
"displayName" : {
"readOnly" : false,
"description" : "Represents a modifiable label to identify this account for user-visible purposes.",
"type" : "string"
},
"createdTime" : {
"readOnly" : false,
"description" : "Represents the time of creation for this account.",
"type" : "string",
"format" : "date-time"
},
"lastModifiedTime" : {
"readOnly" : false,
"description" : "Represents the last modification time for this account.",
"type" : "string",
"format" : "date-time"
},
"typeName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "Represents an identifier for a category.",
"type" : "string"
},
"displayName" : {
"readOnly" : false,
"description" : "Represents a localized display name for a category.",
"type" : "string"
},
"description" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiExternalAccountCategory"
}
}
}
}
],
"example" : {
"items" : [ {
"name" : "...",
"displayName" : "...",
"description" : "..."
}, {
"name" : "...",
"displayName" : "...",
"description" : "..."
} ]
},
"description" : "Represents a list of external account categories."
}
,
"ApiExternalAccountList" : {
"type" : "object",
"title" : "ApiExternalAccountList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "Represents the immutable name for this account.",
"type" : "string"
},
"categoryName" : {
"readOnly" : false,
"description" : "Represents the category of this account.",
"type" : "string"
},
"type" : {
"readOnly" : false,
"description" : "Represents the type for this account.",
"type" : "string"
},
"displayName" : {
"readOnly" : false,
"description" : "Represents the localized display name for this account.",
"type" : "string"
},
"description" : {
"readOnly" : false,
"description" : "Represents the localized description for this account type.",
"type" : "string"
},
"allowedAccountConfigs" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiConfigList"
}
},
"example" : {
"name" : "...",
"categoryName" : "...",
"type" : "...",
"displayName" : "...",
"description" : "...",
"allowedAccountConfigs" : {
"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" : "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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "The name of the external mapping",
"type" : "string"
},
"type" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiExternalUserMappingType"
},
"uuid" : {
"readOnly" : false,
"description" : "Readonly. The UUID of the authRole.\n ",
"type" : "string"
},
"authRoles" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiAuthRoleRef"
}
}
},
"example" : {
"name" : "...",
"type" : "LDAP",
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiExternalUserMapping"
}
}
}
}
],
"example" : {
"items" : [ {
"name" : "...",
"type" : "LDAP",
"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."
}
,
"ApiExternalUserMappingRef" : {
"type" : "object",
"title" : "ApiExternalUserMappingRef",
"properties" : {
"uuid" : {
"readOnly" : false,
"description" : "The uuid of the external user mapping, which uniquely identifies it in a CM installation.",
"type" : "string"
},
"name" : {
"readOnly" : false,
"description" : "The name of the mapping.",
"type" : "string"
},
"type" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiExternalUserMappingType"
}
},
"example" : {
"uuid" : "...",
"name" : "...",
"type" : "SAML_ATTRIBUTE"
},
"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"
}
,
"ApiFormatCopylistingReq" : {
"type" : "object",
"title" : "ApiFormatCopylistingReq",
"properties" : {
"inputPath" : {
"readOnly" : false,
"description" : "Absolute path (including protocol and HDFS namenode address/Ozone service ID) to the input file.\n \nThis file must exist<\/b> before calling the endpoint.\nExample: \nThis file must not exist<\/b> before calling the endpoint.\n<\/p>",
"type" : "string"
},
"statusType" : {
"readOnly" : false,
"description" : "The type of the status objects in the input file.\n \nBased on the values of com.cloudera.enterprise.distcp.util.StatusTypes.\n<\/p>",
"type" : "string"
},
"inputFormat" : {
"readOnly" : false,
"description" : "The format of the input file.\n \nValid values: \"BINARY\"\n<\/p>",
"type" : "string"
},
"outputFormat" : {
"readOnly" : false,
"description" : "The format of the output file.\n \nValid values: \"JSONL\"\n<\/p>",
"type" : "string"
},
"additionalConfigs" : {
"readOnly" : false,
"description" : "A map of additional configuration options for the formatting.\nThese will be merged with the configuration gathered for the command automatically.\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" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiServiceRef"
},
"sourcePath" : {
"readOnly" : false,
"description" : "The path to replicate.",
"type" : "string"
},
"destinationPath" : {
"readOnly" : false,
"description" : "The destination to replicate to.",
"type" : "string"
},
"mapreduceServiceName" : {
"readOnly" : false,
"description" : "The mapreduce service to use for the replication job.",
"type" : "string"
},
"schedulerPoolName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The user which will execute the MapReduce job. Required if running with\nKerberos enabled.",
"type" : "string"
},
"sourceUser" : {
"readOnly" : false,
"description" : "The user which will perform operations on source cluster. Required if\nrunning with Kerberos enabled.",
"type" : "string"
},
"numMaps" : {
"readOnly" : false,
"description" : "The number of mappers to use for the mapreduce replication job.",
"type" : "integer",
"format" : "int32"
},
"dryRun" : {
"readOnly" : false,
"description" : "Whether to perform a dry run. Defaults to false.",
"type" : "boolean"
},
"bandwidthPerMap" : {
"readOnly" : false,
"description" : "The maximum bandwidth (in MB) per mapper in the mapreduce replication\njob.",
"type" : "integer",
"format" : "int32"
},
"abortOnError" : {
"readOnly" : false,
"description" : "Whether to abort on a replication failure. Defaults to false.",
"type" : "boolean"
},
"removeMissingFiles" : {
"readOnly" : false,
"description" : "Whether to delete destination files that are missing in source. Defaults\nto false.",
"type" : "boolean"
},
"preserveReplicationCount" : {
"readOnly" : false,
"description" : "Whether to preserve the HDFS replication count. Defaults to false.",
"type" : "boolean"
},
"preserveBlockSize" : {
"readOnly" : false,
"description" : "Whether to preserve the HDFS block size. Defaults to false.",
"type" : "boolean"
},
"preservePermissions" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The HDFS path where the replication log files should be written to.",
"type" : "string"
},
"skipChecksumChecks" : {
"readOnly" : false,
"description" : "Whether to skip checksum based file validation during\nreplication. Defaults to false.",
"type" : "boolean"
},
"skipListingChecksumChecks" : {
"readOnly" : false,
"description" : "Whether to skip checksum based file comparison during\nreplication. Defaults to false.",
"type" : "boolean"
},
"skipTrash" : {
"readOnly" : false,
"description" : "Whether to permanently delete destination files that are missing in source.\nDefaults to null.",
"type" : "boolean"
},
"replicationStrategy" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ReplicationStrategy"
},
"preserveXAttrs" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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"
},
"numFetchThreads" : {
"readOnly" : false,
"description" : "The number of threads to use for fetching the file statuses from HDFS during source file listing.\nThe value 0 means don't use parallel fetching. The null value means to use\ndistcp defaults.",
"type" : "integer",
"format" : "int32"
},
"destinationCloudAccount" : {
"readOnly" : false,
"description" : "The cloud account name which is used in direct hive cloud replication, if specified.",
"type" : "string"
}
},
"example" : {
"sourceService" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"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,
"numFetchThreads" : 12345,
"destinationCloudAccount" : "..."
},
"description" : "Replication arguments for HDFS."
}
,
"ApiHdfsReplicationCounter" : {
"type" : "object",
"title" : "ApiHdfsReplicationCounter",
"properties" : {
"group" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"name" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"value" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int64"
}
},
"example" : {
"group" : "...",
"name" : "...",
"value" : 12345
},
"description" : "A counter in an HDFS replication job."
}
,
"ApiHdfsReplicationResult" : {
"type" : "object",
"title" : "ApiHdfsReplicationResult",
"properties" : {
"progress" : {
"readOnly" : false,
"description" : "The file copy progress percentage.",
"type" : "integer",
"format" : "int32"
},
"throughput" : {
"readOnly" : false,
"description" : "The data throughput in KB/s.",
"type" : "number"
},
"remainingTime" : {
"readOnly" : false,
"description" : "The time remaining for mapper phase (seconds).",
"type" : "integer",
"format" : "int32"
},
"estimatedCompletionTime" : {
"readOnly" : false,
"description" : "The estimated completion time for the mapper phase.",
"type" : "string",
"format" : "date-time"
},
"counters" : {
"readOnly" : false,
"description" : "The counters collected from the replication job.\n \nUsage information is provided for individual clusters, as well as totals\nacross all clusters."
}
,
"ApiLimitedDistCpRequest" : {
"type" : "object",
"title" : "ApiLimitedDistCpRequest",
"properties" : {
"copyListingSummary" : {
"readOnly" : false,
"$ref" : "#/components/schemas/CopyListingSummary"
},
"proxyUser" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"sourceProxyUser" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"sourcePeer" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"sourceCluster" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"sourceService" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"sequenceFile" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"renameDeleteFile" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"additionalConfigs" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"additionalEnvironmentVariables" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"unsetConfigs" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"type" : "string"
}
},
"mapreduceServiceName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"targetPath" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"copyListingSummary" : {
"totalRecords" : 12345,
"totalFiles" : 12345,
"totalBytes" : 12345
},
"proxyUser" : "...",
"sourceProxyUser" : "...",
"sourcePeer" : "...",
"sourceCluster" : "...",
"sourceService" : "...",
"sequenceFile" : "...",
"renameDeleteFile" : "...",
"additionalConfigs" : {
"property1" : "...",
"property2" : "..."
},
"additionalEnvironmentVariables" : {
"property1" : "...",
"property2" : "..."
},
"unsetConfigs" : [ "...", "..." ],
"mapreduceServiceName" : "...",
"targetPath" : "..."
},
"description" : ""
}
,
"ApiListBase" : {
"type" : "object",
"title" : "ApiListBase",
"example" : { },
"description" : "A generic list."
}
,
"ApiMapEntry" : {
"type" : "object",
"title" : "ApiMapEntry",
"properties" : {
"key" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"value" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"value" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHostNameList"
}
},
"example" : {
"key" : "...",
"value" : {
"items" : [ "...", "..." ]
}
},
"description" : "Similar to ApiMapEntry but the value is an ApiHostNameList."
}
,
"ApiMetric" : {
"type" : "object",
"title" : "ApiMetric",
"properties" : {
"name" : {
"readOnly" : false,
"description" : "Name of the metric.",
"type" : "string"
},
"context" : {
"readOnly" : false,
"description" : "Context the metric is associated with.",
"type" : "string"
},
"unit" : {
"readOnly" : false,
"description" : "Unit of the metric values.",
"type" : "string"
},
"data" : {
"readOnly" : false,
"description" : "List of readings retrieved from the monitors.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiMetricData"
}
},
"displayName" : {
"readOnly" : false,
"description" : "Requires \"full\" view. User-friendly display name for the metric.",
"type" : "string"
},
"description" : {
"readOnly" : false,
"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<\/p>"
}
,
"ApiParcelList" : {
"type" : "object",
"title" : "ApiParcelList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "The name of the cluster that the parcel is used by.",
"type" : "string"
},
"parcelName" : {
"readOnly" : false,
"description" : "The name of the parcel.",
"type" : "string"
},
"parcelVersion" : {
"readOnly" : false,
"description" : "The version of the parcel.",
"type" : "string"
},
"parcelDisplayName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The progress of the state transition.",
"type" : "integer",
"format" : "int64"
},
"totalProgress" : {
"readOnly" : false,
"description" : "The total amount that #getProgress() needs to get to.",
"type" : "integer",
"format" : "int64"
},
"count" : {
"readOnly" : false,
"description" : "The current hosts that have completed.",
"type" : "integer",
"format" : "int64"
},
"totalCount" : {
"readOnly" : false,
"description" : "The total amount that #getCount() needs to get to.",
"type" : "integer",
"format" : "int64"
},
"errors" : {
"readOnly" : false,
"description" : "The errors that exist for this parcel.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"warnings" : {
"readOnly" : false,
"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<\/p>\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<\/p>\n \nAlong with the two progress indicators, the ApiParcelState shows both errors\nand warnings that may have turned up during a state transition.\n<\/p>"
}
,
"ApiParcelUsage" : {
"type" : "object",
"title" : "ApiParcelUsage",
"properties" : {
"racks" : {
"readOnly" : false,
"description" : "The racks that contain hosts that are part of this cluster.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiParcelUsageRack"
}
},
"parcels" : {
"readOnly" : false,
"description" : "The parcel's that are activated and/or in-use on this cluster.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHostRef"
},
"roles" : {
"readOnly" : false,
"description" : "A collection of the roles present on the host.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiParcelUsageRole"
}
}
},
"example" : {
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"roles" : [ {
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "GOOD",
"roleStatus" : "UNKNOWN"
},
"parcelRefs" : [ {
"clusterName" : "...",
"parcelName" : "...",
"parcelVersion" : "...",
"parcelDisplayName" : "..."
}, {
"clusterName" : "...",
"parcelName" : "...",
"parcelVersion" : "...",
"parcelDisplayName" : "..."
} ]
}, {
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "HISTORY_NOT_AVAILABLE",
"roleStatus" : "NA"
},
"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" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiParcelRef"
},
"processCount" : {
"readOnly" : false,
"description" : "How many running processes on the cluster are using the parcel.",
"type" : "integer",
"format" : "int32"
},
"activated" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "A collection of the hosts in the rack.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiParcelUsageHost"
}
},
"rackId" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiRoleRef"
},
"parcelRefs" : {
"readOnly" : false,
"description" : "A collection of references to the parcels being used by the role.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiParcelRef"
}
}
},
"example" : {
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "DISABLED",
"roleStatus" : "STOPPING"
},
"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,
"readOnly" : 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,
"readOnly" : false,
"description" : "Timeout in seconds for the bandwidth request to each target host.\nIf not specified, defaults to 10 seconds.",
"type" : "integer",
"format" : "int32"
}
},
"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,
"readOnly" : false,
"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",
"format" : "int32"
},
"pingCount" : {
"example" : 10,
"readOnly" : false,
"description" : "Number of iterations of the ping request to each target host.\nIf not specified, defaults to 10 count.",
"type" : "integer",
"format" : "int32"
},
"pingPacketSizeBytes" : {
"example" : 56,
"readOnly" : false,
"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",
"format" : "int32"
}
},
"example" : {
"pingTimeoutSecs" : 10,
"pingCount" : 10,
"pingPacketSizeBytes" : 56
},
"description" : "Arguments to run ping test."
}
,
"ApiPrincipalList" : {
"type" : "object",
"title" : "ApiPrincipalList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
],
"example" : {
"items" : [ "...", "..." ]
},
"description" : "A list of kerberos principals."
}
,
"ApiProcess" : {
"type" : "object",
"title" : "ApiProcess",
"properties" : {
"configFiles" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"product" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"version" : "...",
"product" : "..."
},
"description" : ""
}
,
"ApiRangerPolicy" : {
"type" : "object",
"title" : "ApiRangerPolicy",
"properties" : {
"service" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"serviceType" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"name" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"resources" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/ApiRangerPolicyResource"
}
}
},
"example" : {
"service" : "...",
"serviceType" : "...",
"name" : "...",
"resources" : {
"property1" : {
"values" : [ "...", "..." ]
},
"property2" : {
"values" : [ "...", "..." ]
}
}
},
"description" : "Holds information about a policy defined in Ranger."
}
,
"ApiRangerPolicyList" : {
"type" : "object",
"title" : "ApiRangerPolicyList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"policies" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiRangerPolicy"
}
},
"remotePolicies" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiRangerPolicy"
}
}
}
}
],
"example" : {
"policies" : [ {
"service" : "...",
"serviceType" : "...",
"name" : "...",
"resources" : {
"property1" : {
"values" : [ "...", "..." ]
},
"property2" : {
"values" : [ "...", "..." ]
}
}
}, {
"service" : "...",
"serviceType" : "...",
"name" : "...",
"resources" : {
"property1" : {
"values" : [ "...", "..." ]
},
"property2" : {
"values" : [ "...", "..." ]
}
}
} ],
"remotePolicies" : [ {
"service" : "...",
"serviceType" : "...",
"name" : "...",
"resources" : {
"property1" : {
"values" : [ "...", "..." ]
},
"property2" : {
"values" : [ "...", "..." ]
}
}
}, {
"service" : "...",
"serviceType" : "...",
"name" : "...",
"resources" : {
"property1" : {
"values" : [ "...", "..." ]
},
"property2" : {
"values" : [ "...", "..." ]
}
}
} ]
},
"description" : "Holds information about local (#getPolicies()) and\nremote (#getRemotePolicies()) policies defined in Ranger."
}
,
"ApiRangerPolicyResource" : {
"type" : "object",
"title" : "ApiRangerPolicyResource",
"properties" : {
"values" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"example" : {
"values" : [ "...", "..." ]
},
"description" : "Holds information about a policy resource defined in Ranger."
}
,
"ApiRangerReplicationArgs" : {
"type" : "object",
"title" : "ApiRangerReplicationArgs",
"properties" : {
"sourceRangerService" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiServiceRef"
},
"exportArgs" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiRangerReplicationExportArgs"
},
"transformArgs" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiRangerReplicationTransformArgs"
},
"importArgs" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiRangerReplicationImportArgs"
},
"auditLogDistCpArgs" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHdfsReplicationArguments"
},
"auditLogDistCpCloudArgs" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHdfsCloudReplicationArguments"
}
},
"example" : {
"sourceRangerService" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"exportArgs" : {
"rangerServiceNames" : [ "...", "..." ]
},
"transformArgs" : {
"rangerServiceNamesMapping" : {
"property1" : "...",
"property2" : "..."
},
"rangerUsersMapping" : {
"property1" : "...",
"property2" : "..."
},
"rangerResourcesMapping" : {
"property1" : "...",
"property2" : "..."
},
"hiveUrlsMapping" : {
"property1" : "...",
"property2" : "..."
},
"hdfsToAdlsArgs" : {
"adlsStorageAccount" : "...",
"adlsStorageAccountContainer" : "..."
},
"hdfsToS3Args" : {
"s3BucketName" : "..."
},
"hdfsToGcsArgs" : {
"gcsBucketName" : "..."
}
},
"importArgs" : {
"importStrategy" : "OVERRIDE",
"extraAuthSiteProperties" : {
"property1" : "...",
"property2" : "..."
}
},
"auditLogDistCpArgs" : {
"sourceService" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"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,
"numFetchThreads" : 12345,
"destinationCloudAccount" : "..."
},
"auditLogDistCpCloudArgs" : {
"sourceAccount" : "...",
"destinationAccount" : "...",
"sourceService" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"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,
"numFetchThreads" : 12345,
"destinationCloudAccount" : "..."
}
},
"description" : "Replication arguments for replicating services defined in Ranger. It works the following way:\n \nThis field is mandatory and cannot be null or empty! \nNote that it's relevant only if any of the Ranger services to be replicated\ncontain HDFS Ranger service type and replication will be done from on-prem to ADLS."
}
,
"ApiRangerReplicationHdfsToGcsArgs" : {
"type" : "object",
"title" : "ApiRangerReplicationHdfsToGcsArgs",
"properties" : {
"gcsBucketName" : {
"readOnly" : false,
"description" : "GCS bucket name for Ranger HDFS policies which need to be transformed to GCS policy.",
"type" : "string"
}
},
"example" : {
"gcsBucketName" : "..."
},
"description" : "Arguments for transforming HDFS Ranger service policies to Google Cloud Storage (GCS) policies.\n \nNote that it's relevant only if any of the Ranger services to be replicated\ncontain HDFS Ranger service type and replication will be done from on-prem to GCS."
}
,
"ApiRangerReplicationHdfsToS3Args" : {
"type" : "object",
"title" : "ApiRangerReplicationHdfsToS3Args",
"properties" : {
"s3BucketName" : {
"readOnly" : false,
"description" : "Amazon S3 bucket name for Ranger HDFS policies which need to be transformed to S3 policy.",
"type" : "string"
}
},
"example" : {
"s3BucketName" : "..."
},
"description" : "Arguments for transforming HDFS Ranger service policies to Amazon S3 policies.\n \nNote that it's relevant only if any of the Ranger services to be replicated\ncontain HDFS Ranger service type and replication will be done from on-prem to S3."
}
,
"ApiRangerReplicationImportArgs" : {
"type" : "object",
"title" : "ApiRangerReplicationImportArgs",
"properties" : {
"importStrategy" : {
"readOnly" : false,
"$ref" : "#/components/schemas/RangerReplicationImportStrategy"
},
"extraAuthSiteProperties" : {
"readOnly" : false,
"description" : "Extra properties to be put to authorization-migration-site.xml,\nwhich is the configuration file used for Ranger import. \nNote that if a mapping is not given for a service then it will stay the same on the destination.\n \nExample: {\"cm_hdfs\":\"dr_hdfs\", \"cm_hive\":\"dr_hive\"} \nNote that if a mapping is not given for a username then it will stay the same on the destination.\n \nExample: {\"testuser1\":\"testuser1@host.com\", \"testuser2\":\"testuser2@host.com\" } \nIf a mapping is not given for a resource then it will stay the same on the destination.\n \nExample<\/b>: \nIf replication contains HDFS Ranger service type<\/b> and replication is done from\non-prem to cloud, then for transforming HDFS Ranger service policies to Cloud policies\nNO resource mapping is needed<\/b>. Instead, provide one of the following:\n#getHdfsToAdlsArgs(), #getHdfsToS3Args(), #getHdfsToGcsArgs()\n \nHIVE prefixed based resource URL replacement is supported<\/b>,\nbut it should be provided in a different mapping<\/b>,\nfor more info see #getHiveUrlsMapping().",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"hiveUrlsMapping" : {
"readOnly" : false,
"description" : "Used for HIVE prefixed based resource URL replacement<\/b>.\n \nFor instance<\/b>, if Hive resource URLs on source<\/b> are:\n \nNote that if replication is from on-prem to cloud<\/b>, and\nit contains a Ranger service with type HDFS<\/b>,\nthen depending on the cloud provider, one of the following must be provided:\n#getHdfsToAdlsArgs(), #getHdfsToS3Args(), #getHdfsToGcsArgs().\nOtherwise, providing this information is not required!<\/b>"
}
,
"ApiRangerService" : {
"type" : "object",
"title" : "ApiRangerService",
"properties" : {
"name" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"type" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"name" : "...",
"type" : "..."
},
"description" : "Holds information about a service defined in Ranger."
}
,
"ApiRangerServiceList" : {
"type" : "object",
"title" : "ApiRangerServiceList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"services" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiRangerService"
}
},
"remoteServices" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiRangerService"
}
}
}
}
],
"example" : {
"services" : [ {
"name" : "...",
"type" : "..."
}, {
"name" : "...",
"type" : "..."
} ],
"remoteServices" : [ {
"name" : "...",
"type" : "..."
}, {
"name" : "...",
"type" : "..."
} ]
},
"description" : "Holds information about local (#getServices()) and\nremote (#getRemoteServices()) services defined in Ranger."
}
,
"ApiRangerUser" : {
"type" : "object",
"title" : "ApiRangerUser",
"properties" : {
"name" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"name" : "..."
},
"description" : "Holds information about a user (vXUsers) defined in Ranger."
}
,
"ApiRangerUserList" : {
"type" : "object",
"title" : "ApiRangerUserList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"vXUsers" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiRangerUser"
}
},
"remoteUsers" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiRangerUser"
}
}
}
}
],
"example" : {
"vXUsers" : [ {
"name" : "..."
}, {
"name" : "..."
} ],
"remoteUsers" : [ {
"name" : "..."
}, {
"name" : "..."
} ]
},
"description" : "Holds information about local (#getUsers()) and\nremote (#getRemoteUsers()) users defined in Ranger."
}
,
"ApiRemoteCommand" : {
"type" : "object",
"title" : "ApiRemoteCommand",
"properties" : {
"id" : {
"readOnly" : false,
"description" : "Id of the remotely executed command.",
"type" : "integer",
"format" : "int64"
},
"peerName" : {
"readOnly" : false,
"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."
}
,
"ApiRemoteCopyListingRequest" : {
"type" : "object",
"title" : "ApiRemoteCopyListingRequest",
"required" : ["compatibleSnapshotHandling"],
"properties" : {
"peer" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"cluster" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"service" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"proxyUser" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"listingPath" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"compatibleSnapshotHandling" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"fromSnapshotName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"toSnapshotName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"excludeFilters" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"type" : "string"
}
},
"sequenceFilePath" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"renameDeleteFilePath" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"resultFilePath" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"additionalConfigs" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"additionalEnvironmentVariables" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"unsetConfigs" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"example" : {
"peer" : "...",
"cluster" : "...",
"service" : "...",
"proxyUser" : "...",
"listingPath" : "...",
"compatibleSnapshotHandling" : true,
"fromSnapshotName" : "...",
"toSnapshotName" : "...",
"excludeFilters" : [ "...", "..." ],
"sequenceFilePath" : "...",
"renameDeleteFilePath" : "...",
"resultFilePath" : "...",
"additionalConfigs" : {
"property1" : "...",
"property2" : "..."
},
"additionalEnvironmentVariables" : {
"property1" : "...",
"property2" : "..."
},
"unsetConfigs" : [ "...", "..." ]
},
"description" : ""
}
,
"ApiRemoteDataContext" : {
"type" : "object",
"title" : "ApiRemoteDataContext",
"properties" : {
"endPointId" : {
"readOnly" : false,
"description" : "A string to uniquely identify the SDX cluster.",
"type" : "string"
},
"endPoints" : {
"readOnly" : false,
"description" : "List of endPoints exported by this SDX cluster.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiEndPoint"
}
},
"configs" : {
"readOnly" : false,
"description" : "SDX cluster specifc options.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiMapEntry"
}
},
"clusterVersion" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiCommand"
},
{
"properties" : {
"hdfsResult" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHdfsReplicationResult"
},
"ozoneResult" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiOzoneReplicationResult"
},
"hiveResult" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHiveReplicationResult"
},
"hiveOnTezResult" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHiveOnTezReplicationResult"
},
"hbaseInfo" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHBaseReplicationInfo"
},
"rangerResult" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiRangerReplicationResult"
},
"icebergResult" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiIcebergReplicationResult"
},
"apiReplicationCommandsWithSameIntent" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiReplicationCommand"
}
},
"apiAtlasReplicationResult" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiAtlasReplicationResult"
}
}
}
],
"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" : {
"commandResultMessage" : "...",
"replicationType" : "FULL_FILE_LISTING",
"replicationCommandType" : "FULL_FILE_LISTING",
"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" : "TARGET",
"endDateOnSrc" : "...",
"endDateOnTgt" : "..."
},
"hbaseInfo" : {
"replicationOperations" : [ "...", "..." ]
},
"rangerResult" : {
"total" : 12345,
"created" : 12345,
"skipped" : 12345,
"failed" : 12345,
"skippedDueToTimeout" : 12345,
"auditLogReplicationResult" : {
"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" : [ "...", "..." ]
}
},
"icebergResult" : {
"numberOfTablesProcessed" : 12345,
"numberOfFilesCopied" : 12345,
"numberOfFilesDeleted" : 12345,
"numberOfManifestsTransformed" : 12345,
"failed" : true,
"timestamp" : "...",
"copyMetadataJobDetailsUri" : "...",
"copyDataJobDetailsUri" : "...",
"copyDeleteDataJobDetailsUri" : "...",
"copyMetadataJobId" : "...",
"copyDataJobId" : "...",
"copyDeleteDataJobId" : "...",
"peerName" : "...",
"peerClusterName" : "..."
},
"apiReplicationCommandsWithSameIntent" : [ {
"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" : {
"commandResultMessage" : "...",
"replicationType" : "INCREMENTAL_WITH_FALLBACK_TO_FULL_FILE_LISTING",
"replicationCommandType" : "INCREMENTAL",
"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",
"endDateOnSrc" : "...",
"endDateOnTgt" : "..."
},
"hbaseInfo" : {
"replicationOperations" : [ "...", "..." ]
},
"rangerResult" : {
"total" : 12345,
"created" : 12345,
"skipped" : 12345,
"failed" : 12345,
"skippedDueToTimeout" : 12345,
"auditLogReplicationResult" : { }
},
"icebergResult" : {
"numberOfTablesProcessed" : 12345,
"numberOfFilesCopied" : 12345,
"numberOfFilesDeleted" : 12345,
"numberOfManifestsTransformed" : 12345,
"failed" : true,
"timestamp" : "...",
"copyMetadataJobDetailsUri" : "...",
"copyDataJobDetailsUri" : "...",
"copyDeleteDataJobDetailsUri" : "...",
"copyMetadataJobId" : "...",
"copyDataJobId" : "...",
"copyDeleteDataJobId" : "...",
"peerName" : "...",
"peerClusterName" : "..."
},
"apiReplicationCommandsWithSameIntent" : [ { }, { } ],
"apiAtlasReplicationResult" : {
"numberOfEntitiesReplicated" : 12345,
"exportStatus" : "...",
"importStatus" : "...",
"exportStartTime" : 12345,
"exportEndTime" : 12345,
"importStartTime" : 12345,
"importEndTime" : 12345
},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"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" : { },
"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" : {
"commandResultMessage" : "...",
"replicationType" : "FULL_FILE_LISTING",
"replicationCommandType" : "FULL_FILE_LISTING_FALLBACK",
"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",
"endDateOnSrc" : "...",
"endDateOnTgt" : "..."
},
"hbaseInfo" : {
"replicationOperations" : [ "...", "..." ]
},
"rangerResult" : {
"total" : 12345,
"created" : 12345,
"skipped" : 12345,
"failed" : 12345,
"skippedDueToTimeout" : 12345,
"auditLogReplicationResult" : { }
},
"icebergResult" : {
"numberOfTablesProcessed" : 12345,
"numberOfFilesCopied" : 12345,
"numberOfFilesDeleted" : 12345,
"numberOfManifestsTransformed" : 12345,
"failed" : true,
"timestamp" : "...",
"copyMetadataJobDetailsUri" : "...",
"copyDataJobDetailsUri" : "...",
"copyDeleteDataJobDetailsUri" : "...",
"copyMetadataJobId" : "...",
"copyDataJobId" : "...",
"copyDeleteDataJobId" : "...",
"peerName" : "...",
"peerClusterName" : "..."
},
"apiReplicationCommandsWithSameIntent" : [ { }, { } ],
"apiAtlasReplicationResult" : {
"numberOfEntitiesReplicated" : 12345,
"exportStatus" : "...",
"importStatus" : "...",
"exportStartTime" : 12345,
"exportEndTime" : 12345,
"importStartTime" : 12345,
"importEndTime" : 12345
},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"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
} ],
"apiAtlasReplicationResult" : {
"numberOfEntitiesReplicated" : 12345,
"exportStatus" : "...",
"importStatus" : "...",
"exportStartTime" : 12345,
"exportEndTime" : 12345,
"importStartTime" : 12345,
"importEndTime" : 12345
},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"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" : "...",
"clusterDisplayName" : "...",
"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 a replication command.\n \nThis argument is for ADVANCED users only.\n<\/p>",
"type" : "integer",
"format" : "int32"
},
"staleConfigsOnly" : {
"readOnly" : false,
"description" : "Restart roles with stale configs only.",
"type" : "boolean"
},
"unUpgradedOnly" : {
"readOnly" : false,
"description" : "Restart roles that haven't been upgraded yet.",
"type" : "boolean"
},
"restartRoleTypes" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Number of hosts with slave roles to restart at a time.\nMust be greater than zero. Default is 1.",
"type" : "integer",
"format" : "int32"
},
"sleepSeconds" : {
"readOnly" : false,
"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",
"format" : "int32"
},
"slaveFailCountThreshold" : {
"readOnly" : false,
"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<\/p>",
"type" : "integer",
"format" : "int32"
},
"staleConfigsOnly" : {
"readOnly" : false,
"description" : "Restart roles with stale configs only.",
"type" : "boolean"
},
"unUpgradedOnly" : {
"readOnly" : false,
"description" : "Restart roles that haven't been upgraded yet.",
"type" : "boolean"
},
"redeployClientConfiguration" : {
"readOnly" : false,
"description" : "Re-deploy client configuration. Available since API v6.",
"type" : "boolean"
},
"rolesToInclude" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiRolesToInclude"
},
"restartServiceNames" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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",
"format" : "int32"
},
"sleepSeconds" : {
"readOnly" : false,
"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",
"format" : "int32"
},
"slaveFailCountThreshold" : {
"readOnly" : false,
"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<\/p>",
"type" : "integer",
"format" : "int32"
}
},
"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" : {
"readOnly" : false,
"description" : "Current CDH Version of the services. Example versions are:\n\"5.1.0\", \"5.2.2\" or \"5.4.0\"",
"type" : "string"
},
"upgradeToCdhVersion" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Number of hosts with slave roles to upgrade at a time.\nMust be greater than zero. Default is 1.",
"type" : "integer",
"format" : "int32"
},
"sleepSeconds" : {
"readOnly" : false,
"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",
"format" : "int32"
},
"slaveFailCountThreshold" : {
"readOnly" : false,
"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<\/p>",
"type" : "integer",
"format" : "int32"
},
"upgradeServiceNames" : {
"readOnly" : false,
"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."
}
,
"ApiRunSpecificHostInspectionsArgs" : {
"type" : "object",
"title" : "ApiRunSpecificHostInspectionsArgs",
"properties" : {
"hostInspectionsListName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"hostInspectionsListName" : "..."
},
"description" : ""
}
,
"ApiSchedule" : {
"type" : "object",
"title" : "ApiSchedule",
"properties" : {
"id" : {
"readOnly" : false,
"description" : "The schedule id.",
"type" : "integer",
"format" : "int64"
},
"displayName" : {
"readOnly" : false,
"description" : "The schedule display name.",
"type" : "string"
},
"description" : {
"readOnly" : false,
"description" : "The schedule description.",
"type" : "string"
},
"startTime" : {
"readOnly" : false,
"description" : "The time at which the scheduled activity is triggered for the first\ntime.",
"type" : "string",
"format" : "date-time"
},
"endTime" : {
"readOnly" : false,
"description" : "The time after which the scheduled activity will no longer be triggered.",
"type" : "string",
"format" : "date-time"
},
"interval" : {
"readOnly" : false,
"description" : "The duration between consecutive triggers of a scheduled activity. Defaults to 0.",
"type" : "integer",
"format" : "int64"
},
"intervalUnit" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiScheduleInterval"
},
"nextRun" : {
"readOnly" : false,
"description" : "Readonly. The time the scheduled command will run next.",
"type" : "string",
"format" : "date-time"
},
"paused" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Whether to alert on start of the scheduled activity. Defaults to false.",
"type" : "boolean"
},
"alertOnSuccess" : {
"readOnly" : false,
"description" : "Whether to alert on successful completion of the scheduled activity. Defaults to false.",
"type" : "boolean"
},
"alertOnFail" : {
"readOnly" : false,
"description" : "Whether to alert on failure of the scheduled activity. Defaults to false.",
"type" : "boolean"
},
"alertOnAbort" : {
"readOnly" : false,
"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" : "DAY",
"nextRun" : "...",
"paused" : true,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true
},
"description" : "Base class for commands that can be scheduled in Cloudera Manager.\n \nThe health summary is still available, and reflects a service-wide summary."
}
,
"ApiServiceConfig" : {
"type" : "object",
"title" : "ApiServiceConfig",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiConfigList"
},
{
"properties" : {
"roleTypeConfigs" : {
"readOnly" : false,
"description" : "List of role type configurations.\nOnly available up to API v2.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : "OK",
"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" : "OK",
"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" : "OK",
"validationMessage" : "...",
"validationWarningsSuppressed" : true
} ]
},
"description" : "Service and role type configuration."
}
,
"ApiServiceList" : {
"type" : "object",
"title" : "ApiServiceList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiService"
}
}
}
}
],
"example" : {
"items" : [ {
"name" : "...",
"type" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceState" : "STARTING",
"healthSummary" : "GOOD",
"configStalenessStatus" : "STALE",
"clientConfigStalenessStatus" : "STALE",
"healthChecks" : [ {
"name" : "...",
"summary" : "GOOD",
"explanation" : "...",
"suppressed" : true
}, {
"name" : "...",
"summary" : "BAD",
"explanation" : "...",
"suppressed" : true
} ],
"serviceUrl" : "...",
"roleInstancesUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CLUSTER", "HOST" ],
"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", "SERVICE" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "REPLICATED_FOLLOWER",
"entityStatus" : "BAD_HEALTH",
"tags" : [ { }, { } ]
}, {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "STOPPING",
"commissionState" : "OFFLINED",
"healthSummary" : "NOT_AVAILABLE",
"configStalenessStatus" : "FRESH",
"healthChecks" : [ { }, { } ],
"haStatus" : "UNKNOWN",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "CONTROL_PLANE", "HOST" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "UNKNOWN",
"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" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"atlasReplicationArguments" : { },
"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" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"atlasReplicationArguments" : { },
"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" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
}, {
"name" : "...",
"description" : "...",
"hourlySnapshots" : 12345,
"dailySnapshots" : 12345,
"weeklySnapshots" : 12345,
"monthlySnapshots" : 12345,
"yearlySnapshots" : 12345,
"minuteOfHour" : 12345,
"hoursForHourlySnapshots" : [ 12345, 12345 ],
"hourOfDay" : 12345,
"dayOfWeek" : 12345,
"dayOfMonth" : 12345,
"monthOfYear" : 12345,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true,
"hbaseArguments" : { },
"hdfsArguments" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
} ],
"entityStatus" : "HISTORY_NOT_AVAILABLE",
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ],
"serviceVersion" : "..."
}, {
"name" : "...",
"type" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceState" : "NA",
"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" : [ "CONTROL_PLANE", "CONTROL_PLANE" ],
"config" : {
"roleTypeConfigs" : [ { }, { } ],
"items" : [ { }, { } ]
},
"roles" : [ {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "HISTORY_NOT_AVAILABLE",
"commissionState" : "OFFLINING",
"healthSummary" : "HISTORY_NOT_AVAILABLE",
"configStalenessStatus" : "FRESH",
"healthChecks" : [ { }, { } ],
"haStatus" : "ACTIVE",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "HOST", "SERVICE" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "REPLICATED_OBSERVER",
"entityStatus" : "HISTORY_NOT_AVAILABLE",
"tags" : [ { }, { } ]
}, {
"name" : "...",
"type" : "...",
"hostRef" : { },
"serviceRef" : { },
"roleState" : "HISTORY_NOT_AVAILABLE",
"commissionState" : "DECOMMISSIONING",
"healthSummary" : "HISTORY_NOT_AVAILABLE",
"configStalenessStatus" : "STALE",
"healthChecks" : [ { }, { } ],
"haStatus" : "ACTIVE",
"roleUrl" : "...",
"maintenanceMode" : true,
"maintenanceOwners" : [ "SERVICE", "HOST" ],
"config" : { },
"roleConfigGroupRef" : { },
"zooKeeperServerMode" : "REPLICATED_FOLLOWER",
"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" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"atlasReplicationArguments" : { },
"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" : { },
"rangerArguments" : { },
"icebergArguments" : { },
"atlasReplicationArguments" : { },
"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" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
}, {
"name" : "...",
"description" : "...",
"hourlySnapshots" : 12345,
"dailySnapshots" : 12345,
"weeklySnapshots" : 12345,
"monthlySnapshots" : 12345,
"yearlySnapshots" : 12345,
"minuteOfHour" : 12345,
"hoursForHourlySnapshots" : [ 12345, 12345 ],
"hourOfDay" : 12345,
"dayOfWeek" : 12345,
"dayOfMonth" : 12345,
"monthOfYear" : 12345,
"alertOnStart" : true,
"alertOnSuccess" : true,
"alertOnFail" : true,
"alertOnAbort" : true,
"hbaseArguments" : { },
"hdfsArguments" : { },
"ozoneArguments" : { },
"lastCommand" : { },
"lastSuccessfulCommand" : { },
"paused" : true
} ],
"entityStatus" : "NONE",
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ],
"serviceVersion" : "..."
} ]
},
"description" : "A list of services."
}
,
"ApiServiceRef" : {
"type" : "object",
"title" : "ApiServiceRef",
"properties" : {
"peerName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The enclosing cluster for this service.",
"type" : "string"
},
"clusterDisplayName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"serviceName" : {
"readOnly" : false,
"description" : "The service name.",
"type" : "string"
},
"serviceDisplayName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"serviceType" : {
"readOnly" : false,
"description" : "The service type. This is available since version 32",
"type" : "string"
}
},
"example" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ShutdownReadinessState"
}
},
"example" : {
"state" : "READY"
},
"description" : "Cloudera Manager server's shutdown readiness"
}
,
"ApiSimpleRollingRestartClusterArgs" : {
"type" : "object",
"title" : "ApiSimpleRollingRestartClusterArgs",
"properties" : {
"slaveBatchSize" : {
"readOnly" : false,
"description" : "Number of hosts with slave roles to restart at a time.\nMust be greater than zero. Default is 1.",
"type" : "integer",
"format" : "int32"
},
"sleepSeconds" : {
"readOnly" : false,
"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",
"format" : "int32"
},
"slaveFailCountThreshold" : {
"readOnly" : false,
"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<\/p>",
"type" : "integer",
"format" : "int32"
}
},
"example" : {
"slaveBatchSize" : 12345,
"sleepSeconds" : 12345,
"slaveFailCountThreshold" : 12345
},
"description" : "Basic arguments used for Rolling Restart Cluster commands."
}
,
"ApiSnapshotCommand" : {
"type" : "object",
"title" : "ApiSnapshotCommand",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiCommand"
},
{
"properties" : {
"hbaseResult" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHBaseSnapshotResult"
},
"hdfsResult" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHdfsSnapshotResult"
},
"ozoneResult" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiOzoneSnapshotResult"
}
}
}
],
"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" : "REMOTE_S3",
"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" : "..."
} ]
},
"ozoneResult" : {
"processedBucketCount" : 12345,
"processedBuckets" : [ "...", "..." ],
"unprocessedBucketCount" : 12345,
"unprocessedBuckets" : [ "...", "..." ],
"createdSnapshotCount" : 12345,
"createdSnapshots" : [ {
"snapshotRef" : { },
"creationTime" : 12345
}, {
"snapshotRef" : { },
"creationTime" : 12345
} ],
"deletedSnapshotCount" : 12345,
"deletedSnapshots" : [ {
"snapshotRef" : { },
"creationTime" : 12345
}, {
"snapshotRef" : { },
"creationTime" : 12345
} ],
"creationErrorCount" : 12345,
"creationErrors" : [ {
"snapshotRef" : { },
"error" : "..."
}, {
"snapshotRef" : { },
"error" : "..."
} ],
"deletionErrorCount" : 12345,
"deletionErrors" : [ {
"snapshotRef" : { },
"error" : "..."
}, {
"snapshotRef" : { },
"error" : "..."
} ]
},
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"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" : "...",
"clusterDisplayName" : "...",
"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 snapshot commands.\n \nAvailable since API v11.",
"type" : "string"
},
"minEntityDisplayName" : {
"readOnly" : false,
"description" : "The display name of the entity that had the minimum value for the\ncross-entity aggregate metric.",
"type" : "string"
},
"minEntityName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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",
"format" : "double"
}
},
"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" : {
"readOnly" : false,
"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",
"format" : "date-time"
},
"value" : {
"readOnly" : false,
"description" : "The value of the time series data.",
"type" : "number"
},
"type" : {
"readOnly" : false,
"description" : "The type of the time series data.",
"type" : "string"
},
"aggregateStatistics" : {
"readOnly" : false,
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "Name of the of the attribute.\nThis name uniquely identifies this attribute.",
"type" : "string"
},
"displayName" : {
"readOnly" : false,
"description" : "Display name of the attribute.",
"type" : "string"
},
"description" : {
"readOnly" : false,
"description" : "Description of the attribute.",
"type" : "string"
},
"isValueCaseSensitive" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "Returns the name of the entity type. This name uniquely identifies this\nentity type.",
"type" : "string"
},
"category" : {
"readOnly" : false,
"description" : "Returns the category of the entity type.",
"type" : "string"
},
"nameForCrossEntityAggregateMetrics" : {
"readOnly" : false,
"description" : "Returns the string to use to pluralize the name of the entity for cross\nentity aggregate metrics.",
"type" : "string"
},
"displayName" : {
"readOnly" : false,
"description" : "Returns the display name of the entity type.",
"type" : "string"
},
"description" : {
"readOnly" : false,
"description" : "Returns the description of the entity type.",
"type" : "string"
},
"immutableAttributeNames" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "The metric name for the time series.",
"type" : "string"
},
"entityName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The start time for the time series.",
"type" : "string",
"format" : "date-time"
},
"endTime" : {
"readOnly" : false,
"description" : "The end time for the time series.",
"type" : "string",
"format" : "date-time"
},
"attributes" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The numerators of the units for the time series.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"unitDenominators" : {
"readOnly" : false,
"description" : "The denominators of the units for the time series.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"expression" : {
"readOnly" : false,
"description" : "The tsquery expression that could be used to extract just this stream.",
"type" : "string"
},
"alias" : {
"readOnly" : false,
"description" : "The alias for this stream's metric. Aliases correspond to use of the 'as'\nkeyword in the tsquery.",
"type" : "string"
},
"metricCollectionFrequencyMs" : {
"readOnly" : false,
"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",
"format" : "int64"
},
"rollupUsed" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "tsquery to run against the CM time-series data store.\nPlease see the \ntsquery language documentation<\/a>.",
"type" : "string"
},
"from" : {
"readOnly" : false,
"description" : "Start of the period to query in ISO 8601 format (defaults to 5 minutes\nbefore the end of the period).",
"type" : "string"
},
"to" : {
"readOnly" : false,
"description" : "End of the period to query in ISO 8601 format (defaults to current time).",
"type" : "string"
},
"contentType" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The time series data for this single query response.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiTimeSeries"
}
},
"warnings" : {
"readOnly" : false,
"description" : "The warnings for this single query response.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"timeSeriesQuery" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "The list of responses for this query response list.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiTimeSeriesResponse"
}
}
}
}
],
"example" : {
"items" : [ {
"timeSeries" : [ {
"metadata" : { },
"data" : [ { }, { } ]
}, {
"metadata" : { },
"data" : [ { }, { } ]
} ],
"warnings" : [ "...", "..." ],
"timeSeriesQuery" : "..."
}, {
"timeSeries" : [ {
"metadata" : { },
"data" : [ { }, { } ]
}, {
"metadata" : { },
"data" : [ { }, { } ]
} ],
"warnings" : [ "...", "..." ],
"timeSeriesQuery" : "..."
} ]
},
"description" : "A generic list."
}
,
"ApiTransferFileReq" : {
"type" : "object",
"title" : "ApiTransferFileReq",
"properties" : {
"sourceService" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiServiceRef"
},
"sourceProxyUser" : {
"readOnly" : false,
"description" : "User on the source cluster accessing the source file.",
"type" : "string"
},
"sourcePath" : {
"readOnly" : false,
"description" : "Path of the source file to be transferred.\n\nAfter a successful transfer, this file will be deleted.",
"type" : "string"
},
"sourceAdditionalConfigs" : {
"readOnly" : false,
"description" : "A map of additional configuration options for the source file system.\nThese will override the values gathered automatically by getting the\nclient configuration of the source service.\n\n \nThe paths should be absolute paths without<\/b> protocol and HDFS namenode address/Ozone service ID.\nExample: \nBased on the values of com.cloudera.enterprise.distcp.util.StatusTypes.\n<\/p>",
"type" : "string"
},
"fromSequenceFile" : {
"readOnly" : false,
"description" : "Absolute path (including protocol and HDFS namenode address/Ozone service ID) to the source sequence file.\n \nThis file must exist<\/b> before calling the endpoint\nExample: \nThis file must exist<\/b> before calling the endpoint\n<\/p>",
"type" : "string"
},
"toSequenceFile" : {
"readOnly" : false,
"description" : "Absolute path (including protocol and HDFS namenode address/Ozone service ID) to the destination sequence file.\n \nThis file must not exist<\/b> before calling the endpoint\n<\/p>",
"type" : "string"
},
"toRenameDeleteSequenceFile" : {
"readOnly" : false,
"description" : "Absolute path (including protocol and HDFS namenode address/Ozone service ID) to the destination rename/delete sequence file.\n \nThis file must not exist<\/b> before calling the endpoint\n<\/p>",
"type" : "string"
},
"additionalConfigs" : {
"readOnly" : false,
"description" : "A map of additional configuration options for the transformation.\nThese will be merged with the configuration gathered for the command automatically.\n \nPasswords are not returned when querying user information, so this\nproperty will always be empty when reading information from a server.",
"type" : "string"
},
"roles" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "NOTE: Only available in the \"export\" view",
"type" : "string"
},
"pwSalt" : {
"readOnly" : false,
"description" : "NOTE: Only available in the \"export\" view",
"type" : "integer",
"format" : "int64"
},
"pwLogin" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The username, which is unique within a Cloudera Manager installation.",
"type" : "string"
},
"password" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "A list of ApiAuthRole that this user possesses.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiAuthRoleRef"
}
},
"pwHash" : {
"readOnly" : false,
"description" : "NOTE: Optional. Only available in the \"export\" view.",
"type" : "string"
},
"pwSalt" : {
"readOnly" : false,
"description" : "NOTE: Optional. Only available in the \"export\" view.",
"type" : "integer",
"format" : "int64"
},
"pwLogin" : {
"readOnly" : false,
"description" : "NOTE: Optional. 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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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",
"format" : "date-time"
}
},
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiUserSession"
}
}
}
}
],
"example" : {
"items" : [ {
"name" : "...",
"remoteAddr" : "...",
"lastRequest" : "..."
}, {
"name" : "...",
"remoteAddr" : "...",
"lastRequest" : "..."
} ]
},
"description" : "A list of user sessions."
}
,
"ApiVersionInfo" : {
"type" : "object",
"title" : "ApiVersionInfo",
"properties" : {
"version" : {
"readOnly" : false,
"description" : "Version.",
"type" : "string"
},
"snapshot" : {
"readOnly" : false,
"description" : "Whether this build is a development snapshot.",
"type" : "boolean"
},
"buildUser" : {
"readOnly" : false,
"description" : "The user performing the build.",
"type" : "string"
},
"buildTimestamp" : {
"readOnly" : false,
"description" : "Build timestamp.",
"type" : "string"
},
"gitHash" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"path" : "..."
},
"description" : ""
}
,
"ApiWatchedDirList" : {
"type" : "object",
"title" : "ApiWatchedDirList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiWatchedDir"
}
}
}
}
],
"example" : {
"items" : [ {
"path" : "..."
}, {
"path" : "..."
} ]
},
"description" : "A list of watched directories."
}
,
"ApiYarnApplication" : {
"type" : "object",
"title" : "ApiYarnApplication",
"properties" : {
"allocatedMB" : {
"readOnly" : false,
"description" : "The sum of memory in MB allocated to the application's running containers\nAvailable since v12.",
"type" : "integer",
"format" : "int32"
},
"allocatedVCores" : {
"readOnly" : false,
"description" : "The sum of virtual cores allocated to the application's running containers\nAvailable since v12.",
"type" : "integer",
"format" : "int32"
},
"runningContainers" : {
"readOnly" : false,
"description" : "The number of containers currently running for the application\nAvailable since v12.",
"type" : "integer",
"format" : "int32"
},
"applicationTags" : {
"readOnly" : false,
"description" : "List of YARN application tags. Available since v12.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"allocatedMemorySeconds" : {
"readOnly" : false,
"description" : "Allocated memory to the application in units of mb-secs.\nAvailable since v12.",
"type" : "integer",
"format" : "int64"
},
"allocatedVcoreSeconds" : {
"readOnly" : false,
"description" : "Allocated vcore-secs to the application. Available since v12.",
"type" : "integer",
"format" : "int64"
},
"applicationId" : {
"readOnly" : false,
"description" : "The application id.",
"type" : "string"
},
"name" : {
"readOnly" : false,
"description" : "The name of the application.",
"type" : "string"
},
"startTime" : {
"readOnly" : false,
"description" : "The time the application was submitted.",
"type" : "string",
"format" : "date-time"
},
"endTime" : {
"readOnly" : false,
"description" : "The time the application finished. If the application hasn't finished\nthis will return null.",
"type" : "string",
"format" : "date-time"
},
"user" : {
"readOnly" : false,
"description" : "The user who submitted the application.",
"type" : "string"
},
"pool" : {
"readOnly" : false,
"description" : "The pool the application was submitted to.",
"type" : "string"
},
"progress" : {
"readOnly" : false,
"description" : "The progress, as a percentage, the application has made. This is only\nset if the application is currently executing.",
"type" : "number"
},
"attributes" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiMr2AppInformation"
},
"state" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"containerUsedMemorySeconds" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The type of the attribute. Valid types are STRING, NUMBER, BOOLEAN, BYTES,\nMILLISECONDS, BYTES_PER_SECOND, BYTE_SECONDS.",
"type" : "string"
},
"displayName" : {
"readOnly" : false,
"description" : "The display name for the attribute.",
"type" : "string"
},
"supportsHistograms" : {
"readOnly" : false,
"description" : "Whether the Service Monitor can generate a histogram of the distribution\nof the attribute across applications.",
"type" : "boolean"
},
"description" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "The list of attributes.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "Id's of the applications whose diagnostics data has to be collected",
"type" : "array",
"items" : {
"type" : "string"
}
},
"ticketNumber" : {
"readOnly" : false,
"description" : "Ticket Number of the Cloudera Support Ticket",
"type" : "string"
},
"comments" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The list of applications for this response.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiYarnApplication"
}
},
"warnings" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Name of the tenant.",
"type" : "string"
},
"avgYarnCpuAllocation" : {
"readOnly" : false,
"description" : "Average number of VCores allocated to YARN applications of the tenant.",
"type" : "number"
},
"avgYarnCpuUtilization" : {
"readOnly" : false,
"description" : "Average number of VCores used by YARN applications of the tenant.",
"type" : "number"
},
"avgYarnCpuUnusedCapacity" : {
"readOnly" : false,
"description" : "Average unused VCores of the tenant.",
"type" : "number"
},
"avgYarnCpuSteadyFairShare" : {
"readOnly" : false,
"description" : "Average steady fair share VCores.",
"type" : "number"
},
"avgYarnPoolAllocatedCpuDuringContention" : {
"readOnly" : false,
"description" : "Average allocated Vcores with pending containers.",
"type" : "number"
},
"avgYarnPoolFairShareCpuDuringContention" : {
"readOnly" : false,
"description" : "Average fair share VCores with pending containers.",
"type" : "number"
},
"avgYarnPoolSteadyFairShareCpuDuringContention" : {
"readOnly" : false,
"description" : "Average steady fair share VCores with pending containers.",
"type" : "number"
},
"avgYarnContainerWaitRatio" : {
"readOnly" : false,
"description" : "Average percentage of pending containers for the pool during periods of\ncontention.",
"type" : "number"
},
"avgYarnMemoryAllocation" : {
"readOnly" : false,
"description" : "Average memory allocated to YARN applications of the tenant.",
"type" : "number"
},
"avgYarnMemoryUtilization" : {
"readOnly" : false,
"description" : "Average memory used by YARN applications of the tenant.",
"type" : "number"
},
"avgYarnMemoryUnusedCapacity" : {
"readOnly" : false,
"description" : "Average unused memory of the tenant.",
"type" : "number"
},
"avgYarnMemorySteadyFairShare" : {
"readOnly" : false,
"description" : "Average steady fair share memory.",
"type" : "number"
},
"avgYarnPoolAllocatedMemoryDuringContention" : {
"readOnly" : false,
"description" : "Average allocated memory with pending containers.",
"type" : "number"
},
"avgYarnPoolFairShareMemoryDuringContention" : {
"readOnly" : false,
"description" : "Average fair share memory with pending containers.",
"type" : "number"
},
"avgYarnPoolSteadyFairShareMemoryDuringContention" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/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" : {
"readOnly" : false,
"description" : "Average number of VCores used by YARN applications during the report\nwindow.",
"type" : "number"
},
"maxCpuUtilization" : {
"readOnly" : false,
"description" : "Maximum number of VCores used by YARN applications during the report\nwindow.",
"type" : "number"
},
"avgCpuDailyPeak" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Timestamp corresponds to maximum number of VCores used by YARN applications\nduring the report window.",
"type" : "integer",
"format" : "int64"
},
"avgCpuUtilizationPercentage" : {
"readOnly" : false,
"description" : "Average percentage of VCores used by YARN applications during the report\nwindow.",
"type" : "number"
},
"maxCpuUtilizationPercentage" : {
"readOnly" : false,
"description" : "Maximum percentage of VCores used by YARN applications during the report\nwindow.",
"type" : "number"
},
"avgCpuDailyPeakPercentage" : {
"readOnly" : false,
"description" : "Average daily peak percentage of VCores used by YARN applications during\nthe report window.",
"type" : "number"
},
"avgMemoryUtilization" : {
"readOnly" : false,
"description" : "Average memory used by YARN applications during the report window.",
"type" : "number"
},
"maxMemoryUtilization" : {
"readOnly" : false,
"description" : "Maximum memory used by YARN applications during the report window.",
"type" : "number"
},
"avgMemoryDailyPeak" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Timestamp corresponds to maximum memory used by YARN applications during\nthe report window.",
"type" : "integer",
"format" : "int64"
},
"avgMemoryUtilizationPercentage" : {
"readOnly" : false,
"description" : "Average percentage memory used by YARN applications during the report window.",
"type" : "number"
},
"maxMemoryUtilizationPercentage" : {
"readOnly" : false,
"description" : "Maximum percentage of memory used by YARN applications during the report window.",
"type" : "number"
},
"avgMemoryDailyPeakPercentage" : {
"readOnly" : false,
"description" : "Average daily peak percentage of memory used by YARN applications during the report\nwindow.",
"type" : "number"
},
"tenantUtilizations" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiYarnTenantUtilizationList"
},
"errorMessage" : {
"readOnly" : false,
"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."
}
,
"AutoConfigApplicability" : {
"type" : "string",
"title" : "AutoConfigApplicability",
"enum" : [
"RECONFIGURABLE",
"UNAFFECTED_DUE_TO_EQUAL_VALUE",
"UNAFFECTED_CONFIGURED_BY_USER"
],
"description" : "Specific states to describe extra info on a configuration that has been\nprocessed by the rules engine.\nThis is used to return extra info for consumers of the 'reallocateMemory' API"
}
,
"BaseApiSshCmdArguments" : {
"type" : "object",
"title" : "BaseApiSshCmdArguments",
"properties" : {
"sshPort" : {
"example" : 22,
"readOnly" : false,
"description" : "SSH port. If unset, defaults to 22.",
"type" : "integer",
"format" : "int32"
},
"userName" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The private key to authenticate with the hosts.\nSpecify either this or a password.\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<\/em> and\nendTime<\/em> 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",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"timestamp\" : \"...\",\n \"service\" : \"...\",\n \"username\" : \"...\",\n \"impersonator\" : \"...\",\n \"ipAddress\" : \"...\",\n \"command\" : \"...\",\n \"resource\" : \"...\",\n \"operationText\" : \"...\",\n \"allowed\" : true,\n \"serviceValues\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n }, {\n \"timestamp\" : \"...\",\n \"service\" : \"...\",\n \"username\" : \"...\",\n \"impersonator\" : \"...\",\n \"ipAddress\" : \"...\",\n \"command\" : \"...\",\n \"resource\" : \"...\",\n \"operationText\" : \"...\",\n \"allowed\" : true,\n \"serviceValues\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiAuditList"
}
}
},
"description" : "List of audits in descending order of timestamp"
}
},
"parameters" : [
{
"name" : "endTime",
"in" : "query",
"schema" : {
"default" : "now",
"type" : "string"
},
"description" : "End of the period to query in ISO 8601 format (defaults to\ncurrent time)."
},
{
"name" : "maxResults",
"in" : "query",
"schema" : {
"default" : "100",
"type" : "integer",
"format" : "int32"
},
"description" : "Maximum number of audits to return"
},
{
"name" : "query",
"in" : "query",
"schema" : {
"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<\/p>\n \nThe only supported operator is \";\"<\/em> (Boolean AND). Boolean OR is\nnot supported.\n \nThe supported comparators are ==<\/em> and !=<\/em>\nNote that \"LIKE\" comparison is supported using the wild card syntax,\nfor example foo==*value*<\/em>. 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",
"schema" : {
"default" : "0",
"type" : "integer",
"format" : "int32"
},
"description" : "Offset of audits to return"
},
{
"name" : "startTime",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "Start of the period to query in ISO 8601 format (defaults\nto 1 day ago relative to endTime)."
}
]
}
},
"\/audits/stream" : {
"get" : {
"tags" : [ "AuditsResource" ],
"operationId" : "streamAudits",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"description" : "",
"type" : "string"
}
}
},
"description" : ""
}
},
"parameters" : [
{
"name" : "endTime",
"in" : "query",
"schema" : {
"default" : "now",
"type" : "string"
},
"description" : ""
},
{
"name" : "maxResults",
"in" : "query",
"schema" : {
"default" : "100",
"type" : "integer",
"format" : "int32"
},
"description" : ""
},
{
"name" : "query",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "resultOffset",
"in" : "query",
"schema" : {
"default" : "0",
"type" : "integer",
"format" : "int32"
},
"description" : ""
},
{
"name" : "startTime",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/authRoleMetadatas" : {
"get" : {
"tags" : [ "AuthRoleMetadatasResource" ],
"description" : "Returns a list of the auth roles' metadata for the built-in roles.",
"operationId" : "readAuthRolesMetadata",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"displayName\" : \"...\",\n \"uuid\" : \"...\",\n \"role\" : \"...\",\n \"authorities\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\"\n } ],\n \"allowedScopes\" : [ \"...\", \"...\" ]\n }, {\n \"displayName\" : \"...\",\n \"uuid\" : \"...\",\n \"role\" : \"...\",\n \"authorities\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\"\n } ],\n \"allowedScopes\" : [ \"...\", \"...\" ]\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiAuthRoleMetadataList"
}
}
},
"description" : "A list of auth role metadata"
}
},
"parameters" : [
{
"name" : "view",
"in" : "query",
"schema" : {
"default" : "summary",
"type" : "string",
"enum" : ["EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "FULL_WITH_NO_HEALTH_CHECK", "SUMMARY", "SUMMARY_WITH_NO_HEALTH_CHECK"]
},
"description" : ""
}
]
}
},
"\/authRoles" : {
"get" : {
"tags" : [ "AuthRolesResource" ],
"description" : "Returns a list of the auth roles configured in the system.",
"operationId" : "readAuthRoles",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"clusters\" : [ {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n }, {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n } ],\n \"users\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"externalUserMappings\" : [ {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"EXTERNAL_PROGRAM\"\n }, {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"SAML_ATTRIBUTE\"\n } ],\n \"baseRole\" : {\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"uuid\" : \"...\"\n },\n \"uuid\" : \"...\",\n \"isCustom\" : true\n }, {\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"clusters\" : [ {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n }, {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n } ],\n \"users\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"externalUserMappings\" : [ {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"LDAP\"\n }, {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"EXTERNAL_PROGRAM\"\n } ],\n \"baseRole\" : {\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"uuid\" : \"...\"\n },\n \"uuid\" : \"...\",\n \"isCustom\" : true\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiAuthRoleList"
}
}
},
"description" : "A list of auth roles."
}
},
"parameters" : [
{
"name" : "view",
"in" : "query",
"schema" : {
"default" : "summary",
"type" : "string",
"enum" : ["EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "FULL_WITH_NO_HEALTH_CHECK", "SUMMARY", "SUMMARY_WITH_NO_HEALTH_CHECK"]
},
"description" : ""
}
]
},
"post" : {
"tags" : [ "AuthRolesResource" ],
"description" : "Creates a list of auth roles.",
"operationId" : "createAuthRoles",
"requestBody" : {
"description" : "List of auth roles to create.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"clusters\" : [ {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n }, {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n } ],\n \"users\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"externalUserMappings\" : [ {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"EXTERNAL_PROGRAM\"\n }, {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"LDAP\"\n } ],\n \"baseRole\" : {\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"uuid\" : \"...\"\n },\n \"uuid\" : \"...\",\n \"isCustom\" : true\n }, {\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"clusters\" : [ {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n }, {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n } ],\n \"users\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"externalUserMappings\" : [ {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"SAML_ATTRIBUTE\"\n }, {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"SAML_ATTRIBUTE\"\n } ],\n \"baseRole\" : {\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"uuid\" : \"...\"\n },\n \"uuid\" : \"...\",\n \"isCustom\" : true\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiAuthRoleList"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"clusters\" : [ {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n }, {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n } ],\n \"users\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"externalUserMappings\" : [ {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"EXTERNAL_PROGRAM\"\n }, {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"EXTERNAL_PROGRAM\"\n } ],\n \"baseRole\" : {\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"uuid\" : \"...\"\n },\n \"uuid\" : \"...\",\n \"isCustom\" : true\n }, {\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"clusters\" : [ {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n }, {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n } ],\n \"users\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"externalUserMappings\" : [ {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"EXTERNAL_PROGRAM\"\n }, {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"EXTERNAL_PROGRAM\"\n } ],\n \"baseRole\" : {\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"uuid\" : \"...\"\n },\n \"uuid\" : \"...\",\n \"isCustom\" : true\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiAuthRoleList"
}
}
},
"description" : "Information about created auth roles."
}
},
"parameters" : [
]
}
},
"\/authRoles/metadata" : {
"get" : {
"tags" : [ "AuthRolesResource" ],
"description" : "Returns a list of the auth roles' metadata for the built-in roles.",
"operationId" : "readAuthRolesMetadata",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"displayName\" : \"...\",\n \"uuid\" : \"...\",\n \"role\" : \"...\",\n \"authorities\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\"\n } ],\n \"allowedScopes\" : [ \"...\", \"...\" ]\n }, {\n \"displayName\" : \"...\",\n \"uuid\" : \"...\",\n \"role\" : \"...\",\n \"authorities\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\"\n } ],\n \"allowedScopes\" : [ \"...\", \"...\" ]\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiAuthRoleMetadataList"
}
}
},
"description" : "A list of auth role metadata"
}
},
"parameters" : [
{
"name" : "view",
"in" : "query",
"schema" : {
"default" : "summary",
"type" : "string",
"enum" : ["EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "FULL_WITH_NO_HEALTH_CHECK", "SUMMARY", "SUMMARY_WITH_NO_HEALTH_CHECK"]
},
"description" : ""
}
]
}
},
"\/authRoles/{uuid}" : {
"delete" : {
"tags" : [ "AuthRolesResource" ],
"description" : "Deletes an auth role from the system.\n",
"operationId" : "deleteAuthRole",
"responses" : {
"204" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"clusters\" : [ {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n }, {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n } ],\n \"users\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"externalUserMappings\" : [ {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"EXTERNAL_PROGRAM\"\n }, {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"LDAP\"\n } ],\n \"baseRole\" : {\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"uuid\" : \"...\"\n },\n \"uuid\" : \"...\",\n \"isCustom\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiAuthRole"
}
}
},
"description" : "The details of the deleted auth role."
}
},
"parameters" : [
{
"name" : "uuid",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The uuid of the auth role to delete."
}
]
},
"get" : {
"tags" : [ "AuthRolesResource" ],
"description" : "Returns detailed information about an auth role.",
"operationId" : "readAuthRole",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"clusters\" : [ {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n }, {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n } ],\n \"users\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"externalUserMappings\" : [ {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"LDAP\"\n }, {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"SAML_ATTRIBUTE\"\n } ],\n \"baseRole\" : {\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"uuid\" : \"...\"\n },\n \"uuid\" : \"...\",\n \"isCustom\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiAuthRole"
}
}
},
"description" : "The auth role's information."
}
},
"parameters" : [
{
"name" : "uuid",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The auth role to read."
}
]
},
"put" : {
"tags" : [ "AuthRolesResource" ],
"description" : "Updates the given auth role's information.",
"operationId" : "updateAuthRole",
"requestBody" : {
"description" : "The auth role information.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"clusters\" : [ {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n }, {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n } ],\n \"users\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"externalUserMappings\" : [ {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"SAML_ATTRIBUTE\"\n }, {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"LDAP\"\n } ],\n \"baseRole\" : {\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"uuid\" : \"...\"\n },\n \"uuid\" : \"...\",\n \"isCustom\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiAuthRole"
}
}
}
},
"responses" : {
"204" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"clusters\" : [ {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n }, {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n } ],\n \"users\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"externalUserMappings\" : [ {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"LDAP\"\n }, {\n \"uuid\" : \"...\",\n \"name\" : \"...\",\n \"type\" : \"EXTERNAL_PROGRAM\"\n } ],\n \"baseRole\" : {\n \"displayName\" : \"...\",\n \"name\" : \"...\",\n \"uuid\" : \"...\"\n },\n \"uuid\" : \"...\",\n \"isCustom\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiAuthRole"
}
}
},
"description" : ""
}
},
"parameters" : [
{
"name" : "uuid",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Uuid of the auth role being updated."
}
]
}
},
"\/batch" : {
"post" : {
"tags" : [ "BatchResource" ],
"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",
"requestBody" : {
"description" : "Batch of request to execute.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"method\" : \"POST\",\n \"url\" : \"...\",\n \"body\" : { },\n \"contentType\" : \"...\",\n \"acceptType\" : \"...\"\n }, {\n \"method\" : \"GET\",\n \"url\" : \"...\",\n \"body\" : { },\n \"contentType\" : \"...\",\n \"acceptType\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiBatchRequest"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"statusCode\" : 12345,\n \"response\" : { }\n }, {\n \"statusCode\" : 12345,\n \"response\" : { }\n } ],\n \"success\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiBatchResponse"
}
}
},
"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."
}
},
"parameters" : [
]
}
},
"\/cdp/createEnvironment" : {
"post" : {
"tags" : [ "CdpResource" ],
"description" : "Create an environment in ECS",
"operationId" : "createEnvironmentCommand",
"requestBody" : {
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"cmUser\" : \"...\",\n \"cmPass\" : \"...\",\n \"cmAddress\" : \"...\",\n \"clusterName\" : \"...\",\n \"envName\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCreateEnvironment"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "command info"
}
},
"parameters" : [
{
"name" : "serviceName",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/cdp/remoteContext" : {
"post" : {
"tags" : [ "CdpResource" ],
"description" : "Create or update the remote data context in the Workload cluster.",
"operationId" : "postRemoteContext",
"requestBody" : {
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"endPointId\" : \"...\",\n \"endPoints\" : [ {\n \"name\" : \"...\",\n \"version\" : \"...\",\n \"serviceConfigs\" : [ {\n \"key\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"key\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"endPointHostList\" : [ {\n \"uri\" : \"...\",\n \"endPointConfigs\" : [ { }, { } ],\n \"type\" : \"...\"\n }, {\n \"uri\" : \"...\",\n \"endPointConfigs\" : [ { }, { } ],\n \"type\" : \"...\"\n } ],\n \"serviceType\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"version\" : \"...\",\n \"serviceConfigs\" : [ {\n \"key\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"key\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"endPointHostList\" : [ {\n \"uri\" : \"...\",\n \"endPointConfigs\" : [ { }, { } ],\n \"type\" : \"...\"\n }, {\n \"uri\" : \"...\",\n \"endPointConfigs\" : [ { }, { } ],\n \"type\" : \"...\"\n } ],\n \"serviceType\" : \"...\"\n } ],\n \"configs\" : [ {\n \"key\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"key\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"clusterVersion\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRemoteDataContext"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"endPointId\" : \"...\",\n \"endPoints\" : [ {\n \"name\" : \"...\",\n \"version\" : \"...\",\n \"serviceConfigs\" : [ {\n \"key\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"key\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"endPointHostList\" : [ {\n \"uri\" : \"...\",\n \"endPointConfigs\" : [ { }, { } ],\n \"type\" : \"...\"\n }, {\n \"uri\" : \"...\",\n \"endPointConfigs\" : [ { }, { } ],\n \"type\" : \"...\"\n } ],\n \"serviceType\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"version\" : \"...\",\n \"serviceConfigs\" : [ {\n \"key\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"key\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"endPointHostList\" : [ {\n \"uri\" : \"...\",\n \"endPointConfigs\" : [ { }, { } ],\n \"type\" : \"...\"\n }, {\n \"uri\" : \"...\",\n \"endPointConfigs\" : [ { }, { } ],\n \"type\" : \"...\"\n } ],\n \"serviceType\" : \"...\"\n } ],\n \"configs\" : [ {\n \"key\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"key\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"clusterVersion\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRemoteDataContext"
}
}
},
"description" : "json describing"
}
},
"parameters" : [
]
}
},
"\/cdp/remoteContext/byCluster/{clusterName}" : {
"get" : {
"tags" : [ "CdpResource" ],
"description" : "Get a JSON for creating a remote data context in a Workload cluster.",
"operationId" : "getRemoteContextByCluster",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"endPointId\" : \"...\",\n \"endPoints\" : [ {\n \"name\" : \"...\",\n \"version\" : \"...\",\n \"serviceConfigs\" : [ {\n \"key\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"key\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"endPointHostList\" : [ {\n \"uri\" : \"...\",\n \"endPointConfigs\" : [ { }, { } ],\n \"type\" : \"...\"\n }, {\n \"uri\" : \"...\",\n \"endPointConfigs\" : [ { }, { } ],\n \"type\" : \"...\"\n } ],\n \"serviceType\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"version\" : \"...\",\n \"serviceConfigs\" : [ {\n \"key\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"key\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"endPointHostList\" : [ {\n \"uri\" : \"...\",\n \"endPointConfigs\" : [ { }, { } ],\n \"type\" : \"...\"\n }, {\n \"uri\" : \"...\",\n \"endPointConfigs\" : [ { }, { } ],\n \"type\" : \"...\"\n } ],\n \"serviceType\" : \"...\"\n } ],\n \"configs\" : [ {\n \"key\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"key\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"clusterVersion\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRemoteDataContext"
}
}
},
"description" : "json describing"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the DataContext."
}
]
}
},
"\/cdp/remoteContext/byContext/{dataContextName}" : {
"get" : {
"tags" : [ "CdpResource" ],
"description" : "Get a JSON for creating a remote data context in a Workload cluster.",
"operationId" : "getRemoteContext",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"endPointId\" : \"...\",\n \"endPoints\" : [ {\n \"name\" : \"...\",\n \"version\" : \"...\",\n \"serviceConfigs\" : [ {\n \"key\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"key\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"endPointHostList\" : [ {\n \"uri\" : \"...\",\n \"endPointConfigs\" : [ { }, { } ],\n \"type\" : \"...\"\n }, {\n \"uri\" : \"...\",\n \"endPointConfigs\" : [ { }, { } ],\n \"type\" : \"...\"\n } ],\n \"serviceType\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"version\" : \"...\",\n \"serviceConfigs\" : [ {\n \"key\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"key\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"endPointHostList\" : [ {\n \"uri\" : \"...\",\n \"endPointConfigs\" : [ { }, { } ],\n \"type\" : \"...\"\n }, {\n \"uri\" : \"...\",\n \"endPointConfigs\" : [ { }, { } ],\n \"type\" : \"...\"\n } ],\n \"serviceType\" : \"...\"\n } ],\n \"configs\" : [ {\n \"key\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"key\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"clusterVersion\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRemoteDataContext"
}
}
},
"description" : "json describing"
}
},
"parameters" : [
{
"name" : "dataContextName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the DataContext."
}
]
}
},
"\/certs/generateCertificate" : {
"post" : {
"tags" : [ "CertManagerResource" ],
"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",
"requestBody" : {
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"hostname\" : \"...\",\n \"csr\" : \"...\",\n \"token\" : \"...\",\n \"subjectAltNames\" : [ \"...\", \"...\" ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCertificateRequest"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/octet-stream" : {
"schema" : {
"description" : "",
"type" : "string",
"format" : "binary"
}
}
},
"description" : "tar file containing TLS certificate"
}
},
"parameters" : [
]
}
},
"\/certs/truststore" : {
"get" : {
"tags" : [ "CertManagerResource" ],
"description" : "Gets the Auto-TLS truststore contents",
"operationId" : "getTruststore",
"responses" : {
"200" : {
"content" : {
"application/octet-stream" : {
"schema" : {
"description" : "",
"type" : "string",
"format" : "binary"
}
}
},
"description" : "truststore file contents"
}
},
"parameters" : [
{
"name" : "type",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "truststore type. Must be \"JKS\" or \"PEM\"."
}
]
}
},
"\/certs/truststorePassword" : {
"get" : {
"tags" : [ "CertManagerResource" ],
"description" : "Gets the configured CM truststore password",
"operationId" : "getTruststorePassword",
"responses" : {
"200" : {
"content" : {
"text/plain" : {
"schema" : {
"description" : "",
"type" : "string"
}
}
},
"description" : "truststore password"
}
},
"parameters" : [
]
}
},
"\/clusters" : {
"get" : {
"tags" : [ "ClustersResource" ],
"description" : "List all known clusters.",
"operationId" : "readClusters",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"name\" : \"...\",\n \"displayName\" : \"...\",\n \"fullVersion\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CONTROL_PLANE\", \"HOST\" ],\n \"services\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : { },\n \"serviceState\" : \"UNKNOWN\",\n \"healthSummary\" : \"DISABLED\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"clientConfigStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"CONTROL_PLANE\" ],\n \"config\" : { },\n \"roles\" : [ { }, { } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ { }, { } ],\n \"replicationSchedules\" : [ { }, { } ],\n \"snapshotPolicies\" : [ { }, { } ],\n \"entityStatus\" : \"GOOD_HEALTH\",\n \"tags\" : [ { }, { } ],\n \"serviceVersion\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : { },\n \"serviceState\" : \"UNKNOWN\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"FRESH\",\n \"clientConfigStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ { }, { } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"SERVICE\" ],\n \"config\" : { },\n \"roles\" : [ { }, { } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ { }, { } ],\n \"replicationSchedules\" : [ { }, { } ],\n \"snapshotPolicies\" : [ { }, { } ],\n \"entityStatus\" : \"STARTING\",\n \"tags\" : [ { }, { } ],\n \"serviceVersion\" : \"...\"\n } ],\n \"parcels\" : [ {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : { },\n \"clusterRef\" : { },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n }, {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : { },\n \"clusterRef\" : { },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n } ],\n \"clusterUrl\" : \"...\",\n \"hostsUrl\" : \"...\",\n \"entityStatus\" : \"STARTING\",\n \"uuid\" : \"...\",\n \"dataContextRefs\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"clusterType\" : \"...\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n }, {\n \"name\" : \"...\",\n \"displayName\" : \"...\",\n \"fullVersion\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"HOST\" ],\n \"services\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : { },\n \"serviceState\" : \"STOPPED\",\n \"healthSummary\" : \"GOOD\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"clientConfigStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"SERVICE\", \"ROLE\" ],\n \"config\" : { },\n \"roles\" : [ { }, { } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ { }, { } ],\n \"replicationSchedules\" : [ { }, { } ],\n \"snapshotPolicies\" : [ { }, { } ],\n \"entityStatus\" : \"GOOD_HEALTH\",\n \"tags\" : [ { }, { } ],\n \"serviceVersion\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : { },\n \"serviceState\" : \"STARTING\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"STALE\",\n \"clientConfigStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"CONTROL_PLANE\" ],\n \"config\" : { },\n \"roles\" : [ { }, { } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ { }, { } ],\n \"replicationSchedules\" : [ { }, { } ],\n \"snapshotPolicies\" : [ { }, { } ],\n \"entityStatus\" : \"BAD_HEALTH\",\n \"tags\" : [ { }, { } ],\n \"serviceVersion\" : \"...\"\n } ],\n \"parcels\" : [ {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : { },\n \"clusterRef\" : { },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n }, {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : { },\n \"clusterRef\" : { },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n } ],\n \"clusterUrl\" : \"...\",\n \"hostsUrl\" : \"...\",\n \"entityStatus\" : \"NONE\",\n \"uuid\" : \"...\",\n \"dataContextRefs\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"clusterType\" : \"...\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiClusterList"
}
}
},
"description" : "List of clusters."
}
},
"parameters" : [
{
"name" : "clusterType",
"in" : "query",
"schema" : {
"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",
"schema" : {
"default" : "summary",
"type" : "string",
"enum" : ["EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "FULL_WITH_NO_HEALTH_CHECK", "SUMMARY", "SUMMARY_WITH_NO_HEALTH_CHECK"]
},
"description" : "The view of the data to materialize, either \"summary\" or \"full\"."
}
]
},
"post" : {
"tags" : [ "ClustersResource" ],
"description" : "Creates a collection of clusters.",
"operationId" : "createClusters",
"requestBody" : {
"description" : "List of clusters to created.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"name\" : \"...\",\n \"displayName\" : \"...\",\n \"fullVersion\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"CONTROL_PLANE\" ],\n \"services\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : { },\n \"serviceState\" : \"STOPPING\",\n \"healthSummary\" : \"DISABLED\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"clientConfigStalenessStatus\" : \"STALE\",\n \"healthChecks\" : [ { }, { } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CONTROL_PLANE\", \"SERVICE\" ],\n \"config\" : { },\n \"roles\" : [ { }, { } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ { }, { } ],\n \"replicationSchedules\" : [ { }, { } ],\n \"snapshotPolicies\" : [ { }, { } ],\n \"entityStatus\" : \"UNKNOWN\",\n \"tags\" : [ { }, { } ],\n \"serviceVersion\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : { },\n \"serviceState\" : \"STARTING\",\n \"healthSummary\" : \"BAD\",\n \"configStalenessStatus\" : \"FRESH\",\n \"clientConfigStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"SERVICE\", \"ROLE\" ],\n \"config\" : { },\n \"roles\" : [ { }, { } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ { }, { } ],\n \"replicationSchedules\" : [ { }, { } ],\n \"snapshotPolicies\" : [ { }, { } ],\n \"entityStatus\" : \"GOOD_HEALTH\",\n \"tags\" : [ { }, { } ],\n \"serviceVersion\" : \"...\"\n } ],\n \"parcels\" : [ {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : { },\n \"clusterRef\" : { },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n }, {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : { },\n \"clusterRef\" : { },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n } ],\n \"clusterUrl\" : \"...\",\n \"hostsUrl\" : \"...\",\n \"entityStatus\" : \"GOOD_HEALTH\",\n \"uuid\" : \"...\",\n \"dataContextRefs\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"clusterType\" : \"...\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n }, {\n \"name\" : \"...\",\n \"displayName\" : \"...\",\n \"fullVersion\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CONTROL_PLANE\", \"CONTROL_PLANE\" ],\n \"services\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : { },\n \"serviceState\" : \"STARTED\",\n \"healthSummary\" : \"CONCERNING\",\n \"configStalenessStatus\" : \"STALE\",\n \"clientConfigStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ { }, { } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CONTROL_PLANE\", \"HOST\" ],\n \"config\" : { },\n \"roles\" : [ { }, { } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ { }, { } ],\n \"replicationSchedules\" : [ { }, { } ],\n \"snapshotPolicies\" : [ { }, { } ],\n \"entityStatus\" : \"DISABLED_HEALTH\",\n \"tags\" : [ { }, { } ],\n \"serviceVersion\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : { },\n \"serviceState\" : \"STOPPED\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"FRESH\",\n \"clientConfigStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ { }, { } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"ROLE\" ],\n \"config\" : { },\n \"roles\" : [ { }, { } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ { }, { } ],\n \"replicationSchedules\" : [ { }, { } ],\n \"snapshotPolicies\" : [ { }, { } ],\n \"entityStatus\" : \"DOWN\",\n \"tags\" : [ { }, { } ],\n \"serviceVersion\" : \"...\"\n } ],\n \"parcels\" : [ {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : { },\n \"clusterRef\" : { },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n }, {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : { },\n \"clusterRef\" : { },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n } ],\n \"clusterUrl\" : \"...\",\n \"hostsUrl\" : \"...\",\n \"entityStatus\" : \"UNKNOWN_HEALTH\",\n \"uuid\" : \"...\",\n \"dataContextRefs\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"clusterType\" : \"...\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiClusterList"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"name\" : \"...\",\n \"displayName\" : \"...\",\n \"fullVersion\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"CLUSTER\" ],\n \"services\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : { },\n \"serviceState\" : \"STOPPING\",\n \"healthSummary\" : \"CONCERNING\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"clientConfigStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"ROLE\" ],\n \"config\" : { },\n \"roles\" : [ { }, { } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ { }, { } ],\n \"replicationSchedules\" : [ { }, { } ],\n \"snapshotPolicies\" : [ { }, { } ],\n \"entityStatus\" : \"STARTING\",\n \"tags\" : [ { }, { } ],\n \"serviceVersion\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : { },\n \"serviceState\" : \"STARTED\",\n \"healthSummary\" : \"GOOD\",\n \"configStalenessStatus\" : \"FRESH\",\n \"clientConfigStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"ROLE\" ],\n \"config\" : { },\n \"roles\" : [ { }, { } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ { }, { } ],\n \"replicationSchedules\" : [ { }, { } ],\n \"snapshotPolicies\" : [ { }, { } ],\n \"entityStatus\" : \"CONCERNING_HEALTH\",\n \"tags\" : [ { }, { } ],\n \"serviceVersion\" : \"...\"\n } ],\n \"parcels\" : [ {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : { },\n \"clusterRef\" : { },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n }, {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : { },\n \"clusterRef\" : { },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n } ],\n \"clusterUrl\" : \"...\",\n \"hostsUrl\" : \"...\",\n \"entityStatus\" : \"STOPPING\",\n \"uuid\" : \"...\",\n \"dataContextRefs\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"clusterType\" : \"...\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n }, {\n \"name\" : \"...\",\n \"displayName\" : \"...\",\n \"fullVersion\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"ROLE\" ],\n \"services\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : { },\n \"serviceState\" : \"STARTING\",\n \"healthSummary\" : \"DISABLED\",\n \"configStalenessStatus\" : \"STALE\",\n \"clientConfigStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CONTROL_PLANE\", \"SERVICE\" ],\n \"config\" : { },\n \"roles\" : [ { }, { } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ { }, { } ],\n \"replicationSchedules\" : [ { }, { } ],\n \"snapshotPolicies\" : [ { }, { } ],\n \"entityStatus\" : \"STOPPED\",\n \"tags\" : [ { }, { } ],\n \"serviceVersion\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : { },\n \"serviceState\" : \"HISTORY_NOT_AVAILABLE\",\n \"healthSummary\" : \"BAD\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"clientConfigStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CONTROL_PLANE\", \"CONTROL_PLANE\" ],\n \"config\" : { },\n \"roles\" : [ { }, { } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ { }, { } ],\n \"replicationSchedules\" : [ { }, { } ],\n \"snapshotPolicies\" : [ { }, { } ],\n \"entityStatus\" : \"GOOD_HEALTH\",\n \"tags\" : [ { }, { } ],\n \"serviceVersion\" : \"...\"\n } ],\n \"parcels\" : [ {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : { },\n \"clusterRef\" : { },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n }, {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : { },\n \"clusterRef\" : { },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n } ],\n \"clusterUrl\" : \"...\",\n \"hostsUrl\" : \"...\",\n \"entityStatus\" : \"STOPPED\",\n \"uuid\" : \"...\",\n \"dataContextRefs\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"clusterType\" : \"...\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiClusterList"
}
}
},
"description" : "List of created clusters."
}
},
"parameters" : [
]
}
},
"\/clusters/{clusterName}" : {
"delete" : {
"tags" : [ "ClustersResource" ],
"description" : "Deletes a cluster.",
"operationId" : "deleteCluster",
"responses" : {
"204" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"name\" : \"...\",\n \"displayName\" : \"...\",\n \"fullVersion\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CONTROL_PLANE\", \"CONTROL_PLANE\" ],\n \"services\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"STARTED\",\n \"healthSummary\" : \"CONCERNING\",\n \"configStalenessStatus\" : \"STALE\",\n \"clientConfigStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"NOT_AVAILABLE\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"GOOD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"CLUSTER\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ { }, { } ],\n \"items\" : [ { }, { } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STARTING\",\n \"commissionState\" : \"DECOMMISSIONING\",\n \"healthSummary\" : \"CONCERNING\",\n \"configStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"ACTIVE\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"HOST\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"REPLICATED_OBSERVER\",\n \"entityStatus\" : \"UNKNOWN\",\n \"tags\" : [ { }, { } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STOPPED\",\n \"commissionState\" : \"UNKNOWN\",\n \"healthSummary\" : \"GOOD\",\n \"configStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"UNKNOWN\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"CLUSTER\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"STANDALONE\",\n \"entityStatus\" : \"STOPPING\",\n \"tags\" : [ { }, { } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"MONTH\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"MONTH\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"NONE\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"STOPPED\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"clientConfigStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"CONCERNING\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"DISABLED\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"CONTROL_PLANE\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ { }, { } ],\n \"items\" : [ { }, { } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"BUSY\",\n \"commissionState\" : \"OFFLINING\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"STANDBY\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"HOST\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"STANDALONE\",\n \"entityStatus\" : \"DISABLED_HEALTH\",\n \"tags\" : [ { }, { } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STOPPED\",\n \"commissionState\" : \"DECOMMISSIONING\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"UNKNOWN\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"HOST\", \"SERVICE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"REPLICATED_LEADER\",\n \"entityStatus\" : \"NONE\",\n \"tags\" : [ { }, { } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"YEAR\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"YEAR\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"CONCERNING_HEALTH\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n } ],\n \"parcels\" : [ {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : {\n \"progress\" : 12345,\n \"totalProgress\" : 12345,\n \"count\" : 12345,\n \"totalCount\" : 12345,\n \"errors\" : [ \"...\", \"...\" ],\n \"warnings\" : [ \"...\", \"...\" ]\n },\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n }, {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : {\n \"progress\" : 12345,\n \"totalProgress\" : 12345,\n \"count\" : 12345,\n \"totalCount\" : 12345,\n \"errors\" : [ \"...\", \"...\" ],\n \"warnings\" : [ \"...\", \"...\" ]\n },\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n } ],\n \"clusterUrl\" : \"...\",\n \"hostsUrl\" : \"...\",\n \"entityStatus\" : \"DISABLED_HEALTH\",\n \"uuid\" : \"...\",\n \"dataContextRefs\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"clusterType\" : \"...\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCluster"
}
}
},
"description" : "Details of deleted cluster."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of cluster to delete."
}
]
},
"get" : {
"tags" : [ "ClustersResource" ],
"description" : "Reads information about a cluster.",
"operationId" : "readCluster",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"name\" : \"...\",\n \"displayName\" : \"...\",\n \"fullVersion\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"HOST\", \"CONTROL_PLANE\" ],\n \"services\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"STARTING\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"clientConfigStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"BAD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"DISABLED\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"SERVICE\", \"HOST\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ { }, { } ],\n \"items\" : [ { }, { } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"BUSY\",\n \"commissionState\" : \"OFFLINING\",\n \"healthSummary\" : \"BAD\",\n \"configStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"UNKNOWN\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"CLUSTER\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"STANDALONE\",\n \"entityStatus\" : \"UNKNOWN\",\n \"tags\" : [ { }, { } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STOPPED\",\n \"commissionState\" : \"DECOMMISSIONING\",\n \"healthSummary\" : \"GOOD\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"ACTIVE\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CONTROL_PLANE\", \"ROLE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"STANDALONE\",\n \"entityStatus\" : \"DISABLED_HEALTH\",\n \"tags\" : [ { }, { } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"YEAR\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"HOUR\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"STOPPING\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"STARTED\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"FRESH\",\n \"clientConfigStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"HISTORY_NOT_AVAILABLE\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"NOT_AVAILABLE\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CONTROL_PLANE\", \"CONTROL_PLANE\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ { }, { } ],\n \"items\" : [ { }, { } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"HISTORY_NOT_AVAILABLE\",\n \"commissionState\" : \"DECOMMISSIONED\",\n \"healthSummary\" : \"BAD\",\n \"configStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"UNKNOWN\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"SERVICE\", \"CLUSTER\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"REPLICATED_OBSERVER\",\n \"entityStatus\" : \"UNKNOWN_HEALTH\",\n \"tags\" : [ { }, { } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STOPPED\",\n \"commissionState\" : \"DECOMMISSIONED\",\n \"healthSummary\" : \"DISABLED\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"UNKNOWN\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"HOST\", \"ROLE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"REPLICATED_LEADER_ELECTION\",\n \"entityStatus\" : \"BAD_HEALTH\",\n \"tags\" : [ { }, { } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"DAY\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"MONTH\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"UNKNOWN_HEALTH\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n } ],\n \"parcels\" : [ {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : {\n \"progress\" : 12345,\n \"totalProgress\" : 12345,\n \"count\" : 12345,\n \"totalCount\" : 12345,\n \"errors\" : [ \"...\", \"...\" ],\n \"warnings\" : [ \"...\", \"...\" ]\n },\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n }, {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : {\n \"progress\" : 12345,\n \"totalProgress\" : 12345,\n \"count\" : 12345,\n \"totalCount\" : 12345,\n \"errors\" : [ \"...\", \"...\" ],\n \"warnings\" : [ \"...\", \"...\" ]\n },\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n } ],\n \"clusterUrl\" : \"...\",\n \"hostsUrl\" : \"...\",\n \"entityStatus\" : \"NONE\",\n \"uuid\" : \"...\",\n \"dataContextRefs\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"clusterType\" : \"...\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCluster"
}
}
},
"description" : "Details of requested cluster."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of cluster to look up."
},
{
"name" : "view",
"in" : "query",
"schema" : {
"default" : "summary",
"type" : "string",
"enum" : ["EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "FULL_WITH_NO_HEALTH_CHECK", "SUMMARY", "SUMMARY_WITH_NO_HEALTH_CHECK"]
},
"description" : "The view to materialize"
}
]
},
"put" : {
"tags" : [ "ClustersResource" ],
"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.<\/p>\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",
"requestBody" : {
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"name\" : \"...\",\n \"displayName\" : \"...\",\n \"fullVersion\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"HOST\", \"SERVICE\" ],\n \"services\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"STOPPING\",\n \"healthSummary\" : \"BAD\",\n \"configStalenessStatus\" : \"STALE\",\n \"clientConfigStalenessStatus\" : \"STALE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"CONCERNING\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"GOOD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"HOST\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ { }, { } ],\n \"items\" : [ { }, { } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STOPPING\",\n \"commissionState\" : \"OFFLINING\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"STALE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"UNKNOWN\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"ROLE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"STANDALONE\",\n \"entityStatus\" : \"UNKNOWN_HEALTH\",\n \"tags\" : [ { }, { } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"NA\",\n \"commissionState\" : \"DECOMMISSIONED\",\n \"healthSummary\" : \"GOOD\",\n \"configStalenessStatus\" : \"STALE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"ACTIVE\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"HOST\", \"SERVICE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"REPLICATED_OBSERVER\",\n \"entityStatus\" : \"DISABLED_HEALTH\",\n \"tags\" : [ { }, { } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"MONTH\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"DAY\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"GOOD_HEALTH\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"STOPPING\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"FRESH\",\n \"clientConfigStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"HISTORY_NOT_AVAILABLE\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"BAD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"SERVICE\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ { }, { } ],\n \"items\" : [ { }, { } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STARTING\",\n \"commissionState\" : \"DECOMMISSIONING\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"UNKNOWN\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"HOST\", \"ROLE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"REPLICATED_OBSERVER\",\n \"entityStatus\" : \"CONCERNING_HEALTH\",\n \"tags\" : [ { }, { } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"BUSY\",\n \"commissionState\" : \"DECOMMISSIONING\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"STALE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"ACTIVE\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"CLUSTER\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"REPLICATED_LEADER_ELECTION\",\n \"entityStatus\" : \"GOOD_HEALTH\",\n \"tags\" : [ { }, { } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"WEEK\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"DAY\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"NONE\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n } ],\n \"parcels\" : [ {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : {\n \"progress\" : 12345,\n \"totalProgress\" : 12345,\n \"count\" : 12345,\n \"totalCount\" : 12345,\n \"errors\" : [ \"...\", \"...\" ],\n \"warnings\" : [ \"...\", \"...\" ]\n },\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n }, {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : {\n \"progress\" : 12345,\n \"totalProgress\" : 12345,\n \"count\" : 12345,\n \"totalCount\" : 12345,\n \"errors\" : [ \"...\", \"...\" ],\n \"warnings\" : [ \"...\", \"...\" ]\n },\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n } ],\n \"clusterUrl\" : \"...\",\n \"hostsUrl\" : \"...\",\n \"entityStatus\" : \"BAD_HEALTH\",\n \"uuid\" : \"...\",\n \"dataContextRefs\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"clusterType\" : \"...\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCluster"
}
}
}
},
"responses" : {
"204" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"name\" : \"...\",\n \"displayName\" : \"...\",\n \"fullVersion\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"ROLE\" ],\n \"services\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"STOPPING\",\n \"healthSummary\" : \"DISABLED\",\n \"configStalenessStatus\" : \"FRESH\",\n \"clientConfigStalenessStatus\" : \"STALE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"HISTORY_NOT_AVAILABLE\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"DISABLED\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"CONTROL_PLANE\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ { }, { } ],\n \"items\" : [ { }, { } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STARTED\",\n \"commissionState\" : \"OFFLINED\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"STALE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"ACTIVE\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"SERVICE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"REPLICATED_OBSERVER\",\n \"entityStatus\" : \"STOPPED\",\n \"tags\" : [ { }, { } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STARTED\",\n \"commissionState\" : \"DECOMMISSIONED\",\n \"healthSummary\" : \"CONCERNING\",\n \"configStalenessStatus\" : \"STALE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"UNKNOWN\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"CONTROL_PLANE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"REPLICATED_LEADER\",\n \"entityStatus\" : \"DISABLED_HEALTH\",\n \"tags\" : [ { }, { } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"WEEK\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"DAY\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"GOOD_HEALTH\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"HISTORY_NOT_AVAILABLE\",\n \"healthSummary\" : \"GOOD\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"clientConfigStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"NOT_AVAILABLE\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"DISABLED\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"SERVICE\", \"CONTROL_PLANE\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ { }, { } ],\n \"items\" : [ { }, { } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"BUSY\",\n \"commissionState\" : \"OFFLINED\",\n \"healthSummary\" : \"GOOD\",\n \"configStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"STANDBY\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"ROLE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"REPLICATED_LEADER\",\n \"entityStatus\" : \"STOPPED\",\n \"tags\" : [ { }, { } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STARTING\",\n \"commissionState\" : \"OFFLINING\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"STANDBY\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CONTROL_PLANE\", \"SERVICE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"UNKNOWN\",\n \"entityStatus\" : \"HISTORY_NOT_AVAILABLE\",\n \"tags\" : [ { }, { } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"DAY\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"DAY\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"DOWN\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n } ],\n \"parcels\" : [ {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : {\n \"progress\" : 12345,\n \"totalProgress\" : 12345,\n \"count\" : 12345,\n \"totalCount\" : 12345,\n \"errors\" : [ \"...\", \"...\" ],\n \"warnings\" : [ \"...\", \"...\" ]\n },\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n }, {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : {\n \"progress\" : 12345,\n \"totalProgress\" : 12345,\n \"count\" : 12345,\n \"totalCount\" : 12345,\n \"errors\" : [ \"...\", \"...\" ],\n \"warnings\" : [ \"...\", \"...\" ]\n },\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n } ],\n \"clusterUrl\" : \"...\",\n \"hostsUrl\" : \"...\",\n \"entityStatus\" : \"UNKNOWN\",\n \"uuid\" : \"...\",\n \"dataContextRefs\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"clusterType\" : \"...\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCluster"
}
}
},
"description" : "Details of the affected cluster."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
}
]
}
},
"\/clusters/{clusterName}/autoAssignRoles" : {
"put" : {
"tags" : [ "ClustersResource" ],
"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",
"responses" : {
"204" : {
"content" : {
},
"description" : "Success"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
}
]
}
},
"\/clusters/{clusterName}/autoConfigure" : {
"put" : {
"tags" : [ "ClustersResource" ],
"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",
"responses" : {
"204" : {
"content" : {
},
"description" : "Success"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
}
]
}
},
"\/clusters/{clusterName}/clientConfig" : {
"get" : {
"tags" : [ "ClustersResource" ],
"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",
"responses" : {
"200" : {
"content" : {
"application/octet-stream" : {
"schema" : {
"description" : "",
"type" : "string",
"format" : "binary"
}
}
},
"description" : "The archive data."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The cluster name."
}
]
}
},
"\/clusters/{clusterName}/clusterSupportToken" : {
"get" : {
"tags" : [ "ClustersResource" ],
"description" : "Gets the support token for a cluster.",
"operationId" : "getClusterSupportToken",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\",\n \"clusterSupportToken\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiClusterSupportToken"
}
}
},
"description" : "The cluster support token."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
}
]
}
},
"\/clusters/{clusterName}/commands" : {
"get" : {
"tags" : [ "ClustersResource" ],
"description" : "List active cluster commands.",
"operationId" : "listActiveCommands",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommandList"
}
}
},
"description" : "A list of active service commands."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The cluster to which the role belongs."
},
{
"name" : "commandName",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "the command name, unique for the command class RestartClusterCommand#COMMAND_NAME"
},
{
"name" : "view",
"in" : "query",
"schema" : {
"default" : "summary",
"type" : "string",
"enum" : ["EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "FULL_WITH_NO_HEALTH_CHECK", "SUMMARY", "SUMMARY_WITH_NO_HEALTH_CHECK"]
},
"description" : "The view of the data to materialize,\neither \"summary\" or \"full\"."
}
]
}
},
"\/clusters/{clusterName}/commands/checkEcsPrerequisites" : {
"post" : {
"tags" : [ "ClustersResource" ],
"operationId" : "checkEcsPrerequisitesCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : ""
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/clusters/{clusterName}/commands/configureAutoTlsServices" : {
"post" : {
"tags" : [ "ClustersResource" ],
"description" : "Configures all services in a cluster to use Auto-TLS",
"operationId" : "configureAutoTlsServicesCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
}
]
}
},
"\/clusters/{clusterName}/commands/configureForKerberos" : {
"post" : {
"tags" : [ "ClustersResource" ],
"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",
"requestBody" : {
"description" : "Arguments for the configure for kerberos command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"datanodeTransceiverPort\" : 12345,\n \"datanodeWebPort\" : 12345\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiConfigureForKerberosArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
}
]
}
},
"\/clusters/{clusterName}/commands/deleteCredentials" : {
"post" : {
"tags" : [ "ClustersResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "cluster name"
}
]
}
},
"\/clusters/{clusterName}/commands/deployClientConfig" : {
"post" : {
"tags" : [ "ClustersResource" ],
"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.<\/p>\n\n Available since API v2.<\/p>",
"operationId" : "deployClientConfig",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster"
}
]
}
},
"\/clusters/{clusterName}/commands/deployClientConfigsAndRefresh" : {
"post" : {
"tags" : [ "ClustersResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
}
]
}
},
"\/clusters/{clusterName}/commands/deployClusterClientConfig" : {
"post" : {
"tags" : [ "ClustersResource" ],
"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<\/p>\n\n \nAvailable since API v7.\n<\/p>",
"operationId" : "deployClusterClientConfig",
"requestBody" : {
"description" : "Hosts in cluster to deploy to. If empty, will target all eligible\nhosts in the cluster.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n }, {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHostRefList"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster"
}
]
}
},
"\/clusters/{clusterName}/commands/disableTls" : {
"post" : {
"tags" : [ "ClustersResource" ],
"description" : "Disables TLS settings on a cluster.",
"operationId" : "disableTls",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster"
}
]
}
},
"\/clusters/{clusterName}/commands/ecsDownloadAndDistribute" : {
"post" : {
"tags" : [ "ClustersResource" ],
"operationId" : "ecsDownloadAndDistribute",
"requestBody" : {
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"workDir\" : \"...\",\n \"packageName\" : \"...\",\n \"remoteRepoUrl\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiEcsDownloadAndDistributeArgs"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : ""
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/clusters/{clusterName}/commands/enterMaintenanceMode" : {
"post" : {
"tags" : [ "ClustersResource" ],
"description" : "Put the cluster into maintenance mode. This is a synchronous command.\nThe result is known immediately upon return.\n\n Available since API v2.<\/p>",
"operationId" : "enterMaintenanceMode",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Synchronous command result."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster"
}
]
}
},
"\/clusters/{clusterName}/commands/exitMaintenanceMode" : {
"post" : {
"tags" : [ "ClustersResource" ],
"description" : "Take the cluster out of maintenance mode. This is a synchronous command.\nThe result is known immediately upon return.\n\n Available since API v2.<\/p>",
"operationId" : "exitMaintenanceMode",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Synchronous command result."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster"
}
]
}
},
"\/clusters/{clusterName}/commands/expireLogs" : {
"post" : {
"tags" : [ "ClustersResource" ],
"description" : "Remove backup and disaster related log files in hdfs.",
"operationId" : "expireLogs",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
},
{
"name" : "days",
"in" : "query",
"schema" : {
"default" : "-2",
"type" : "integer",
"format" : "int64"
},
"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",
"schema" : {
"default" : "false",
"type" : "boolean"
},
"description" : "Whether to schedule a next run for the command, or not. If set to true, 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."
}
]
}
},
"\/clusters/{clusterName}/commands/firstRun" : {
"post" : {
"tags" : [ "ClustersResource" ],
"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<\/p>\n\n \nAvailable since API v7.\n<\/p>",
"operationId" : "firstRun",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
}
]
}
},
"\/clusters/{clusterName}/commands/inspectHosts" : {
"post" : {
"tags" : [ "ClustersResource" ],
"description" : "Runs the host inspector on the configured hosts in the specified cluster.\n\nAvailable since V8.",
"operationId" : "inspectHostsCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster"
}
]
}
},
"\/clusters/{clusterName}/commands/perfInspector" : {
"post" : {
"tags" : [ "ClustersResource" ],
"description" : "Run cluster performance diagnostics test.",
"operationId" : "perfInspectorCommand",
"requestBody" : {
"description" : "Optional arguments for the command. See ApiClusterPerfInspectorArgs.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"pingArgs\" : {\n \"pingTimeoutSecs\" : 10,\n \"pingCount\" : 10,\n \"pingPacketSizeBytes\" : 56\n }\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiClusterPerfInspectorArgs"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
}
]
}
},
"\/clusters/{clusterName}/commands/poolsRefresh" : {
"post" : {
"tags" : [ "ClustersResource" ],
"description" : "Updates all refreshable configuration files for services with\nDynamic Resource Pools.\n \nAvailable since API v6.",
"operationId" : "poolsRefresh",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster"
}
]
}
},
"\/clusters/{clusterName}/commands/postClouderaRuntimeUpgrade" : {
"post" : {
"tags" : [ "ClustersResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/clusters/{clusterName}/commands/preUpgradeCheck" : {
"post" : {
"tags" : [ "ClustersResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster"
}
]
}
},
"\/clusters/{clusterName}/commands/restart" : {
"post" : {
"tags" : [ "ClustersResource" ],
"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",
"requestBody" : {
"description" : "arguments for the restart command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"restartOnlyStaleServices\" : true,\n \"redeployClientConfiguration\" : true,\n \"restartServiceNames\" : [ \"...\", \"...\" ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRestartClusterArgs"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
}
]
}
},
"\/clusters/{clusterName}/commands/rollingRestart" : {
"post" : {
"tags" : [ "ClustersResource" ],
"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",
"requestBody" : {
"description" : "Arguments for the rolling restart command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"slaveBatchSize\" : 12345,\n \"sleepSeconds\" : 12345,\n \"slaveFailCountThreshold\" : 12345,\n \"staleConfigsOnly\" : true,\n \"unUpgradedOnly\" : true,\n \"redeployClientConfiguration\" : true,\n \"rolesToInclude\" : \"SLAVES_ONLY\",\n \"restartServiceNames\" : [ \"...\", \"...\" ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRollingRestartClusterArgs"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
}
]
}
},
"\/clusters/{clusterName}/commands/rollingUpgrade" : {
"post" : {
"tags" : [ "ClustersResource" ],
"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",
"requestBody" : {
"description" : "Arguments for the rolling upgrade command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"upgradeFromCdhVersion\" : \"...\",\n \"upgradeToCdhVersion\" : \"...\",\n \"slaveBatchSize\" : 12345,\n \"sleepSeconds\" : 12345,\n \"slaveFailCountThreshold\" : 12345,\n \"upgradeServiceNames\" : [ \"...\", \"...\" ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRollingUpgradeServicesArgs"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
}
]
}
},
"\/clusters/{clusterName}/commands/runSpecificHostInspections" : {
"post" : {
"tags" : [ "ClustersResource" ],
"description" : "Runs a specific list of host inspections.\n \nThis command runs the ClusterInspectorCommand, which runs the host inspections for all the hosts in a cluster. More specifically,\nthis command will run a specific list of host inspections specified by the user. If no host inspection list name is provided,\nthe default list of inspections will be ran.\n<\/p>",
"operationId" : "runSpecificHostInspectionsCommand",
"requestBody" : {
"description" : "An object that contains the name of the list of inspections to be run.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"hostInspectionsListName\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRunSpecificHostInspectionsArgs"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : ""
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the name of the cluster you want to run the host inspections"
}
]
}
},
"\/clusters/{clusterName}/commands/start" : {
"post" : {
"tags" : [ "ClustersResource" ],
"description" : "Start all services in the cluster.\n \nServices are started in the appropriate order given their dependencies.",
"operationId" : "startCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
}
]
}
},
"\/clusters/{clusterName}/commands/stop" : {
"post" : {
"tags" : [ "ClustersResource" ],
"description" : "Stop all services in the cluster.\n \nServices are stopped in the appropriate order given their dependencies.",
"operationId" : "stopCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
}
]
}
},
"\/clusters/{clusterName}/commands/tearDownWorkload/{workloadClusterName}" : {
"post" : {
"tags" : [ "ClustersResource" ],
"description" : "Tear Down Workload cluster.\n \nTear Down Ranger plugin service (repository) associated with the workload cluster.",
"operationId" : "tearDownWorkloadCluster",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
},
{
"name" : "workloadClusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the workload cluster."
}
]
}
},
"\/clusters/{clusterName}/commands/upgradeCdh" : {
"post" : {
"tags" : [ "ClustersResource" ],
"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",
"requestBody" : {
"description" : "Arguments for the command. See ApiCdhUpgradeArgs.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"cdhParcelVersion\" : \"...\",\n \"cdhPackageVersion\" : \"...\",\n \"rollingRestartArgs\" : {\n \"slaveBatchSize\" : 12345,\n \"sleepSeconds\" : 12345,\n \"slaveFailCountThreshold\" : 12345\n }\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCdhUpgradeArgs"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
}
]
}
},
"\/clusters/{clusterName}/commands/upgradeServices" : {
"post" : {
"deprecated":true,
"tags" : [ "ClustersResource" ],
"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 \nAvailable since API v3.",
"operationId" : "readHostTemplates",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"name\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"roleConfigGroupRefs\" : [ {\n \"roleConfigGroupName\" : \"...\"\n }, {\n \"roleConfigGroupName\" : \"...\"\n } ]\n }, {\n \"name\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"roleConfigGroupRefs\" : [ {\n \"roleConfigGroupName\" : \"...\"\n }, {\n \"roleConfigGroupName\" : \"...\"\n } ]\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHostTemplateList"
}
}
},
"description" : "List of host templates in the cluster."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
},
"post" : {
"tags" : [ "HostTemplatesResource" ],
"description" : "Creates new host templates.\n \nHost template names must be unique across clusters.\n \nAvailable since API v3.",
"operationId" : "createHostTemplates",
"requestBody" : {
"description" : "The list of host templates to create.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"name\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"roleConfigGroupRefs\" : [ {\n \"roleConfigGroupName\" : \"...\"\n }, {\n \"roleConfigGroupName\" : \"...\"\n } ]\n }, {\n \"name\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"roleConfigGroupRefs\" : [ {\n \"roleConfigGroupName\" : \"...\"\n }, {\n \"roleConfigGroupName\" : \"...\"\n } ]\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHostTemplateList"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"name\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"roleConfigGroupRefs\" : [ {\n \"roleConfigGroupName\" : \"...\"\n }, {\n \"roleConfigGroupName\" : \"...\"\n } ]\n }, {\n \"name\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"roleConfigGroupRefs\" : [ {\n \"roleConfigGroupName\" : \"...\"\n }, {\n \"roleConfigGroupName\" : \"...\"\n } ]\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHostTemplateList"
}
}
},
"description" : "The created host templates."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/clusters/{clusterName}/hostTemplates/{hostTemplateName}" : {
"delete" : {
"tags" : [ "HostTemplatesResource" ],
"description" : "Deletes a host template.\n \nAvailable since API v3.",
"operationId" : "deleteHostTemplate",
"responses" : {
"204" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"name\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"roleConfigGroupRefs\" : [ {\n \"roleConfigGroupName\" : \"...\"\n }, {\n \"roleConfigGroupName\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHostTemplate"
}
}
},
"description" : "Deleted host template."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "hostTemplateName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Host template to delete."
}
]
},
"get" : {
"tags" : [ "HostTemplatesResource" ],
"description" : "Retrieves information about a host template.\n \nAvailable since API v3.",
"operationId" : "readHostTemplate",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"name\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"roleConfigGroupRefs\" : [ {\n \"roleConfigGroupName\" : \"...\"\n }, {\n \"roleConfigGroupName\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHostTemplate"
}
}
},
"description" : "The requested host template."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "hostTemplateName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
},
"put" : {
"tags" : [ "HostTemplatesResource" ],
"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",
"requestBody" : {
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"name\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"roleConfigGroupRefs\" : [ {\n \"roleConfigGroupName\" : \"...\"\n }, {\n \"roleConfigGroupName\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHostTemplate"
}
}
}
},
"responses" : {
"204" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"name\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"roleConfigGroupRefs\" : [ {\n \"roleConfigGroupName\" : \"...\"\n }, {\n \"roleConfigGroupName\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHostTemplate"
}
}
},
"description" : "The updated host template."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "hostTemplateName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Host template with updated fields."
}
]
}
},
"\/clusters/{clusterName}/hostTemplates/{hostTemplateName}/commands/applyHostTemplate" : {
"post" : {
"tags" : [ "HostTemplatesResource" ],
"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",
"requestBody" : {
"description" : "List of hosts to apply the host template to.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n }, {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHostRefList"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Synchronous command result."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "hostTemplateName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Host template to apply."
},
{
"name" : "runConfigRules",
"in" : "query",
"schema" : {
"default" : "false",
"type" : "boolean"
},
"description" : "Whether to run the rules engine to automatically\nconfigure roles present on the hosts"
},
{
"name" : "startRoles",
"in" : "query",
"schema" : {
"default" : "false",
"type" : "boolean"
},
"description" : "Whether to start the newly created roles or not."
}
]
}
},
"\/clusters/{clusterName}/hostTemplates/{hostTemplateName}/commands/reapplyHostTemplateOnHosts" : {
"post" : {
"tags" : [ "HostTemplatesResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Synchronous command result."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "hostTemplateName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Host template to apply."
},
{
"name" : "deleteRoles",
"in" : "query",
"schema" : {
"default" : "false",
"type" : "boolean"
},
"description" : "Whether to delete roles on host if RCG is deleted from host template ."
},
{
"name" : "startRoles",
"in" : "query",
"schema" : {
"default" : "false",
"type" : "boolean"
},
"description" : "Whether to start the newly created roles or not."
}
]
}
},
"\/clusters/{clusterName}/hosts" : {
"delete" : {
"tags" : [ "ClustersResource" ],
"operationId" : "removeAllHosts",
"responses" : {
"204" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n }, {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHostRefList"
}
}
},
"description" : "all the hosts that were unassociated with the cluster"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
},
"get" : {
"tags" : [ "ClustersResource" ],
"description" : "Returns hosts in the system filtered by optional host configuration parameters,\nif specified.",
"operationId" : "listHosts",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"hostId\" : \"...\",\n \"ipAddress\" : \"...\",\n \"ipv6Address\" : \"...\",\n \"hostname\" : \"...\",\n \"rackId\" : \"...\",\n \"lastHeartbeat\" : \"...\",\n \"roleRefs\" : [ {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"STARTED\"\n }, {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"NA\"\n } ],\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"DISABLED\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"DISABLED\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"isParcelInfoAvailable\" : true,\n \"hostUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"commissionState\" : \"OFFLINING\",\n \"maintenanceOwners\" : [ \"ROLE\", \"CONTROL_PLANE\" ],\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"numCores\" : 12345,\n \"numPhysicalCores\" : 12345,\n \"totalPhysMemBytes\" : 12345,\n \"entityStatus\" : \"CONCERNING_HEALTH\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"distribution\" : {\n \"distributionType\" : \"RHEL7\",\n \"name\" : \"...\",\n \"version\" : \"...\"\n },\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n }, {\n \"hostId\" : \"...\",\n \"ipAddress\" : \"...\",\n \"ipv6Address\" : \"...\",\n \"hostname\" : \"...\",\n \"rackId\" : \"...\",\n \"lastHeartbeat\" : \"...\",\n \"roleRefs\" : [ {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"NA\"\n }, {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"BUSY\"\n } ],\n \"healthSummary\" : \"GOOD\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"DISABLED\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"GOOD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"isParcelInfoAvailable\" : true,\n \"hostUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"commissionState\" : \"OFFLINING\",\n \"maintenanceOwners\" : [ \"SERVICE\", \"ROLE\" ],\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"numCores\" : 12345,\n \"numPhysicalCores\" : 12345,\n \"totalPhysMemBytes\" : 12345,\n \"entityStatus\" : \"CONCERNING_HEALTH\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"distribution\" : {\n \"distributionType\" : \"DEBIAN_SQUEEZE\",\n \"name\" : \"...\",\n \"version\" : \"...\"\n },\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHostList"
}
}
},
"description" : "A list of hosts in requested cluster"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the cluster"
},
{
"name" : "configName",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "optional host config name to filter hosts by. Available from v40."
},
{
"name" : "configValue",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "host config value associated with config name. Available from v40."
},
{
"name" : "view",
"in" : "query",
"schema" : {
"default" : "summary",
"type" : "string",
"enum" : ["EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "FULL_WITH_NO_HEALTH_CHECK", "SUMMARY", "SUMMARY_WITH_NO_HEALTH_CHECK"]
},
"description" : "The view to materialize"
}
]
},
"post" : {
"tags" : [ "ClustersResource" ],
"operationId" : "addHosts",
"requestBody" : {
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n }, {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHostRefList"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n }, {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHostRefList"
}
}
},
"description" : "the newly added hosts to the cluster.\nif a host is already a member,\nit will be excluded from the list"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/clusters/{clusterName}/hosts/{hostId}" : {
"delete" : {
"tags" : [ "ClustersResource" ],
"operationId" : "removeHost",
"responses" : {
"204" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHostRef"
}
}
},
"description" : "the host that was unassociated with the cluster.\nif the host is not part of the cluster, return null"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "hostId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/clusters/{clusterName}/isTlsEnabled" : {
"get" : {
"tags" : [ "ClustersResource" ],
"description" : "Returns whether a cluster has any TLS settings enabled. This only checks settings that\nwould have been enabled by Auto-TLS.",
"operationId" : "isTlsEnabled",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"schema" : {
"description" : "",
"type" : "boolean"
}
}
},
"description" : "true if it has any TLS settings enabled"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster"
}
]
}
},
"\/clusters/{clusterName}/kerberosInfo" : {
"get" : {
"tags" : [ "ClustersResource" ],
"description" : "Provides Cluster Kerberos information",
"operationId" : "getKerberosInfo",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"kerberized\" : true,\n \"kdcType\" : \"...\",\n \"kerberosRealm\" : \"...\",\n \"kdcHost\" : \"...\",\n \"adminHost\" : \"...\",\n \"domain\" : [ \"...\", \"...\" ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiKerberosInfo"
}
}
},
"description" : "Cluster Kerberos information"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The cluster name."
}
]
}
},
"\/clusters/{clusterName}/parcels" : {
"get" : {
"tags" : [ "ParcelsResource" ],
"description" : "Lists all parcels that the cluster has access to.",
"operationId" : "readParcels",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : {\n \"progress\" : 12345,\n \"totalProgress\" : 12345,\n \"count\" : 12345,\n \"totalCount\" : 12345,\n \"errors\" : [ \"...\", \"...\" ],\n \"warnings\" : [ \"...\", \"...\" ]\n },\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n }, {\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : {\n \"progress\" : 12345,\n \"totalProgress\" : 12345,\n \"count\" : 12345,\n \"totalCount\" : 12345,\n \"errors\" : [ \"...\", \"...\" ],\n \"warnings\" : [ \"...\", \"...\" ]\n },\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiParcelList"
}
}
},
"description" : "List of parcels."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "view",
"in" : "query",
"schema" : {
"default" : "summary",
"type" : "string",
"enum" : ["EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "FULL_WITH_NO_HEALTH_CHECK", "SUMMARY", "SUMMARY_WITH_NO_HEALTH_CHECK"]
},
"description" : ""
}
]
}
},
"\/clusters/{clusterName}/parcels/products/{product}/versions/{version}" : {
"get" : {
"tags" : [ "ParcelResource" ],
"description" : "Retrieves detailed information about a parcel.",
"operationId" : "readParcel",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"product\" : \"...\",\n \"version\" : \"...\",\n \"stage\" : \"...\",\n \"state\" : {\n \"progress\" : 12345,\n \"totalProgress\" : 12345,\n \"count\" : 12345,\n \"totalCount\" : 12345,\n \"errors\" : [ \"...\", \"...\" ],\n \"warnings\" : [ \"...\", \"...\" ]\n },\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiParcel"
}
}
},
"description" : "the parcel"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "product",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the product"
},
{
"name" : "version",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the version"
}
]
}
},
"\/clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/activate" : {
"post" : {
"tags" : [ "ParcelResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "synchronous command result"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "product",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the product"
},
{
"name" : "version",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the version"
}
]
}
},
"\/clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/cancelDistribution" : {
"post" : {
"tags" : [ "ParcelResource" ],
"description" : "A synchronous command that cancels the parcel distribution.\n \nSince it is synchronous, the result is known immediately upon return.",
"operationId" : "cancelDistributionCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "synchronous command result"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "product",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the product"
},
{
"name" : "version",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the version"
}
]
}
},
"\/clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/cancelDownload" : {
"post" : {
"tags" : [ "ParcelResource" ],
"description" : "A synchronous command that cancels the parcel download.\n \nSince it is synchronous, the result is known immediately upon return.",
"operationId" : "cancelDownloadCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "synchronous command result"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "product",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the product"
},
{
"name" : "version",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the version"
}
]
}
},
"\/clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/deactivate" : {
"post" : {
"tags" : [ "ParcelResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "synchronous command result"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "product",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the product"
},
{
"name" : "version",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the version"
}
]
}
},
"\/clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/removeDownload" : {
"post" : {
"tags" : [ "ParcelResource" ],
"description" : "A synchronous command that removes the downloaded parcel.\n \nSince it is synchronous, the result is known immediately upon return.",
"operationId" : "removeDownloadCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "synchronous command result"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "product",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the product"
},
{
"name" : "version",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the version"
}
]
}
},
"\/clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/startDistribution" : {
"post" : {
"tags" : [ "ParcelResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "synchronous command result"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "product",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the product"
},
{
"name" : "version",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the version"
}
]
}
},
"\/clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/startDownload" : {
"post" : {
"tags" : [ "ParcelResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "synchronous command result"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "product",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the product"
},
{
"name" : "version",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the version"
}
]
}
},
"\/clusters/{clusterName}/parcels/products/{product}/versions/{version}/commands/startRemovalOfDistribution" : {
"post" : {
"tags" : [ "ParcelResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "synchronous command result"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "product",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the product"
},
{
"name" : "version",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the version"
}
]
}
},
"\/clusters/{clusterName}/parcels/usage" : {
"get" : {
"tags" : [ "ParcelsResource" ],
"description" : "Retrieve details parcel usage information for the cluster. This describes\nwhich processes, roles and hosts are using which parcels.",
"operationId" : "getParcelUsage",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"racks\" : [ {\n \"hosts\" : [ {\n \"hostRef\" : { },\n \"roles\" : [ { }, { } ]\n }, {\n \"hostRef\" : { },\n \"roles\" : [ { }, { } ]\n } ],\n \"rackId\" : \"...\"\n }, {\n \"hosts\" : [ {\n \"hostRef\" : { },\n \"roles\" : [ { }, { } ]\n }, {\n \"hostRef\" : { },\n \"roles\" : [ { }, { } ]\n } ],\n \"rackId\" : \"...\"\n } ],\n \"parcels\" : [ {\n \"parcelRef\" : {\n \"clusterName\" : \"...\",\n \"parcelName\" : \"...\",\n \"parcelVersion\" : \"...\",\n \"parcelDisplayName\" : \"...\"\n },\n \"processCount\" : 12345,\n \"activated\" : true\n }, {\n \"parcelRef\" : {\n \"clusterName\" : \"...\",\n \"parcelName\" : \"...\",\n \"parcelVersion\" : \"...\",\n \"parcelDisplayName\" : \"...\"\n },\n \"processCount\" : 12345,\n \"activated\" : true\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiParcelUsage"
}
}
},
"description" : "The parcel usage information."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/clusters/{clusterName}/runOzoneCommand" : {
"post" : {
"tags" : [ "ClustersResource" ],
"description" : "Executes an Ozone shell command on an Ozone Role. The command needs to\nbe defined as a RoleCommand in CM (Eg GetOzoneBucketInfoCommand).",
"operationId" : "runOzoneCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Command generated to run on an Ozone Role."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The cluster to which the role belongs."
},
{
"name" : "bucketName",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "name of the Ozone bucket"
},
{
"name" : "commandName",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "The command to run on an Ozone Role."
},
{
"name" : "volumeName",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "name of the Ozone volume"
}
]
}
},
"\/clusters/{clusterName}/serviceTypes" : {
"get" : {
"tags" : [ "ClustersResource" ],
"description" : "List the supported service types for a cluster.",
"operationId" : "listServiceTypes",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ \"...\", \"...\" ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiServiceTypeList"
}
}
},
"description" : "List of service types the cluster supports."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The cluster."
}
]
}
},
"\/clusters/{clusterName}/services" : {
"get" : {
"tags" : [ "ServicesResource" ],
"description" : "Lists all services registered in the cluster.",
"operationId" : "readServices",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"HISTORY_NOT_AVAILABLE\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"STALE\",\n \"clientConfigStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"CONCERNING\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"BAD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CONTROL_PLANE\", \"CLUSTER\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ { }, { } ],\n \"items\" : [ { }, { } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STARTING\",\n \"commissionState\" : \"DECOMMISSIONING\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"UNKNOWN\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"HOST\", \"ROLE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"STANDALONE\",\n \"entityStatus\" : \"NONE\",\n \"tags\" : [ { }, { } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"BUSY\",\n \"commissionState\" : \"OFFLINING\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"ACTIVE\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"HOST\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"REPLICATED_LEADER\",\n \"entityStatus\" : \"UNKNOWN_HEALTH\",\n \"tags\" : [ { }, { } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"HOUR\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"WEEK\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"STOPPING\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"UNKNOWN\",\n \"healthSummary\" : \"BAD\",\n \"configStalenessStatus\" : \"FRESH\",\n \"clientConfigStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"CONCERNING\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"CONCERNING\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"SERVICE\", \"SERVICE\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ { }, { } ],\n \"items\" : [ { }, { } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"BUSY\",\n \"commissionState\" : \"OFFLINING\",\n \"healthSummary\" : \"DISABLED\",\n \"configStalenessStatus\" : \"STALE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"UNKNOWN\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"SERVICE\", \"SERVICE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"REPLICATED_LEADER_ELECTION\",\n \"entityStatus\" : \"GOOD_HEALTH\",\n \"tags\" : [ { }, { } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STOPPING\",\n \"commissionState\" : \"COMMISSIONED\",\n \"healthSummary\" : \"GOOD\",\n \"configStalenessStatus\" : \"STALE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"ACTIVE\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"ROLE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"STANDALONE\",\n \"entityStatus\" : \"DOWN\",\n \"tags\" : [ { }, { } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"YEAR\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"DAY\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"STARTING\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiServiceList"
}
}
},
"description" : "List of services."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "view",
"in" : "query",
"schema" : {
"default" : "summary",
"type" : "string",
"enum" : ["EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "FULL_WITH_NO_HEALTH_CHECK", "SUMMARY", "SUMMARY_WITH_NO_HEALTH_CHECK"]
},
"description" : ""
}
]
},
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Creates a list of services.\n \nThere are typically two service creation strategies:\n \nThe query specifies the intersection of a list of constraints,\njoined together with semicolons (without spaces). For example:\n<\/p>\n \nThe valid comparators are ==<\/em>, !=<\/em>, =lt=<\/em>,\n=le=<\/em>, =ge=<\/em>, and =gt=<\/em>.\nThey stand for \"==\", \"!=\", \"<\", \"<=\",\n\">=\", \">\" respectively."
},
{
"name" : "resultOffset",
"in" : "query",
"schema" : {
"default" : "0",
"type" : "integer",
"format" : "int32"
},
"description" : "Specified the offset of activities to return."
},
{
"name" : "view",
"in" : "query",
"schema" : {
"default" : "summary",
"type" : "string",
"enum" : ["EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "FULL_WITH_NO_HEALTH_CHECK", "SUMMARY", "SUMMARY_WITH_NO_HEALTH_CHECK"]
},
"description" : "The view of the activities to materialize"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/activities/{activityId}" : {
"get" : {
"tags" : [ "ActivitiesResource" ],
"description" : "Returns a specific activity in the system",
"operationId" : "readActivity",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"name\" : \"...\",\n \"type\" : \"STREAMING\",\n \"parent\" : \"...\",\n \"startTime\" : \"...\",\n \"finishTime\" : \"...\",\n \"id\" : \"...\",\n \"status\" : \"SUBMITTED\",\n \"user\" : \"...\",\n \"group\" : \"...\",\n \"inputDir\" : \"...\",\n \"outputDir\" : \"...\",\n \"mapper\" : \"...\",\n \"combiner\" : \"...\",\n \"reducer\" : \"...\",\n \"queueName\" : \"...\",\n \"schedulerPriority\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiActivity"
}
}
},
"description" : "The Activity object with the specified id"
}
},
"parameters" : [
{
"name" : "activityId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The id of the activity to retrieve"
},
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster"
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the service"
},
{
"name" : "view",
"in" : "query",
"schema" : {
"default" : "summary",
"type" : "string",
"enum" : ["EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "FULL_WITH_NO_HEALTH_CHECK", "SUMMARY", "SUMMARY_WITH_NO_HEALTH_CHECK"]
},
"description" : "The view of the activity to materialize"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/activities/{activityId}/children" : {
"get" : {
"tags" : [ "ActivitiesResource" ],
"description" : "Returns the child activities",
"operationId" : "readChildActivities",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"name\" : \"...\",\n \"type\" : \"MR\",\n \"parent\" : \"...\",\n \"startTime\" : \"...\",\n \"finishTime\" : \"...\",\n \"id\" : \"...\",\n \"status\" : \"SUSPENDED\",\n \"user\" : \"...\",\n \"group\" : \"...\",\n \"inputDir\" : \"...\",\n \"outputDir\" : \"...\",\n \"mapper\" : \"...\",\n \"combiner\" : \"...\",\n \"reducer\" : \"...\",\n \"queueName\" : \"...\",\n \"schedulerPriority\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"HIVE\",\n \"parent\" : \"...\",\n \"startTime\" : \"...\",\n \"finishTime\" : \"...\",\n \"id\" : \"...\",\n \"status\" : \"SUBMITTED\",\n \"user\" : \"...\",\n \"group\" : \"...\",\n \"inputDir\" : \"...\",\n \"outputDir\" : \"...\",\n \"mapper\" : \"...\",\n \"combiner\" : \"...\",\n \"reducer\" : \"...\",\n \"queueName\" : \"...\",\n \"schedulerPriority\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiActivityList"
}
}
},
"description" : "The list of child activities for the specified activity"
}
},
"parameters" : [
{
"name" : "activityId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The id of the activity"
},
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster"
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the service"
},
{
"name" : "maxResults",
"in" : "query",
"schema" : {
"default" : "100",
"type" : "integer",
"format" : "int32"
},
"description" : "The maximum number of activities to return."
},
{
"name" : "resultOffset",
"in" : "query",
"schema" : {
"default" : "0",
"type" : "integer",
"format" : "int32"
},
"description" : "Specified the offset of activities to return."
},
{
"name" : "view",
"in" : "query",
"schema" : {
"default" : "summary",
"type" : "string",
"enum" : ["EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "FULL_WITH_NO_HEALTH_CHECK", "SUMMARY", "SUMMARY_WITH_NO_HEALTH_CHECK"]
},
"description" : "The view of the children to materialize"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/activities/{activityId}/metrics" : {
"get" : {
"tags" : [ "ActivitiesResource" ],
"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<\/i> 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<\/i> and to<\/i> 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",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"name\" : \"...\",\n \"context\" : \"...\",\n \"unit\" : \"...\",\n \"data\" : [ {\n \"timestamp\" : \"...\",\n \"value\" : 12345.0\n }, {\n \"timestamp\" : \"...\",\n \"value\" : 12345.0\n } ],\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"context\" : \"...\",\n \"unit\" : \"...\",\n \"data\" : [ {\n \"timestamp\" : \"...\",\n \"value\" : 12345.0\n }, {\n \"timestamp\" : \"...\",\n \"value\" : 12345.0\n } ],\n \"displayName\" : \"...\",\n \"description\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiMetricList"
}
}
},
"description" : "List of readings from the monitors."
}
},
"parameters" : [
{
"name" : "activityId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the activity."
},
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the service."
},
{
"name" : "from",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "Start of the period to query."
},
{
"name" : "metrics",
"in" : "query",
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"description" : "Filter for which metrics to query."
},
{
"name" : "to",
"in" : "query",
"schema" : {
"default" : "now",
"type" : "string"
},
"description" : "End of the period to query."
},
{
"name" : "view",
"in" : "query",
"schema" : {
"default" : "summary",
"type" : "string",
"enum" : ["EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "FULL_WITH_NO_HEALTH_CHECK", "SUMMARY", "SUMMARY_WITH_NO_HEALTH_CHECK"]
},
"description" : "The view of the data to materialize,\neither \"summary\" or \"full\"."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/activities/{activityId}/similar" : {
"get" : {
"tags" : [ "ActivitiesResource" ],
"description" : "Returns a list of similar activities",
"operationId" : "readSimilarActivities",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"name\" : \"...\",\n \"type\" : \"HIVE\",\n \"parent\" : \"...\",\n \"startTime\" : \"...\",\n \"finishTime\" : \"...\",\n \"id\" : \"...\",\n \"status\" : \"SUBMITTED\",\n \"user\" : \"...\",\n \"group\" : \"...\",\n \"inputDir\" : \"...\",\n \"outputDir\" : \"...\",\n \"mapper\" : \"...\",\n \"combiner\" : \"...\",\n \"reducer\" : \"...\",\n \"queueName\" : \"...\",\n \"schedulerPriority\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"STREAMING\",\n \"parent\" : \"...\",\n \"startTime\" : \"...\",\n \"finishTime\" : \"...\",\n \"id\" : \"...\",\n \"status\" : \"SUSPENDED\",\n \"user\" : \"...\",\n \"group\" : \"...\",\n \"inputDir\" : \"...\",\n \"outputDir\" : \"...\",\n \"mapper\" : \"...\",\n \"combiner\" : \"...\",\n \"reducer\" : \"...\",\n \"queueName\" : \"...\",\n \"schedulerPriority\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiActivityList"
}
}
},
"description" : "The list of similar activities to the specified activity"
}
},
"parameters" : [
{
"name" : "activityId",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The id of the activity"
},
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster"
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the service"
},
{
"name" : "view",
"in" : "query",
"schema" : {
"default" : "summary",
"type" : "string",
"enum" : ["EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "FULL_WITH_NO_HEALTH_CHECK", "SUMMARY", "SUMMARY_WITH_NO_HEALTH_CHECK"]
},
"description" : "The view of the activities to materialize"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/clientConfig" : {
"get" : {
"tags" : [ "ServicesResource" ],
"description" : "Download a zip-compressed archive of the client configuration,\nof a specific service. This resource does not require any authentication.",
"operationId" : "getClientConfig",
"responses" : {
"200" : {
"content" : {
"application/octet-stream" : {
"schema" : {
"description" : "",
"type" : "string",
"format" : "binary"
}
}
},
"description" : "The archive data."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands" : {
"get" : {
"tags" : [ "ServicesResource" ],
"description" : "List active service commands.",
"operationId" : "listActiveCommands",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommandList"
}
}
},
"description" : "A list of active service commands."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The service to which the role belongs."
},
{
"name" : "commandName",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "the command name, unique for the command class HdfsCreateSnapshotCommand#COMMAND_NAME"
},
{
"name" : "view",
"in" : "query",
"schema" : {
"default" : "summary",
"type" : "string",
"enum" : ["EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "FULL_WITH_NO_HEALTH_CHECK", "SUMMARY", "SUMMARY_WITH_NO_HEALTH_CHECK"]
},
"description" : "The view of the data to materialize,\neither \"summary\" or \"full\"."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/copyHdfsFile" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Copies source HDFS file to destination cluster HDFS",
"operationId" : "copyHdfsFile",
"requestBody" : {
"description" : "ApiServiceRef for the destination",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiServiceRef"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : ""
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The source HDFS service"
},
{
"name" : "destinationPath",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "HDFS full path at destination"
},
{
"name" : "sourcePath",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "HDFS full path at source"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/createHdfsFile" : {
"post" : {
"tags" : [ "ServicesResource" ],
"operationId" : "createHdfsFile",
"requestBody" : {
"description" : "Content to be put in the file to be created",
"required" : false,
"content" : {
"application/json" : {
"schema" : {
"description" : "",
"type" : "string"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"schema" : {
"description" : "",
"type" : "string"
}
}
},
"description" : "\"CREATED\" or \"FILE_EXISTS\" will be returned"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The HDFS service name"
},
{
"name" : "overwrite",
"in" : "query",
"schema" : {
"default" : "false",
"type" : "boolean"
},
"description" : "If true overwrite the file"
},
{
"name" : "path",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "full path to the HDFS file to be created"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/createOozieDb" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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<\/p>",
"operationId" : "createOozieDb",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the Oozie service on which to run the command."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/createSolrHdfsHomeDir" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Creates the home directory of a Solr service in HDFS.\n\n \nAvailable since API v4.",
"operationId" : "createSolrHdfsHomeDirCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The Solr service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/createSqoopUserDir" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Creates the user directory of a Sqoop service in HDFS.\n\n \nAvailable since API v4.",
"operationId" : "createSqoopUserDirCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The Sqoop service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/decommission" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"description" : "List of role names to decommision.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ \"...\", \"...\" ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRoleNameList"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The HBase service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/deleteHdfsPath" : {
"delete" : {
"tags" : [ "ServicesResource" ],
"description" : "Deletes the file or directory, specified by the given path, on the given HDFS service.",
"operationId" : "deleteHdfsPath",
"responses" : {
"204" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "\"DELETED\""
}
},
"schema" : {
"$ref" : "#/components/schemas/DeleteHdfsPathResult"
}
}
},
"description" : "DeleteHdfsPathResult"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The HDFS service name"
},
{
"name" : "path",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "path of the file or directory to be deleted"
},
{
"name" : "recursive",
"in" : "query",
"schema" : {
"default" : "false",
"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"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/deployClientConfig" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Deploy a service's client configuration.\n \nThe client configuration is deployed to the hosts where the given roles\nare running.\n \nThis command only applies to CDH 7.1.9SP1+ Impala Catalog and Statestore\nservices.\n \nThe command will keep exactly one Catalog and Statestore server on the\nspecified host.\n \nAll services that depend on Impala will be restarted after disabling Catalog\nand Statestore HA.",
"operationId" : "disableCatalogStatestoreHaCommand",
"requestBody" : {
"description" : "An instance of ApiDisableCatalogStatestoreHaArguments\nrepresenting the arguments to the command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"activeCatalogName\" : \"...\",\n \"activeStatestoreName\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiDisableCatalogStatestoreHaArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "the created command instance"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "A String representing the Impala service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/disableJtHa" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"description" : "Arguments for the command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"activeName\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiDisableJtHaArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The MapReduce service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/disableRmHa" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"description" : "Arguments for the command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"activeName\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiDisableRmHaArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The YARN service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/disableSentryHa" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"description" : "An instance of ApiDisableSentryHaArgs\nrepresenting the arguments to the command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"activeName\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiDisableSentryHaArgs"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "the created command instance"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "A String representing the Sentry service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/ecsUpgradeAudit" : {
"post" : {
"tags" : [ "ServicesResource" ],
"operationId" : "ecsUpgradeAudit",
"requestBody" : {
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ \"...\", \"...\" ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiStringList"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : ""
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/enableCatalogStatestoreHa" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Enable high availability (HA) for Catalog and Statestore service.\n \nThis command only applies to CDH 7.1.9SP1+ Impala Catalog and Statestore\nservices.\n \nThe command will create a new Catalog and Statestore server on the specified\nhost for Catalog and Statestore HA.\n \nAll services that depend on Impala will be restarted after enabling Catalog\nand Statestore HA.",
"operationId" : "enableCatalogStatestoreHaCommand",
"requestBody" : {
"description" : "An instance of ApiEnableCatalogStatestoreHaArguments\nrepresenting the arguments to the command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"newCatalogHostId\" : \"...\",\n \"newCatalogRoleName\" : \"...\",\n \"newStatestoreHostId\" : \"...\",\n \"newStatestoreRoleName\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiEnableCatalogStatestoreHaArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "the created command instance"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "A String representing the Impala service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/enableJtHa" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"description" : "Arguments for the command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"newJtHostId\" : \"...\",\n \"forceInitZNode\" : true,\n \"zkServiceName\" : \"...\",\n \"newJtRoleName\" : \"...\",\n \"fc1RoleName\" : \"...\",\n \"fc2RoleName\" : \"...\",\n \"logicalName\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiEnableJtHaArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The MapReduce service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/enableRmHa" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"description" : "Arguments for the command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"newRmHostId\" : \"...\",\n \"newRmRoleName\" : \"...\",\n \"zkServiceName\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiEnableRmHaArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The YARN service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/enableSentryHa" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"description" : "An instance of ApiEnableSentryHaArgs\nrepresenting the arguments to the command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"newSentryHostId\" : \"...\",\n \"newSentryRoleName\" : \"...\",\n \"zkServiceName\" : \"...\",\n \"rrcArgs\" : {\n \"slaveBatchSize\" : 12345,\n \"sleepSeconds\" : 12345,\n \"slaveFailCountThreshold\" : 12345\n }\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiEnableSentryHaArgs"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "the created command instance"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "A String representing the Sentry service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/enterMaintenanceMode" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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<\/p>",
"operationId" : "enterMaintenanceMode",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Synchronous command result."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/exitMaintenanceMode" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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<\/p>",
"operationId" : "exitMaintenanceMode",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Synchronous command result."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/exportSentryPermissions" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Export Sentry Permissions.",
"operationId" : "exportSentryPermissionsCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/firstRun" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Prepare and start a service.\n\n \nPerform all the steps needed to prepare the service and start it.\n<\/p>\n\n \nAvailable since API v7.\n<\/p>",
"operationId" : "firstRun",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/getEntityTypesFromAtlas" : {
"get" : {
"tags" : [ "ServicesResource" ],
"description" : "Retrieves the atlas entities from a cluster.\nOnly available with Cloudera Manager Enterprise Edition.",
"operationId" : "getEntityTypesFromAtlas",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "[ {\n \"name\" : \"...\",\n \"serviceType\" : \"...\",\n \"category\" : \"...\"\n} ]"
}
},
"schema" : {
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiAtlasEntityTypes"
}
}
}
},
"description" : "A List of all Atlas Entity types\n(ApiAtlasEntityTypes)"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/getPoliciesFromRanger" : {
"get" : {
"tags" : [ "ServicesResource" ],
"description" : "Collects information about the policies defined in the local Ranger service.\n \nOptionally if sourcePeer, sourceCluster, sourceUser are provided, then it will call\nthe same API endpoint on that given source CM peer, and merges the result of\nthe local (ApiRangerPolicyList#getPolicies()) and\nremote (ApiRangerPolicyList#getPolicies()) Ranger policies.",
"operationId" : "getPoliciesFromRanger",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"policies\" : [ {\n \"service\" : \"...\",\n \"serviceType\" : \"...\",\n \"name\" : \"...\",\n \"resources\" : {\n \"property1\" : {\n \"values\" : [ \"...\", \"...\" ]\n },\n \"property2\" : {\n \"values\" : [ \"...\", \"...\" ]\n }\n }\n }, {\n \"service\" : \"...\",\n \"serviceType\" : \"...\",\n \"name\" : \"...\",\n \"resources\" : {\n \"property1\" : {\n \"values\" : [ \"...\", \"...\" ]\n },\n \"property2\" : {\n \"values\" : [ \"...\", \"...\" ]\n }\n }\n } ],\n \"remotePolicies\" : [ {\n \"service\" : \"...\",\n \"serviceType\" : \"...\",\n \"name\" : \"...\",\n \"resources\" : {\n \"property1\" : {\n \"values\" : [ \"...\", \"...\" ]\n },\n \"property2\" : {\n \"values\" : [ \"...\", \"...\" ]\n }\n }\n }, {\n \"service\" : \"...\",\n \"serviceType\" : \"...\",\n \"name\" : \"...\",\n \"resources\" : {\n \"property1\" : {\n \"values\" : [ \"...\", \"...\" ]\n },\n \"property2\" : {\n \"values\" : [ \"...\", \"...\" ]\n }\n }\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRangerPolicyList"
}
}
},
"description" : "A list of the local Ranger policies\n(ApiRangerPolicyList#getPolicies()),\nand optionally the same kind of list from the source CM\n(ApiRangerPolicyList#getPolicies())."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the name of the local Ranger service."
},
{
"name" : "sourceCluster",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "optional: the source CM cluster name."
},
{
"name" : "sourcePeer",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "optional: the source CM peer name."
},
{
"name" : "sourceService",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "optional: the Ranger service name on the source CM."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/getServicesFromRanger" : {
"get" : {
"tags" : [ "ServicesResource" ],
"description" : "Collects information about the services defined in the local Ranger service.\n \nOptionally if sourcePeer, sourceCluster, sourceService are provided, then it will call\nthe same API endpoint on that given source CM peer, and merges the result of\nthe local (ApiRangerServiceList#getServices()) and\nremote (ApiRangerServiceList#getRemoteServices()) Ranger services.",
"operationId" : "getServicesFromRanger",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"services\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\"\n } ],\n \"remoteServices\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRangerServiceList"
}
}
},
"description" : "A list of the local Ranger services\n(ApiRangerServiceList#getServices()),\nand optionally the same kind of list from the source CM\n(ApiRangerServiceList#getRemoteServices())."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the name of the local Ranger service."
},
{
"name" : "sourceCluster",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "optional: the source CM cluster name."
},
{
"name" : "sourcePeer",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "optional: the source CM peer name."
},
{
"name" : "sourceService",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "optional: the Ranger service name on the source CM."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/getUsersFromRanger" : {
"get" : {
"tags" : [ "ServicesResource" ],
"description" : "Collects information about the users defined in the local Ranger service.\n \nOptionally if sourcePeer, sourceCluster, sourceUser are provided, then it will call\nthe same API endpoint on that given source CM peer, and merges the result of\nthe local (ApiRangerUserList#getUsers()) and\nremote (ApiRangerUserList#getRemoteUsers()) Ranger users.",
"operationId" : "getUsersFromRanger",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"vXUsers\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ],\n \"remoteUsers\" : [ {\n \"name\" : \"...\"\n }, {\n \"name\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRangerUserList"
}
}
},
"description" : "A list of the local Ranger users\n(ApiRangerUserList#getUsers()),\nand optionally the same kind of list from the source CM\n(ApiRangerUserList#getRemoteUsers())."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the name of the local Ranger service."
},
{
"name" : "sourceCluster",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "optional: the source CM cluster name."
},
{
"name" : "sourcePeer",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "optional: the source CM peer name."
},
{
"name" : "sourceService",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "optional: the Ranger service name on the source CM."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hbaseCreateRoot" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Creates the root directory of an HBase service.",
"operationId" : "createHBaseRootCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The HBase service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hbaseCreateUserDirectory" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Create the HBase user directory (usually /user/hbase).",
"operationId" : "hbaseReplicationCreateUserDirectory",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : ""
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The local HBase service name"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupAutomatic" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"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)",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"keystorePassword\" : \"...\",\n \"replicationUser\" : \"...\",\n \"sourceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"cmPeerNameOnRemote\" : \"...\",\n \"sourceRestartType\" : \"NO_RESTART\",\n \"targetRestartType\" : \"RESTART\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHBaseReplicationSetupCommandArgs"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Contains the command ID that executes the request"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The local HBase service name"
},
{
"name" : "force",
"in" : "query",
"schema" : {
"default" : "false",
"type" : "boolean"
},
"description" : "If true, perform setup even if already setup. (Default false)"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupCleanAndReset" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Cleans and resets the HBase replication first time setup on the given source and target:\n \nBefore using this API endpoint, it's assumed that the source and target (local)\nHBase services already have the HBase replication first time setup executed\nbut with different peers.\nIt starts a command, that checks if the necessary configurations are in place\non both source and target\n(see #hbaseReplicationSetup(String, boolean, ApiHBaseReplicationSetupCommandArgs)).\nIf everything matches, then it sets the setup status to READY.",
"operationId" : "hbaseReplicationFirstTimeSetupForAlreadyPairedClusters",
"requestBody" : {
"description" : "contains the source peer, source cluster, source HBase service name",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiServiceRef"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Contains the command ID that executes the request"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The local (target) HBase service name"
},
{
"name" : "force",
"in" : "query",
"schema" : {
"default" : "false",
"type" : "boolean"
},
"description" : "If true, perform setup even if already setup. (Default false)"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupForSourceOnly" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Starts an HBase replication first time setup for the source only.\n \nBefore using this API endpoint, it's assumed that the target (local) HBase service\nalready has HBase replication first time setup executed with another peer's HBase.\nIt starts a command, that does some configuration only on the source\n(see #hbaseReplicationSetup(String, boolean, ApiHBaseReplicationSetupCommandArgs)),\nthen restarts source HBase service if needed.",
"operationId" : "hbaseReplicationFirstTimeSetupForSourceOnly",
"requestBody" : {
"description" : "Replication setup parameters such as\nthe source peer, source cluster, source service, HBase replication user,\nand optionally the RestartType for the source HBase service.\nIf RestartType is:\n \nBefore using this API endpoint, it's assumed that the given source HBase service,\ngiven by ApiHBaseReplicationSetupOneClusterOnlyCmdArgs,\nalready has HBase replication first time setup executed with another peer's HBase.\nIt starts a command, that does some configuration only on the target\n(see #hbaseReplicationSetup(String, boolean, ApiHBaseReplicationSetupCommandArgs)),\nthen restarts target HBase service.",
"operationId" : "hbaseReplicationFirstTimeSetupForTargetOnly",
"requestBody" : {
"description" : "Replication setup parameters such as\nthe source peer, source cluster, source service, HBase replication user,\nand optionally the RestartType for the local HBase service\n(default is rolling restart)",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"sourceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"restartType\" : \"RESTART\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHBaseReplicationSetupOneClusterOnlyCmdArgs"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Contains the command ID that executes the request"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The local HBase service name"
},
{
"name" : "force",
"in" : "query",
"schema" : {
"default" : "false",
"type" : "boolean"
},
"description" : "If true, perform setup even if already setup. (Default false)"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupForceReady" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Force sets the HBase replication first time setup status to be READY for the given\nsource and target. Note that after this operation, the pending HBase replication\npolicies, which have the waitForHBaseReplicationSetup flag set to true,\nwill NOT be completed.",
"operationId" : "hbaseReplicationFirstTimeSetupForceReady",
"requestBody" : {
"description" : "contains the source peer, source cluster, source sourceService",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiServiceRef"
}
}
}
},
"responses" : {
"201" : {
"content" : {
},
"description" : "Success"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The local HBase service name"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupManual" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Starts a manual HBase replication first time setup. After doing some configuration\n(see #hbaseReplicationSetup(String, boolean, ApiHBaseReplicationSetupCommandArgs)),\nit restarts the target cluster only. Source cluster has to be restarted manually,\nafter which the #hbaseReplicationFirstTimeSetupManualContinue(String, ApiServiceRef)\nAPI endpoint should be called to finish the HBase replication first time setup.",
"operationId" : "hbaseReplicationFirstTimeSetupManual",
"requestBody" : {
"description" : "Replication setup parameters such as\nthe source peer, source service, passphrase for the keystore, and\noptionally the RestartType\nfor the target (default is rolling restart)",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"keystorePassword\" : \"...\",\n \"replicationUser\" : \"...\",\n \"sourceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"cmPeerNameOnRemote\" : \"...\",\n \"sourceRestartType\" : \"ROLLING_RESTART\",\n \"targetRestartType\" : \"NO_RESTART\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHBaseReplicationSetupCommandArgs"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Contains the command ID that executes the request"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The local HBase service name"
},
{
"name" : "force",
"in" : "query",
"schema" : {
"default" : "false",
"type" : "boolean"
},
"description" : "If true, perform setup even if already setup. (Default false)"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupManualContinue" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Should be called after\n#hbaseReplicationFirstTimeSetupManual(String, ApiHBaseReplicationSetupCommandArgs)\nto finish the manual HBase replication first time setup.",
"operationId" : "hbaseReplicationFirstTimeSetupManualContinue",
"requestBody" : {
"description" : "contains the source peer, source cluster, source service",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiServiceRef"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Contains the command ID that executes the request"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The local HBase service name"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupReset" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Resets/removes the HBase replication first time setup status for the given\nsource and target.",
"operationId" : "hbaseReplicationFirstTimeSetupReset",
"requestBody" : {
"description" : "contains the source peer, source cluster, source sourceService",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiServiceRef"
}
}
}
},
"responses" : {
"201" : {
"content" : {
},
"description" : "Success"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The local HBase service name"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationFirstTimeSetupStatus" : {
"get" : {
"tags" : [ "ServicesResource" ],
"operationId" : "hbaseReplicationFirstTimeSetupStatus",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"status\" : \"ERROR\",\n \"subStatus\" : \"RESTARTING\",\n \"mainCommandId\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"currentCommandId\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"error\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHBaseReplicationSetupStatus"
}
}
},
"description" : "Info about the HBase replication first time setup status"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The local HBase service name"
},
{
"name" : "sourceCluster",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "The source cluster's name"
},
{
"name" : "sourcePeer",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "The source peer's name"
},
{
"name" : "sourceService",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "The source service's name"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationSetup" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Perform one time setup for HBase replication.\n\nGenerate the a keystore to HDFS for use by replication and transfer the\nkeystore to HDFS on the the peer.",
"operationId" : "hbaseReplicationSetup",
"requestBody" : {
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"keystorePassword\" : \"...\",\n \"replicationUser\" : \"...\",\n \"sourceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"cmPeerNameOnRemote\" : \"...\",\n \"sourceRestartType\" : \"NO_RESTART\",\n \"targetRestartType\" : \"NO_RESTART\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHBaseReplicationSetupCommandArgs"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : ""
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The service name."
},
{
"name" : "force",
"in" : "query",
"schema" : {
"default" : "false",
"type" : "boolean"
},
"description" : "If true, perform setup even if already setup. (Default false)"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hbaseReplicationSetupAdmin" : {
"post" : {
"tags" : [ "ServicesResource" ],
"operationId" : "hbaseReplicationSetupAdmin",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : ""
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "cmPeerDefinition",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "op",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "path",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "user",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hbaseShellCommand" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Execute a hbase shell command",
"operationId" : "hbaseShellCommand",
"requestBody" : {
"description" : "hbase shell command to be executed",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"payload\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHBaseShellCommand"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command's execution"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The HBase service name"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hbaseUpgrade" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Upgrade HBase data in HDFS and ZooKeeper as part of upgrade from CDH4 to CDH5.\n \nAvailable since API v2.\n<\/p>",
"operationId" : "hdfsCreateTmpDir",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the HDFS service on which to run the command."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hdfsDisableAutoFailover" : {
"post" : {
"deprecated":true,
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"description" : "The nameservice name.",
"required" : false,
"content" : {
"text/plain" : {
"schema" : {
"description" : "",
"type" : "string"
}
},
"application/json" : {
"schema" : {
"description" : "",
"type" : "string"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The HDFS service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hdfsDisableHa" : {
"post" : {
"deprecated":true,
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"description" : "Arguments for the command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"activeName\" : \"...\",\n \"secondaryName\" : \"...\",\n \"startDependentServices\" : true,\n \"deployClientConfigs\" : true,\n \"disableQuorumStorage\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHdfsDisableHaArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The HDFS service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hdfsDisableNnHa" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"description" : "Arguments for the command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"activeNnName\" : \"...\",\n \"snnHostId\" : \"...\",\n \"snnCheckpointDirList\" : [ \"...\", \"...\" ],\n \"snnName\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiDisableNnHaArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The HDFS service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hdfsEnableAutoFailover" : {
"post" : {
"deprecated":true,
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"description" : "Arguments for the command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"nameservice\" : \"...\",\n \"zooKeeperService\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"activeFCName\" : \"...\",\n \"standByFCName\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHdfsFailoverArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The HDFS service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hdfsEnableHa" : {
"post" : {
"deprecated":true,
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"description" : "Arguments for the command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"activeName\" : \"...\",\n \"activeSharedEditsPath\" : \"...\",\n \"standByName\" : \"...\",\n \"standBySharedEditsPath\" : \"...\",\n \"nameservice\" : \"...\",\n \"startDependentServices\" : true,\n \"deployClientConfigs\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiHdfsHaArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The HDFS service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hdfsEnableNnHa" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"description" : "Arguments for the command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"activeNnName\" : \"...\",\n \"standbyNnName\" : \"...\",\n \"standbyNnHostId\" : \"...\",\n \"standbyNameDirList\" : [ \"...\", \"...\" ],\n \"nameservice\" : \"...\",\n \"qjName\" : \"...\",\n \"activeFcName\" : \"...\",\n \"standbyFcName\" : \"...\",\n \"zkServiceName\" : \"...\",\n \"jns\" : [ {\n \"jnName\" : \"...\",\n \"jnHostId\" : \"...\",\n \"jnEditsDir\" : \"...\"\n }, {\n \"jnName\" : \"...\",\n \"jnHostId\" : \"...\",\n \"jnEditsDir\" : \"...\"\n } ],\n \"forceInitZNode\" : true,\n \"clearExistingStandbyNameDirs\" : true,\n \"clearExistingJnEditsDir\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiEnableNnHaArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The HDFS service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hdfsFailover" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"description" : "Names of the NameNodes in the HA pair.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ \"...\", \"...\" ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRoleNameList"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The HDFS service name."
},
{
"name" : "force",
"in" : "query",
"schema" : {
"default" : "false",
"type" : "boolean"
},
"description" : "Whether to force failover."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hdfsFinalizeRollingUpgrade" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The HDFS service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hdfsRollEdits" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Roll the edits of an HDFS NameNode or Nameservice.\n \nAvailable since API v3.",
"operationId" : "hdfsRollEditsCommand",
"requestBody" : {
"description" : "Arguments to the Roll Edits command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"nameservice\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRollEditsArgs"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The HDFS service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hdfsUpgradeMetadata" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Upgrade HDFS Metadata as part of a major version upgrade.\n \nAvailable since API v4.\n<\/p>",
"operationId" : "createHiveUserDirCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The Hive service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hiveCreateHiveWarehouse" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Create the Hive warehouse directory, on Hive services.\n \nAvailable since API v3.\n<\/p>",
"operationId" : "createHiveWarehouseCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The Hive service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hiveCreateHiveWarehouseExternal" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Create the Hive warehouse external directory for Private Cloud.",
"operationId" : "createHiveWarehouseExternalCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The Hive service name."
},
{
"name" : "directory",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "Name of the warehouse external directory."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hiveCreateMetastoreDatabase" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the Hive service on which to run the command."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hiveCreateMetastoreDatabaseTables" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the Hive service on which to run the command."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hiveUpdateMetastoreNamenodes" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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.<\/strong>\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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the Hive service on which to run the command."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hiveUpgradeMetastore" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Upgrade Hive Metastore as part of a major version upgrade.\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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the Hive service on which to run the command."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hueCreateHiveWarehouse" : {
"post" : {
"deprecated":true,
"tags" : [ "ServicesResource" ],
"description" : "Create the Beeswax role's Hive warehouse directory, on Hue services.",
"operationId" : "createBeeswaxWarehouseCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The Hue service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hueDumpDb" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Runs Hue's dumpdata command.\n\nAvailable since API v10.",
"operationId" : "hueDumpDbCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the service"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hueLoadDb" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Runs Hue's loaddata command.\n\nAvailable since API v10.",
"operationId" : "hueLoadDbCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the service"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/hueSyncDb" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Runs Hue's syncdb command.\n\nAvailable since API v10.",
"operationId" : "hueSyncDbCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the service"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/icebergReplicationTestAccess" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Executes IcebergReplicationTestAccess command for the given path.",
"operationId" : "icebergReplicationTestAccess",
"requestBody" : {
"description" : "An instance of ApiIcebergReplicationTestAccessPaths",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"proxyName\" : \"...\",\n \"proxyNameOnSource\" : \"...\",\n \"distcpOnSource\" : true,\n \"altStagingLocation\" : \"...\",\n \"locationMapping\" : [ {\n \"key\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"key\" : \"...\",\n \"value\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiIcebergReplicationTestAccessPaths"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Info about the created command"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the ICEBERG_REPLICATION service."
},
{
"name" : "sourceCluster",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster on remote."
},
{
"name" : "sourcePeer",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "The name of the peer."
},
{
"name" : "sourceService",
"in" : "query",
"schema" : {
"type" : "string"
},
"description" : "The name of the ICEBERG_REPLICATION service on remote."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/impalaCreateCatalogDatabase" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Not needed in CM 5.0.0 Release, since Impala Catalog Database\nis not yet available in CDH as of this release.<\/strong>\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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the Impala service on which to run the command."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/impalaCreateCatalogDatabaseTables" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Not needed in CM 5.0.0 Release, since Impala Catalog Database\nis not yet available in CDH as of this release.<\/strong>\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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the Impala service on which to run the command."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/impalaCreateUserDir" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Create the Impala user directory\n \nAvailable since API v6.\n<\/p>",
"operationId" : "createImpalaUserDirCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The Impala service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/impalaDisableLlamaHa" : {
"post" : {
"deprecated":true,
"tags" : [ "ServicesResource" ],
"description" : "Not Supported. Llama was removed.",
"operationId" : "disableLlamaHaCommand",
"requestBody" : {
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"activeName\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiDisableLlamaHaArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : ""
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/impalaDisableLlamaRm" : {
"post" : {
"deprecated":true,
"tags" : [ "ServicesResource" ],
"description" : "Not Supported. Llama was removed.",
"operationId" : "disableLlamaRmCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : ""
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/impalaEnableLlamaHa" : {
"post" : {
"deprecated":true,
"tags" : [ "ServicesResource" ],
"description" : "Not Supported. Llama was removed.",
"operationId" : "enableLlamaHaCommand",
"requestBody" : {
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"newLlamaHostId\" : \"...\",\n \"newLlamaRoleName\" : \"...\",\n \"zkServiceName\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiEnableLlamaHaArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : ""
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/impalaEnableLlamaRm" : {
"post" : {
"deprecated":true,
"tags" : [ "ServicesResource" ],
"description" : "Not Supported. Llama was removed.",
"operationId" : "enableLlamaRmCommand",
"requestBody" : {
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"llama1HostId\" : \"...\",\n \"llama1RoleName\" : \"...\",\n \"llama2HostId\" : \"...\",\n \"llama2RoleName\" : \"...\",\n \"zkServiceName\" : \"...\",\n \"skipRestart\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiEnableLlamaRmArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : ""
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/importMrConfigsIntoYarn" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the Yarn service on which to run the command."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/initSolr" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Initializes the Solr service in Zookeeper.\n\n \nAvailable since API v4.",
"operationId" : "initSolrCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The Solr service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/installMrFrameworkJars" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the YARN service on which to run the command."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/installOozieShareLib" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Creates directory for Oozie user in HDFS and installs the ShareLib in it.\n \nNote:\n \nAvailable since API v30.",
"operationId" : "ksMigrateToSentry",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "the created command instance"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "A String representing the KeyStore Indexer service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/offline" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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<\/em> state which\nprevents unnecessary re-replication which could occur if decommissioned.\n \nThe timeout<\/em> 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<\/em>\nstate, back to HDFS IN SERVICE<\/em> state.\n ",
"operationId" : "offlineCommand",
"requestBody" : {
"description" : "List of role names to offline.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ \"...\", \"...\" ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRoleNameList"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The service name."
},
{
"name" : "timeout",
"in" : "query",
"schema" : {
"type" : "integer",
"format" : "int64"
},
"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)."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/oozieCreateEmbeddedDatabase" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the Oozie service on which to run the command."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/oozieDisableHa" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"description" : "Arguments for the command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"activeName\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiDisableOozieHaArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The Oozie service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/oozieDumpDatabase" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Dump the Oozie Server Database.",
"operationId" : "oozieDumpDatabaseCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the service"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/oozieEnableHa" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"description" : "Arguments for the command.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"newOozieServerHostIds\" : [ \"...\", \"...\" ],\n \"newOozieServerRoleNames\" : [ \"...\", \"...\" ],\n \"zkServiceName\" : \"...\",\n \"loadBalancerHostname\" : \"...\",\n \"loadBalancerPort\" : 12345,\n \"loadBalancerSslPort\" : 12345\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiEnableOozieHaArguments"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The Oozie service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/oozieLoadDatabase" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Load the Oozie Server Database from dump.",
"operationId" : "oozieLoadDatabaseCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the service"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/oozieUpgradeDb" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Upgrade Oozie Database schema as part of a major version upgrade.\n \nThe list should contain names of slave roles to recommission.\n<\/p>\n\n \nAvailable since API v2.\n<\/p>",
"operationId" : "recommissionCommand",
"requestBody" : {
"description" : "List of role names to recommision.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ \"...\", \"...\" ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRoleNameList"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the service on which to run the command."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/recommissionWithStart" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Start and recommission roles of a service.\n \nThe list should contain names of slave roles to start and recommission.\n<\/p>\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<\/p>\n\n \nAvailable since API v15.\n<\/p>",
"operationId" : "recommissionWithStartCommand",
"requestBody" : {
"description" : "List of role names to recommision.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ \"...\", \"...\" ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRoleNameList"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the service on which to run the command."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/restart" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Restart the service.",
"operationId" : "restartCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"HISTORY_NOT_AVAILABLE\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The service to start."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/rollingRestart" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"requestBody" : {
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"slaveBatchSize\" : 12345,\n \"sleepSeconds\" : 12345,\n \"slaveFailCountThreshold\" : 12345,\n \"staleConfigsOnly\" : true,\n \"unUpgradedOnly\" : true,\n \"restartRoleTypes\" : [ \"...\", \"...\" ],\n \"restartRoleNames\" : [ \"...\", \"...\" ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiRollingRestartArgs"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STARTED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : ""
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/rotateEcsCertificates" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Rotate ECS Internal Certificates.\n \nThis command will rotate the TLS/SSL certificates used by Vault, Embedded DB, and\nTolerations Webhook. It also rotates the ingress controller certificate if it\nis using the default certificate.\n<\/p>",
"operationId" : "rotateEcsCertificates",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : ""
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "the name of the ECS service"
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/sentryCreateDatabase" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the Sentry service on which to run the command."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/sentryCreateDatabaseTables" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"STOPPED\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the Sentry service on which to run the command."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/sentryUpgradeDatabaseTables" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"roleStatus\" : \"STARTING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "Information about the submitted command"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "Name of the Sentry service on which to run the command."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/solrBootstrapCollections" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"BAD\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"CONCERNING\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "the created command instance"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "A String representing the Solr service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/solrBootstrapConfig" : {
"post" : {
"tags" : [ "ServicesResource" ],
"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",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"DISABLED\",\n \"roleStatus\" : \"UNKNOWN\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"NA\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "the created command instance"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "A String representing the Solr service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/solrConfigBackup" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Backs up Solr configuration metadata before CDH upgrade.\n \nNote:\n \nNote:\n\n
\n
\n \"tags\": {\n \"Project\": \"BDR\",\n \"Environment\": \"Test\",\n \"Owner\": \"QE\"\n }\n <\/pre><\/code>",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"options" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiAwsDataSyncTaskOptions"
},
"schedule" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiAwsDataSyncTaskSchedule"
}
},
"example" : {
"sourceLocation" : {
"s3Path" : "...",
"iamRoleArn" : "..."
},
"destinationLocation" : {
"s3Path" : "...",
"iamRoleArn" : "..."
},
"name" : "...",
"excludeFilters" : [ "...", "..." ],
"includeFilters" : [ "...", "..." ],
"tags" : {
"property1" : "...",
"property2" : "..."
},
"options" : {
"transferMode" : "CHANGED",
"verifyMode" : "NONE",
"overwriteMode" : "NEVER",
"preserveAtime" : true,
"preserveMtime" : true,
"preserveUserId" : true,
"preserveGroupId" : true,
"preserveDeletedFiles" : true,
"preserveDevices" : true,
"preservePosixPermissions" : true,
"preserveObjectTags" : true,
"bytesPerSecond" : 12345,
"taskQueueing" : true
},
"schedule" : {
"scheduleExpression" : "..."
}
},
"description" : "Options to be used for creating an AWS DataSync task.\nEquivalent of com.amazonaws.services.datasync.model.CreateTaskRequest,\nbut it might not contain every possible option."
}
,
"ApiAwsDataSyncTaskOptions" : {
"type" : "object",
"title" : "ApiAwsDataSyncTaskOptions",
"properties" : {
"transferMode" : {
"readOnly" : false,
"$ref" : "#/components/schemas/TransferMode"
},
"verifyMode" : {
"readOnly" : false,
"$ref" : "#/components/schemas/VerifyMode"
},
"overwriteMode" : {
"readOnly" : false,
"$ref" : "#/components/schemas/OverwriteMode"
},
"preserveAtime" : {
"readOnly" : false,
"description" : "Specifies whether to preserve metadata indicating the last time a file was read or written to.\nThe behavior of Atime<\/code> isn't fully standard across platforms,\nso DataSync can only do this on a best-effort basis.\n
\nThis must be set to the same value as #preserveMtime.",
"type" : "boolean"
},
"preserveMtime" : {
"readOnly" : false,
"description" : "Specifies whether to preserve metadata indicating the last time that a file was written to\nbefore the PREPARING<\/code> phase of your task execution.\nThis option is required when you need to run the task more than once.\n
\nThis must be set to the same value as #preserveAtime.",
"type" : "boolean"
},
"preserveUserId" : {
"readOnly" : false,
"description" : "Specifies whether to preserve the POSIX user ID (UID) of the file's owner.\n
\nif you want DataSync to use a maximum of 1 MB,\nset this value to 1048576<\/code> (=1024*1024<\/code>).\nhdfs://namenode:8020/source/seqfile<\/code> or ofs://ozone-service/vol/bkt/file<\/code>.\n<\/p>",
"type" : "string"
},
"outputPath" : {
"readOnly" : false,
"description" : "Absolute path (including protocol and HDFS namenode address/Ozone service ID) to the output file.\nnull<\/code> values are not allowed.",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"unsetConfigs" : {
"readOnly" : false,
"description" : "A set of configuration options to be unset.\nnull<\/code> values are not allowed.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"additionalEnvironmentVariables" : {
"readOnly" : false,
"description" : "A map of additional environment variables to be used in the one-off process\n\nThis is the place to add environment variables related to e.g. kinit<\/code>\nthat acquires the TGT on the execution-side (usually the destination)\nor JVM options.\n\nnull<\/code> values are not allowed; this interface must be changed should that be necessary.",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"example" : {
"inputPath" : "...",
"outputPath" : "...",
"statusType" : "...",
"inputFormat" : "...",
"outputFormat" : "...",
"additionalConfigs" : {
"property1" : "...",
"property2" : "..."
},
"unsetConfigs" : [ "...", "..." ],
"additionalEnvironmentVariables" : {
"property1" : "...",
"property2" : "..."
}
},
"description" : "Represents the arguments required for formatting copylisting files.\n\n\n
hdfs://namenode:8020/source/seqfile<\/code> or ofs://ozone-service/vol/bkt/file<\/code>.<\/li>\nnull<\/code> values are not allowed.<\/li>\nnull<\/code> values are not allowed.<\/li>\nnull<\/code> values are not allowed.<\/li>\n<\/ul>"
}
,
"ApiGenerateCmcaArguments" : {
"type" : "object",
"title" : "ApiGenerateCmcaArguments",
"allOf" : [
{
"$ref" : "#/components/schemas/BaseApiSshCmdArguments"
},
{
"properties" : {
"location" : {
"example" : "/opt/cloudera/CMCA",
"readOnly" : false,
"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,
"readOnly" : 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,
"readOnly" : false,
"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",
"readOnly" : false,
"description" : "The certificate for the CM host in PEM format. Only used if customCA == true.",
"type" : "string"
},
"cmHostKey" : {
"example" : "host-key.pem",
"readOnly" : false,
"description" : "The private key for the CM host in PEM format. Only used if customCA == true.",
"type" : "string"
},
"caCert" : {
"example" : "ca-cert.pem",
"readOnly" : false,
"description" : "The certificate for the user-provided certificate authority in PEM format. Only used if\ncustomCA == true.",
"type" : "string"
},
"keystorePasswd" : {
"example" : "keystore.pw.txt",
"readOnly" : false,
"description" : "The password used for all Auto-TLS keystores. Only used if customCA == true.",
"type" : "string"
},
"truststorePasswd" : {
"example" : "truststore.pw.txt",
"readOnly" : false,
"description" : "The password used for all Auto-TLS truststores. Only used if customCA == true.",
"type" : "string"
},
"trustedCaCerts" : {
"example" : "cacerts.pem",
"readOnly" : false,
"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",
"readOnly" : false,
"description" : "A list of additional arguments that can be passed to the certificate manager",
"type" : "array",
"items" : {
"type" : "string"
}
},
"hostCerts" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiHostCertInfo"
}
},
"configureAllServices" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The url of the remote repository where the private cloud artifacts to install are hosted",
"type" : "string"
},
"dockerRegistry" : {
"readOnly" : false,
"description" : "The url of the Docker Registry where images required for install will be copied to",
"type" : "string"
},
"controlPlaneUuid" : {
"readOnly" : false,
"description" : "Optional. The uuid of the control plane, if copying docker images for an upgrade",
"type" : "string"
},
"selectedFeatures" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The url of the remote repository where the private cloud artifacts to install are hosted",
"type" : "string"
},
"namespace" : {
"readOnly" : false,
"description" : "The namespace of the CDP Private control plane",
"type" : "string"
},
"vaultAddr" : {
"readOnly" : false,
"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" : "#/components/schemas/BaseApiSshCmdArguments"
},
{
"properties" : {
"subjectAltName" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
],
"example" : {
"subjectAltName" : [ "...", "..." ],
"sshPort" : 22,
"userName" : "...",
"password" : "...",
"privateKey" : "...",
"passphrase" : "..."
},
"description" : "Arguments to install certificates on a host"
}
,
"ApiGenericResponse" : {
"type" : "object",
"title" : "ApiGenericResponse",
"properties" : {
"success" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"code" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiResponseTypes"
},
"message" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"success" : true,
"code" : "UNKNOWN_PARAMETER",
"message" : "..."
},
"description" : "A generic response object"
}
,
"ApiHBaseAddReplicationPeerInput" : {
"type" : "object",
"title" : "ApiHBaseAddReplicationPeerInput",
"required" : ["enabled"],
"properties" : {
"peerId" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"clusterKey" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"tableCFs" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"endpointClassname" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"enabled" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
}
},
"example" : {
"peerId" : "...",
"clusterKey" : "...",
"tableCFs" : {
"property1" : [ "...", "..." ],
"property2" : [ "...", "..." ]
},
"endpointClassname" : "...",
"enabled" : true
},
"description" : ""
}
,
"ApiHBaseCreateTable" : {
"type" : "object",
"title" : "ApiHBaseCreateTable",
"properties" : {
"tableName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"columnFamily" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"tableName" : "...",
"columnFamily" : "..."
},
"description" : ""
}
,
"ApiHBasePeerId" : {
"type" : "object",
"title" : "ApiHBasePeerId",
"properties" : {
"id" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"id" : "..."
},
"description" : "Encapsulates the ID of an HBase peer."
}
,
"ApiHBasePeerIdWithTableCFs" : {
"type" : "object",
"title" : "ApiHBasePeerIdWithTableCFs",
"properties" : {
"peerId" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"tableCFs" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"example" : {
"peerId" : "...",
"tableCFs" : {
"property1" : [ "...", "..." ],
"property2" : [ "...", "..." ]
}
},
"description" : ""
}
,
"ApiHBaseReplicationArguments" : {
"type" : "object",
"title" : "ApiHBaseReplicationArguments",
"properties" : {
"sourceHBaseService" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiServiceRef"
},
"peerState" : {
"readOnly" : false,
"$ref" : "#/components/schemas/HBasePeerState"
},
"hbasePeerId" : {
"readOnly" : false,
"description" : "Available since API v52.",
"type" : "string"
},
"hbaseClusterKey" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"endPointClassName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"tables" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/HBaseTableArgs"
}
},
"database" : {
"readOnly" : false,
"$ref" : "#/components/schemas/HBaseDatabaseArgs"
},
"replicationProperties" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"sourceAccount" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"sourceSchedulerPool" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"numMappers" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int32"
},
"bandwidthPerMap" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int32"
},
"exportSnapshotUser" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"snapshotScratchLocation" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"validateReplicationSetup" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"maxParallelSnapshots" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int32"
}
},
"example" : {
"sourceHBaseService" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"peerState" : "ENABLED",
"hbasePeerId" : "...",
"hbaseClusterKey" : "...",
"endPointClassName" : "...",
"tables" : [ {
"tableName" : "...",
"initialSnapshot" : true,
"snapshotSucceeded" : true
}, {
"tableName" : "...",
"initialSnapshot" : true,
"snapshotSucceeded" : true
} ],
"database" : {
"failedSnapshotTables" : [ "...", "..." ],
"initialSnapshot" : true,
"replicationStrategy" : "TABLES_WITH_REPLICATION_SCOPE_SET"
},
"replicationProperties" : {
"property1" : "...",
"property2" : "..."
},
"sourceAccount" : "...",
"sourceSchedulerPool" : "...",
"numMappers" : 12345,
"bandwidthPerMap" : 12345,
"exportSnapshotUser" : "...",
"snapshotScratchLocation" : "...",
"validateReplicationSetup" : true,
"maxParallelSnapshots" : 12345
},
"description" : "Replication arguments for HBase service"
}
,
"ApiHBaseReplicationInfo" : {
"type" : "object",
"title" : "ApiHBaseReplicationInfo",
"properties" : {
"replicationOperations" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"example" : {
"replicationOperations" : [ "...", "..." ]
},
"description" : ""
}
,
"ApiHBaseReplicationSecurityTool" : {
"type" : "object",
"title" : "ApiHBaseReplicationSecurityTool",
"properties" : {
"password" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"keystoreFilePath" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"password" : "...",
"keystoreFilePath" : "..."
},
"description" : "HBase Replication Security Tool Management"
}
,
"ApiHBaseReplicationSetupCleanAndResetArgs" : {
"type" : "object",
"title" : "ApiHBaseReplicationSetupCleanAndResetArgs",
"properties" : {
"sourceRef" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiServiceRef"
},
"cmPeerNameOnRemote" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"sourceRestartType" : {
"readOnly" : false,
"$ref" : "#/components/schemas/RestartType"
},
"targetRestartType" : {
"readOnly" : false,
"$ref" : "#/components/schemas/RestartType"
}
},
"example" : {
"sourceRef" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"cmPeerNameOnRemote" : "...",
"sourceRestartType" : "ROLLING_RESTART",
"targetRestartType" : "NO_RESTART"
},
"description" : ""
}
,
"ApiHBaseReplicationSetupCommandArgs" : {
"type" : "object",
"title" : "ApiHBaseReplicationSetupCommandArgs",
"properties" : {
"keystorePassword" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"replicationUser" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"sourceRef" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiServiceRef"
},
"cmPeerNameOnRemote" : {
"readOnly" : false,
"description" : "The peer name of the local CM in the given sourceRef CM",
"type" : "string"
},
"sourceRestartType" : {
"readOnly" : false,
"$ref" : "#/components/schemas/RestartType"
},
"targetRestartType" : {
"readOnly" : false,
"$ref" : "#/components/schemas/RestartType"
}
},
"example" : {
"keystorePassword" : "...",
"replicationUser" : "...",
"sourceRef" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"cmPeerNameOnRemote" : "...",
"sourceRestartType" : "RESTART",
"targetRestartType" : "NO_RESTART"
},
"description" : "Command args for HBaseReplicationSetupCommand"
}
,
"ApiHBaseReplicationSetupOneClusterOnlyCmdArgs" : {
"type" : "object",
"title" : "ApiHBaseReplicationSetupOneClusterOnlyCmdArgs",
"properties" : {
"sourceRef" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiServiceRef"
},
"restartType" : {
"readOnly" : false,
"$ref" : "#/components/schemas/RestartType"
}
},
"example" : {
"sourceRef" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"restartType" : "NO_RESTART"
},
"description" : "Command args for HBase replication first time setup for only one cluster: either source or target"
}
,
"ApiHBaseReplicationSetupStatus" : {
"type" : "object",
"title" : "ApiHBaseReplicationSetupStatus",
"properties" : {
"status" : {
"readOnly" : false,
"$ref" : "#/components/schemas/Status"
},
"subStatus" : {
"readOnly" : false,
"$ref" : "#/components/schemas/SubStatus"
},
"mainCommandId" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiCommand"
},
"currentCommandId" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiCommand"
},
"error" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"status" : "NOT_READY",
"subStatus" : "RESTARTING",
"mainCommandId" : {
"id" : 12345,
"name" : "...",
"startTime" : "...",
"endTime" : "...",
"active" : true,
"success" : true,
"resultMessage" : "...",
"resultDataUrl" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"serviceRef" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "NOT_AVAILABLE",
"roleStatus" : "HISTORY_NOT_AVAILABLE"
},
"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" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"roleRef" : {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "BAD",
"roleStatus" : "STOPPING"
},
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"parent" : { },
"children" : {
"items" : [ { }, { } ]
},
"canRetry" : true
},
"error" : "..."
},
"description" : "Contains status info about the HBase replication first time setup"
}
,
"ApiHBaseReplicationUpdatePeerStateArgs" : {
"type" : "object",
"title" : "ApiHBaseReplicationUpdatePeerStateArgs",
"properties" : {
"sourceRef" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiServiceRef"
},
"peerState" : {
"readOnly" : false,
"$ref" : "#/components/schemas/HBasePeerState"
}
},
"example" : {
"sourceRef" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"peerState" : "DISABLED"
},
"description" : "Replication arguments for HBase service enabled/disabled peer update"
}
,
"ApiHBaseSetCFsReplicationScope" : {
"type" : "object",
"title" : "ApiHBaseSetCFsReplicationScope",
"required" : ["scope"],
"properties" : {
"scope" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int32"
},
"tableCFs" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
},
"example" : {
"scope" : 12345,
"tableCFs" : {
"property1" : [ "...", "..." ],
"property2" : [ "...", "..." ]
}
},
"description" : ""
}
,
"ApiHBaseShellCommand" : {
"type" : "object",
"title" : "ApiHBaseShellCommand",
"properties" : {
"payload" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Snapshot name.",
"type" : "string"
},
"tableName" : {
"readOnly" : false,
"description" : "Name of the table this snapshot is for.",
"type" : "string"
},
"creationTime" : {
"readOnly" : false,
"description" : "Snapshot creation time.",
"type" : "string",
"format" : "date-time"
},
"storage" : {
"readOnly" : false,
"$ref" : "#/components/schemas/Storage"
},
"storageLocation" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Name of the table.",
"type" : "string"
},
"snapshotName" : {
"readOnly" : false,
"description" : "Name of the snapshot.",
"type" : "string"
},
"storage" : {
"readOnly" : false,
"$ref" : "#/components/schemas/Storage"
},
"storageLocation" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Description of the error.",
"type" : "string"
}
},
"example" : {
"tableName" : "...",
"snapshotName" : "...",
"storage" : "LOCAL",
"storageLocation" : "...",
"error" : "..."
},
"description" : "A HBase snapshot operation error."
}
,
"ApiHBaseSnapshotPolicyArguments" : {
"type" : "object",
"title" : "ApiHBaseSnapshotPolicyArguments",
"properties" : {
"tableRegExps" : {
"readOnly" : false,
"description" : "The regular expressions specifying the tables. Tables matching any of them\nwill be eligible for snapshot creation.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"storage" : {
"readOnly" : false,
"$ref" : "#/components/schemas/Storage"
}
},
"example" : {
"tableRegExps" : [ "...", "..." ],
"storage" : "REMOTE_S3"
},
"description" : "HBase specific snapshot policy arguments."
}
,
"ApiHBaseSnapshotResult" : {
"type" : "object",
"title" : "ApiHBaseSnapshotResult",
"properties" : {
"processedTableCount" : {
"readOnly" : false,
"description" : "Number of processed tables.",
"type" : "integer",
"format" : "int32"
},
"processedTables" : {
"readOnly" : false,
"description" : "The list of processed tables.\n\nThis is only available in the full view.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"unprocessedTableCount" : {
"readOnly" : false,
"description" : "Number of unprocessed tables.",
"type" : "integer",
"format" : "int32"
},
"unprocessedTables" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Number of snapshots created.",
"type" : "integer",
"format" : "int32"
},
"createdSnapshots" : {
"readOnly" : false,
"description" : "List of snapshots created.\n\nThis is only available in the full view.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiHBaseSnapshot"
}
},
"deletedSnapshotCount" : {
"readOnly" : false,
"description" : "Number of snapshots deleted.",
"type" : "integer",
"format" : "int32"
},
"deletedSnapshots" : {
"readOnly" : false,
"description" : "List of snapshots deleted.\n\nThis is only available in the full view.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiHBaseSnapshot"
}
},
"creationErrorCount" : {
"readOnly" : false,
"description" : "Number of errors detected when creating snapshots.",
"type" : "integer",
"format" : "int32"
},
"creationErrors" : {
"readOnly" : false,
"description" : "List of errors encountered when creating snapshots.\n\nThis is only available in the full view.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiHBaseSnapshotError"
}
},
"deletionErrorCount" : {
"readOnly" : false,
"description" : "Number of errors detected when deleting snapshots.",
"type" : "integer",
"format" : "int32"
},
"deletionErrors" : {
"readOnly" : false,
"description" : "List of errors encountered when deleting snapshots.\n\nThis is only available in the full view.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiHBaseSnapshotError"
}
}
},
"example" : {
"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" : "LOCAL",
"storageLocation" : "..."
} ],
"creationErrorCount" : 12345,
"creationErrors" : [ {
"tableName" : "...",
"snapshotName" : "...",
"storage" : "LOCAL",
"storageLocation" : "...",
"error" : "..."
}, {
"tableName" : "...",
"snapshotName" : "...",
"storage" : "REMOTE_S3",
"storageLocation" : "...",
"error" : "..."
} ],
"deletionErrorCount" : 12345,
"deletionErrors" : [ {
"tableName" : "...",
"snapshotName" : "...",
"storage" : "LOCAL",
"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" : {
"readOnly" : false,
"description" : "Table name.",
"type" : "string"
},
"deleted" : {
"readOnly" : false,
"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" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
],
"example" : {
"items" : [ "...", "..." ]
},
"description" : "Encapsulates table names from HBase."
}
,
"ApiHBaseUpdateReplicationPeerState" : {
"type" : "object",
"title" : "ApiHBaseUpdateReplicationPeerState",
"required" : ["enabled"],
"properties" : {
"hbasePeerId" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"enabled" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
}
},
"example" : {
"hbasePeerId" : "...",
"enabled" : true
},
"description" : ""
}
,
"ApiHdfsCloudReplicationArguments" : {
"type" : "object",
"title" : "ApiHdfsCloudReplicationArguments",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiHdfsReplicationArguments"
},
{
"properties" : {
"sourceAccount" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"destinationAccount" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
}
}
],
"example" : {
"sourceAccount" : "...",
"destinationAccount" : "...",
"sourceService" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"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,
"numFetchThreads" : 12345,
"destinationCloudAccount" : "..."
},
"description" : "Replication arguments for HDFS."
}
,
"ApiHdfsDisableHaArguments" : {
"type" : "object",
"title" : "ApiHdfsDisableHaArguments",
"properties" : {
"activeName" : {
"readOnly" : false,
"description" : "Name of the the NameNode to be kept.",
"type" : "string"
},
"secondaryName" : {
"readOnly" : false,
"description" : "Name of the SecondaryNamenode to associate with the active NameNode.",
"type" : "string"
},
"startDependentServices" : {
"readOnly" : false,
"description" : "Whether to re-start dependent services. Defaults to true.",
"type" : "boolean"
},
"deployClientConfigs" : {
"readOnly" : false,
"description" : "Whether to re-deploy client configurations. Defaults to true.",
"type" : "boolean"
},
"disableQuorumStorage" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Nameservice for which to enable automatic failover.",
"type" : "string"
},
"zooKeeperService" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiServiceRef"
},
"activeFCName" : {
"readOnly" : false,
"description" : "Name of the failover controller to create for the active NameNode.",
"type" : "string"
},
"standByFCName" : {
"readOnly" : false,
"description" : "Name of the failover controller to create for the stand-by NameNode.",
"type" : "string"
}
},
"example" : {
"nameservice" : "...",
"zooKeeperService" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"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" : {
"readOnly" : false,
"description" : "Fully qualified path of file.",
"type" : "string"
},
"length" : {
"readOnly" : false,
"description" : "Size of file.",
"type" : "integer",
"format" : "int64"
},
"dir" : {
"readOnly" : false,
"description" : "Indicates whether the file is a directory.",
"type" : "boolean"
},
"replication" : {
"readOnly" : false,
"description" : "Configured block replication factor of file.",
"type" : "number"
},
"blockSize" : {
"readOnly" : false,
"description" : "Configured block size of file in bytes.",
"type" : "integer",
"format" : "int64"
},
"modificationTime" : {
"readOnly" : false,
"description" : "Last modification time of file in milliseconds since January 1, 1970 UTC.",
"type" : "string",
"format" : "date-time"
},
"accessTime" : {
"readOnly" : false,
"description" : "Last access time of file in milliseconds since January 1, 1970 UTC.",
"type" : "string",
"format" : "date-time"
},
"permission" : {
"readOnly" : false,
"description" : "Permission of the file where the digits in order represent:\nSticky bit, User action, Group action, Other action.",
"type" : "number"
},
"owner" : {
"readOnly" : false,
"description" : "Owner of the file.",
"type" : "string"
},
"group" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Name of the active NameNode.",
"type" : "string"
},
"activeSharedEditsPath" : {
"readOnly" : false,
"description" : "Path to the shared edits directory on the active NameNode's host.\nIgnored if Quorum-based Storage is being enabled.",
"type" : "string"
},
"standByName" : {
"readOnly" : false,
"description" : "Name of the stand-by Namenode.",
"type" : "string"
},
"standBySharedEditsPath" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "Nameservice that identifies the HA pair.",
"type" : "string"
},
"startDependentServices" : {
"readOnly" : false,
"description" : "Whether to re-start dependent services. Defaults to true.",
"type" : "boolean"
},
"deployClientConfigs" : {
"readOnly" : false,
"description" : "Whether to re-deploy client configurations. Defaults to true.",
"type" : "boolean"
},
"enableQuorumStorage" : {
"readOnly" : false,
"description" : "This parameter has been deprecated as of CM 5.0, where HA\nis only supported using Quorum-based Storage.\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" : {
"readOnly" : false,
"description" : "The passphrase associated with the private key\nused to authenticate with the hosts (optional).",
"type" : "string"
},
"parallelInstallCount" : {
"readOnly" : false,
"description" : "Number of simultaneous installations.\nDefaults to 10. Running a large number of\ninstallations at once can consume large\namounts of network bandwidth and other system\nresources.",
"type" : "integer",
"format" : "int32"
},
"cmRepoUrl" : {
"readOnly" : false,
"description" : "The Cloudera Manager repository URL to use (optional).\nExample for SLES, Redhat or Debian based distributions:\nhttps://archive.cloudera.com/cm6/6.0.0",
"type" : "string"
},
"gpgKeyCustomUrl" : {
"readOnly" : false,
"description" : "The Cloudera Manager public GPG key (optional).\nExample for SLES, Redhat or other RPM based distributions:\nhttps://archive.cloudera.com/cm5/redhat/5/x86_64/cm/RPM-GPG-KEY-cloudera\nExample for Ubuntu or other Debian based distributions:\nhttps://archive.cloudera.com/cm5/ubuntu/lucid/amd64/cm/archive.key",
"type" : "string"
},
"javaInstallStrategy" : {
"readOnly" : false,
"description" : "Added in v8: Strategy to use for JDK installation. Valid values are\n
\n1. AUTO: Cloudera Manager will install the JDK versions that are\nrequired when the \"AUTO\" option is selected. This package will be downloaded\nfrom Cloudera repository.\nThis operation may overwrite any of the existing JDK installations.\n
\n2. NONE(default): Cloudera Manager will not install any JDK when \"NONE\" option is selected.\nIt should be used if an existing JDK installation can be used. NOTE: Selecting\nthe \"NONE\" option makes it the customer's responsibility to ensure that the\nunlimited strength JCE policy files are installed and enabled on each host, as\nappropriate for the version of Java in use.\n
\n3. OS_PROVIDED_JDK: Option added in v40, Cloudera Manager will install OpenJDK packages\nprovided by the [non-cloudera] Operating System repositories configured on each\nhost. This operation may overwrite any of the existing JDK installations.",
"type" : "string"
},
"unlimitedJCE" : {
"readOnly" : false,
"description" : "Added in v8: Flag for unlimited strength JCE policy files installation\nIf unset, defaults to false\n
\nDeprecated in CM 7.0.2: Flag for unlimited strength JCE policy files installation\nwill be set to False.\nNOTE: With OpenJDK11 (and OpenJDK8 u232), JCE is installed and enabled by default.",
"type" : "boolean"
},
"gpgKeyOverrideBundle" : {
"readOnly" : false,
"description" : "The Cloudera Manager public GPG key (optional). This points to the actual bundle contents\nand not a URL.",
"type" : "string"
},
"agentReportedHostnames" : {
"readOnly" : false,
"description" : "Optional. A map from hostname to reported_hostname value to be set in the\nagent configuration file.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiMapEntry"
}
},
"subjectAltNames" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"example" : {
"hostNames" : [ "...", "..." ],
"sshPort" : 12345,
"userName" : "...",
"password" : "...",
"privateKey" : "...",
"passphrase" : "...",
"parallelInstallCount" : 12345,
"cmRepoUrl" : "...",
"gpgKeyCustomUrl" : "...",
"javaInstallStrategy" : "...",
"unlimitedJCE" : true,
"gpgKeyOverrideBundle" : "...",
"agentReportedHostnames" : [ {
"key" : "...",
"value" : "..."
}, {
"key" : "...",
"value" : "..."
} ],
"subjectAltNames" : [ "...", "..." ]
},
"description" : "Arguments to perform installation on one\nor more hosts"
}
,
"ApiHostList" : {
"type" : "object",
"title" : "ApiHostList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiHost"
}
}
}
}
],
"example" : {
"items" : [ {
"hostId" : "...",
"ipAddress" : "...",
"ipv6Address" : "...",
"hostname" : "...",
"rackId" : "...",
"lastHeartbeat" : "...",
"roleRefs" : [ {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "DISABLED",
"roleStatus" : "STARTED"
}, {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "CONCERNING",
"roleStatus" : "NA"
} ],
"healthSummary" : "GOOD",
"healthChecks" : [ {
"name" : "...",
"summary" : "NOT_AVAILABLE",
"explanation" : "...",
"suppressed" : true
}, {
"name" : "...",
"summary" : "BAD",
"explanation" : "...",
"suppressed" : true
} ],
"isParcelInfoAvailable" : true,
"hostUrl" : "...",
"maintenanceMode" : true,
"commissionState" : "COMMISSIONED",
"maintenanceOwners" : [ "CONTROL_PLANE", "SERVICE" ],
"config" : {
"items" : [ { }, { } ]
},
"numCores" : 12345,
"numPhysicalCores" : 12345,
"totalPhysMemBytes" : 12345,
"entityStatus" : "NONE",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"distribution" : {
"distributionType" : "UBUNTU_XENIAL",
"name" : "...",
"version" : "..."
},
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ]
}, {
"hostId" : "...",
"ipAddress" : "...",
"ipv6Address" : "...",
"hostname" : "...",
"rackId" : "...",
"lastHeartbeat" : "...",
"roleRefs" : [ {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "CONCERNING",
"roleStatus" : "STOPPED"
}, {
"clusterName" : "...",
"serviceName" : "...",
"roleName" : "...",
"healthSummary" : "CONCERNING",
"roleStatus" : "BUSY"
} ],
"healthSummary" : "NOT_AVAILABLE",
"healthChecks" : [ {
"name" : "...",
"summary" : "CONCERNING",
"explanation" : "...",
"suppressed" : true
}, {
"name" : "...",
"summary" : "DISABLED",
"explanation" : "...",
"suppressed" : true
} ],
"isParcelInfoAvailable" : true,
"hostUrl" : "...",
"maintenanceMode" : true,
"commissionState" : "OFFLINED",
"maintenanceOwners" : [ "SERVICE", "HOST" ],
"config" : {
"items" : [ { }, { } ]
},
"numCores" : 12345,
"numPhysicalCores" : 12345,
"totalPhysMemBytes" : 12345,
"entityStatus" : "CONCERNING_HEALTH",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"distribution" : {
"distributionType" : "RHEL8_ARM64",
"name" : "...",
"version" : "..."
},
"tags" : [ {
"name" : "...",
"value" : "..."
}, {
"name" : "...",
"value" : "..."
} ]
} ]
},
"description" : "A list of ApiHost objects"
}
,
"ApiHostMaintenanceResponse" : {
"type" : "object",
"title" : "ApiHostMaintenanceResponse",
"required" : ["success"],
"properties" : {
"success" : {
"readOnly" : false,
"description" : "success is true if host enters into maintenance and false otherwise",
"type" : "boolean"
},
"hostRef" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHostRef"
},
"errorMessage" : {
"readOnly" : false,
"description" : "The error message captures RunTime Exception messages when maintenance mode operation fails\nto execute on the host.",
"type" : "string"
}
},
"example" : {
"success" : true,
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"errorMessage" : "..."
},
"description" : ""
}
,
"ApiHostMaintenanceResponseList" : {
"type" : "object",
"title" : "ApiHostMaintenanceResponseList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"hostMaintenanceResponseList" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiHostMaintenanceResponse"
}
}
}
}
],
"example" : {
"hostMaintenanceResponseList" : [ {
"success" : true,
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"errorMessage" : "..."
}, {
"success" : true,
"hostRef" : {
"hostId" : "...",
"hostname" : "..."
},
"errorMessage" : "..."
} ]
},
"description" : "A generic list."
}
,
"ApiHostNameList" : {
"type" : "object",
"title" : "ApiHostNameList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "List of host names.",
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
],
"example" : {
"items" : [ "...", "..." ]
},
"description" : "A list of host names."
}
,
"ApiHostReallocateMemoryResponse" : {
"type" : "object",
"title" : "ApiHostReallocateMemoryResponse",
"properties" : {
"configsBefore" : {
"readOnly" : false,
"description" : "Configs with their values before recalculation.\nAvailable only for 'dry runs' where changes are not applied.\nThe objects in this list match the identity of objects returned by\n#getConfigsAfter().\nI.e. it contains only configs that will be affected by recalculation",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiConfigRecord"
}
},
"configsAfter" : {
"readOnly" : false,
"description" : "Configs whose value has changed due to the recalculation.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiConfigRecord"
}
}
},
"example" : {
"configsBefore" : [ {
"name" : "...",
"value" : "...",
"rcg" : {
"roleConfigGroupName" : "..."
},
"service" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"applicability" : "UNAFFECTED_DUE_TO_EQUAL_VALUE"
}, {
"name" : "...",
"value" : "...",
"rcg" : {
"roleConfigGroupName" : "..."
},
"service" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"applicability" : "UNAFFECTED_DUE_TO_EQUAL_VALUE"
} ],
"configsAfter" : [ {
"name" : "...",
"value" : "...",
"rcg" : {
"roleConfigGroupName" : "..."
},
"service" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"applicability" : "RECONFIGURABLE"
}, {
"name" : "...",
"value" : "...",
"rcg" : {
"roleConfigGroupName" : "..."
},
"service" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"applicability" : "UNAFFECTED_CONFIGURED_BY_USER"
} ]
},
"description" : ""
}
,
"ApiHostRef" : {
"type" : "object",
"title" : "ApiHostRef",
"properties" : {
"hostId" : {
"readOnly" : false,
"description" : "The unique host ID.",
"type" : "string"
},
"hostname" : {
"readOnly" : false,
"description" : "The hostname. Available since v31.",
"type" : "string"
}
},
"example" : {
"hostId" : "...",
"hostname" : "..."
},
"description" : "A reference to a host."
}
,
"ApiHostRefList" : {
"type" : "object",
"title" : "ApiHostRefList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiHostRef"
}
}
}
}
],
"example" : {
"items" : [ {
"hostId" : "...",
"hostname" : "..."
}, {
"hostId" : "...",
"hostname" : "..."
} ]
},
"description" : "A list of host references."
}
,
"ApiHostTemplate" : {
"type" : "object",
"title" : "ApiHostTemplate",
"properties" : {
"name" : {
"readOnly" : false,
"description" : "The name of the host template. Unique across clusters.",
"type" : "string"
},
"clusterRef" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiClusterRef"
},
"roleConfigGroupRefs" : {
"readOnly" : false,
"description" : "The role config groups belonging to this host tempalte.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiRoleConfigGroupRef"
}
}
},
"example" : {
"name" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"roleConfigGroupRefs" : [ {
"roleConfigGroupName" : "..."
}, {
"roleConfigGroupName" : "..."
} ]
},
"description" : "A host template belongs to a cluster and contains a set of role config\ngroups for slave roles (such as DataNodes and TaskTrackers) from services\nin the cluster. At most one role config group per role type can be present\nin a host template. Host templates can be applied to fresh hosts (those with\nno roles on them) in order to create a role for each of the role groups on\neach host."
}
,
"ApiHostTemplateList" : {
"type" : "object",
"title" : "ApiHostTemplateList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiHostTemplate"
}
}
}
}
],
"example" : {
"items" : [ {
"name" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"roleConfigGroupRefs" : [ {
"roleConfigGroupName" : "..."
}, {
"roleConfigGroupName" : "..."
} ]
}, {
"name" : "...",
"clusterRef" : {
"clusterName" : "...",
"displayName" : "..."
},
"roleConfigGroupRefs" : [ {
"roleConfigGroupName" : "..."
}, {
"roleConfigGroupName" : "..."
} ]
} ]
},
"description" : "A list of host templates."
}
,
"ApiHostsPerfInspectorArgs" : {
"type" : "object",
"title" : "ApiHostsPerfInspectorArgs",
"properties" : {
"sourceHostList" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHostNameList"
},
"targetHostList" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHostNameList"
},
"pingArgs" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiPerfInspectorPingArgs"
}
},
"example" : {
"sourceHostList" : {
"items" : [ "...", "..." ]
},
"targetHostList" : {
"items" : [ "...", "..." ]
},
"pingArgs" : {
"pingTimeoutSecs" : 10,
"pingCount" : 10,
"pingPacketSizeBytes" : 56
}
},
"description" : "Arguments used for the Cloudera Manager level performance inspector.\nNetwork diagnostics will be run from every host in sourceHostList to every host\nin targetHostList."
}
,
"ApiHostsToRemoveArgs" : {
"type" : "object",
"title" : "ApiHostsToRemoveArgs",
"required" : ["deleteHosts"],
"properties" : {
"hostsToRemove" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"type" : "string"
}
},
"deleteHosts" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
}
},
"example" : {
"hostsToRemove" : [ "...", "..." ],
"deleteHosts" : true
},
"description" : "Arguments passed to the remove hosts from cluster api, every host passed in\nhas the roles in it deleted and the host is removed from the cluster,\nbut is still managed by CM.\n\nIf deleteHosts is set to true hosts are also deleted from CM."
}
,
"ApiIcebergReplicationArguments" : {
"type" : "object",
"title" : "ApiIcebergReplicationArguments",
"required" : ["atlasReplicationNeeded", "forceTest", "deleteOperation"],
"properties" : {
"sourceIcebergReplicationService" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiServiceRef"
},
"policyName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"includedTableFilters" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiHiveTable"
}
},
"excludedTableFilters" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiHiveTable"
}
},
"batchSize" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int32"
},
"proxyName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"exportYarnOptions" : {
"readOnly" : false,
"$ref" : "#/components/schemas/IcebergReplicationYarnOptions"
},
"xferYarnOptions" : {
"readOnly" : false,
"$ref" : "#/components/schemas/IcebergReplicationYarnOptions"
},
"syncYarnOptions" : {
"readOnly" : false,
"$ref" : "#/components/schemas/IcebergReplicationYarnOptions"
},
"shouldReplicateColumnStats" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"atlasReplicationNeeded" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"policyOptions" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"atlasChangeMarker" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"atlasClientAdvanceConfigs" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"safetyValvesSource" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/IcebergReplicationSafetyValve"
}
},
"safetyValvesTarget" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"$ref" : "#/components/schemas/IcebergReplicationSafetyValve"
}
},
"runDistcpOnSource" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"altStagingLocation" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"forceTest" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"deleteOperation" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"jvmOptsForExport" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"jvmOptsForXfer" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"jvmOptsForSync" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"locationMapping" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiMapEntry"
}
},
"sourceStorageFilter" : {
"readOnly" : false,
"$ref" : "#/components/schemas/SourceStorageFilter"
},
"proxyNameOnSource" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"sourceIcebergReplicationService" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"policyName" : "...",
"includedTableFilters" : [ {
"database" : "...",
"tableName" : "..."
}, {
"database" : "...",
"tableName" : "..."
} ],
"excludedTableFilters" : [ {
"database" : "...",
"tableName" : "..."
}, {
"database" : "...",
"tableName" : "..."
} ],
"batchSize" : 12345,
"proxyName" : "...",
"exportYarnOptions" : {
"schedulerPoolName" : "...",
"numberOfMappers" : 12345,
"bandwidthPerMap" : 12345
},
"xferYarnOptions" : {
"schedulerPoolName" : "...",
"numberOfMappers" : 12345,
"bandwidthPerMap" : 12345
},
"syncYarnOptions" : {
"schedulerPoolName" : "...",
"numberOfMappers" : 12345,
"bandwidthPerMap" : 12345
},
"shouldReplicateColumnStats" : true,
"atlasReplicationNeeded" : true,
"policyOptions" : {
"property1" : "...",
"property2" : "..."
},
"atlasChangeMarker" : "...",
"atlasClientAdvanceConfigs" : {
"property1" : "...",
"property2" : "..."
},
"safetyValvesSource" : {
"property1" : {
"configs" : [ {
"key" : "...",
"value" : "..."
}, {
"key" : "...",
"value" : "..."
} ]
},
"property2" : {
"configs" : [ {
"key" : "...",
"value" : "..."
}, {
"key" : "...",
"value" : "..."
} ]
}
},
"safetyValvesTarget" : {
"property1" : {
"configs" : [ {
"key" : "...",
"value" : "..."
}, {
"key" : "...",
"value" : "..."
} ]
},
"property2" : {
"configs" : [ {
"key" : "...",
"value" : "..."
}, {
"key" : "...",
"value" : "..."
} ]
}
},
"runDistcpOnSource" : true,
"altStagingLocation" : "...",
"forceTest" : true,
"deleteOperation" : true,
"jvmOptsForExport" : "...",
"jvmOptsForXfer" : "...",
"jvmOptsForSync" : "...",
"locationMapping" : [ {
"key" : "...",
"value" : "..."
}, {
"key" : "...",
"value" : "..."
} ],
"sourceStorageFilter" : "HDFS",
"proxyNameOnSource" : "..."
},
"description" : "Replication Arguments for Iceberg Replication policies"
}
,
"ApiIcebergReplicationRemoteCommand" : {
"type" : "object",
"title" : "ApiIcebergReplicationRemoteCommand",
"properties" : {
"command" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"args" : {
"readOnly" : false,
"description" : "",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"example" : {
"command" : "...",
"args" : {
"property1" : "...",
"property2" : "..."
}
},
"description" : "API request to execute an iceberg remote command\n\nThe payload (command) is executed by the remote Iceberg Replication service."
}
,
"ApiIcebergReplicationResult" : {
"type" : "object",
"title" : "ApiIcebergReplicationResult",
"properties" : {
"numberOfTablesProcessed" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int64"
},
"numberOfFilesCopied" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int64"
},
"numberOfFilesDeleted" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int64"
},
"numberOfManifestsTransformed" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int64"
},
"failed" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"timestamp" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"copyMetadataJobDetailsUri" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"copyDataJobDetailsUri" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"copyDeleteDataJobDetailsUri" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"copyMetadataJobId" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"copyDataJobId" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"copyDeleteDataJobId" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"peerName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"peerClusterName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"numberOfTablesProcessed" : 12345,
"numberOfFilesCopied" : 12345,
"numberOfFilesDeleted" : 12345,
"numberOfManifestsTransformed" : 12345,
"failed" : true,
"timestamp" : "...",
"copyMetadataJobDetailsUri" : "...",
"copyDataJobDetailsUri" : "...",
"copyDeleteDataJobDetailsUri" : "...",
"copyMetadataJobId" : "...",
"copyDataJobId" : "...",
"copyDeleteDataJobId" : "...",
"peerName" : "...",
"peerClusterName" : "..."
},
"description" : "Detailed information about an ICEBERG replication job."
}
,
"ApiIcebergReplicationTableFilters" : {
"type" : "object",
"title" : "ApiIcebergReplicationTableFilters",
"properties" : {
"includedTableFilters" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiHiveTable"
}
},
"excludedTableFilters" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiHiveTable"
}
}
},
"example" : {
"includedTableFilters" : [ {
"database" : "...",
"tableName" : "..."
}, {
"database" : "...",
"tableName" : "..."
} ],
"excludedTableFilters" : [ {
"database" : "...",
"tableName" : "..."
}, {
"database" : "...",
"tableName" : "..."
} ]
},
"description" : ""
}
,
"ApiIcebergReplicationTestAccessPaths" : {
"type" : "object",
"title" : "ApiIcebergReplicationTestAccessPaths",
"required" : ["distcpOnSource"],
"properties" : {
"proxyName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"proxyNameOnSource" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"distcpOnSource" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"altStagingLocation" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"locationMapping" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiMapEntry"
}
}
},
"example" : {
"proxyName" : "...",
"proxyNameOnSource" : "...",
"distcpOnSource" : true,
"altStagingLocation" : "...",
"locationMapping" : [ {
"key" : "...",
"value" : "..."
}, {
"key" : "...",
"value" : "..."
} ]
},
"description" : ""
}
,
"ApiImpalaCancelResponse" : {
"type" : "object",
"title" : "ApiImpalaCancelResponse",
"properties" : {
"warning" : {
"readOnly" : false,
"description" : "The warning response. If there was no warning this will be null.",
"type" : "string"
}
},
"example" : {
"warning" : "..."
},
"description" : "The response from an Impala cancel query response."
}
,
"ApiImpalaQuery" : {
"type" : "object",
"title" : "ApiImpalaQuery",
"properties" : {
"queryId" : {
"readOnly" : false,
"description" : "The query id.",
"type" : "string"
},
"statement" : {
"readOnly" : false,
"description" : "The SQL statement for the query.",
"type" : "string"
},
"queryType" : {
"readOnly" : false,
"description" : "The query type. The possible values are: DML, DDL, QUERY and UNKNOWN.\nSee the Impala documentation for more details.",
"type" : "string"
},
"queryState" : {
"readOnly" : false,
"description" : "The query state. The possible values are: CREATED, INITIALIZED, COMPILED,\nRUNNING, FINISHED, EXCEPTION, and UNKNOWN.\nSee the Impala documentation for more details.",
"type" : "string"
},
"startTime" : {
"readOnly" : false,
"description" : "The time the query was issued.",
"type" : "string",
"format" : "date-time"
},
"endTime" : {
"readOnly" : false,
"description" : "The time the query finished. If the query hasn't finished then this\nwill return null.",
"type" : "string",
"format" : "date-time"
},
"rowsProduced" : {
"readOnly" : false,
"description" : "The number of rows produced by the query. If the query hasn't completed\nthis will return null.",
"type" : "integer",
"format" : "int64"
},
"attributes" : {
"readOnly" : false,
"description" : "A map of additional query attributes which is generated by Cloudera Manager.",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"user" : {
"readOnly" : false,
"description" : "The user who issued this query.",
"type" : "string"
},
"coordinator" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHostRef"
},
"detailsAvailable" : {
"readOnly" : false,
"description" : "Whether we have a detailed runtime profile available for the query.\nThis profile is available at the endpoint /queries/{QUERY_ID}.",
"type" : "boolean"
},
"database" : {
"readOnly" : false,
"description" : "The database on which this query was issued.",
"type" : "string"
},
"durationMillis" : {
"readOnly" : false,
"description" : "The duration of the query in milliseconds. If the query hasn't completed\nthen this will return null.",
"type" : "integer",
"format" : "int64"
}
},
"example" : {
"queryId" : "...",
"statement" : "...",
"queryType" : "...",
"queryState" : "...",
"startTime" : "...",
"endTime" : "...",
"rowsProduced" : 12345,
"attributes" : {
"property1" : "...",
"property2" : "..."
},
"user" : "...",
"coordinator" : {
"hostId" : "...",
"hostname" : "..."
},
"detailsAvailable" : true,
"database" : "...",
"durationMillis" : 12345
},
"description" : "Represents an Impala Query."
}
,
"ApiImpalaQueryAttribute" : {
"type" : "object",
"title" : "ApiImpalaQueryAttribute",
"properties" : {
"name" : {
"readOnly" : false,
"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" : {
"readOnly" : false,
"description" : "The type of the attribute. Valid types are STRING, NUMBER, BOOLEAN, BYTES,\nMILLISECONDS, BYTES_PER_SECOND, BYTE_SECONDS.",
"type" : "string"
},
"displayName" : {
"readOnly" : false,
"description" : "The display name for the attribute.",
"type" : "string"
},
"supportsHistograms" : {
"readOnly" : false,
"description" : "Whether the Service Monitor can generate a histogram of the distribution\nof the attribute across queries.",
"type" : "boolean"
},
"description" : {
"readOnly" : false,
"description" : "The description of the attribute.",
"type" : "string"
}
},
"example" : {
"name" : "...",
"type" : "...",
"displayName" : "...",
"supportsHistograms" : true,
"description" : "..."
},
"description" : "Metadata about an Impala query attribute."
}
,
"ApiImpalaQueryAttributeList" : {
"type" : "object",
"title" : "ApiImpalaQueryAttributeList",
"allOf" : [
{
"$ref" : "#/components/schemas/ApiListBase"
},
{
"properties" : {
"items" : {
"readOnly" : false,
"description" : "The list of attributes.",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiImpalaQueryAttribute"
}
}
}
}
],
"example" : {
"items" : [ {
"name" : "...",
"type" : "...",
"displayName" : "...",
"supportsHistograms" : true,
"description" : "..."
}, {
"name" : "...",
"type" : "...",
"displayName" : "...",
"supportsHistograms" : true,
"description" : "..."
} ]
},
"description" : "The list of all the attributes that are applicable to Impala queries."
}
,
"ApiImpalaQueryDetailsResponse" : {
"type" : "object",
"title" : "ApiImpalaQueryDetailsResponse",
"properties" : {
"details" : {
"readOnly" : false,
"description" : "The details for this query. Two formats are supported:\n\n
\n
\napiVersion: v1
\nclusters:
\n- cluster:
\n certificate-authority-data: abc123
\n server: https://example-server.domain.com:6443
\n name: example-cluster.domain.com:6443
\ncontexts:
\n- context:
\n cluster: ocp-cluster1
\n user: admin
\n name: admin
\ncurrent-context: admin
\nkind: Config
\npreferences: {}
\nusers:
\n- name: admin
\n user:
\n client-certificate-data: abc123
\n client-key-data: xyz987
\n
\nFor more information on the kubeconfig file, read the documentation\nhere<\/a>.",
"type" : "string"
},
"namespace" : {
"readOnly" : false,
"description" : "A unique namespace where the control plane will be installed",
"type" : "string"
},
"dockerRegistry" : {
"readOnly" : false,
"description" : "The url of the Docker Registry where images required for install are hosted.\nThis fields is deprecated. The docker registry should be provided within the\nvalues.yaml configuration file.",
"type" : "string"
},
"isOverrideAllowed" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
}
},
"example" : {
"kubernetesType" : "...",
"remoteRepoUrl" : "...",
"valuesYaml" : "...",
"kubeConfig" : "...",
"namespace" : "...",
"isOverrideAllowed" : true
},
"description" : "Arguments used to install CDP a Private Cloud Control Plane"
}
,
"ApiInstallEmbeddedControlPlaneArgs" : {
"type" : "object",
"title" : "ApiInstallEmbeddedControlPlaneArgs",
"properties" : {
"remoteRepoUrl" : {
"readOnly" : false,
"description" : "The url of the remote repository where the private cloud artifacts to install are hosted",
"type" : "string"
},
"valuesYaml" : {
"readOnly" : false,
"description" : "A yaml file containing configuration parameters for the installation.",
"type" : "string"
},
"experienceClusterName" : {
"readOnly" : false,
"description" : "Deprecated. Use containerizedClusterName instead.",
"type" : "string"
},
"containerizedClusterName" : {
"readOnly" : false,
"description" : "The name of the Containerized Cluster that will bring up this control plane",
"type" : "string"
},
"datalakeClusterName" : {
"readOnly" : false,
"description" : "The name of the datalake cluster to use for the initial environment in this control plane",
"type" : "string"
},
"selectedFeatures" : {
"readOnly" : false,
"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"
}
},
"example" : {
"remoteRepoUrl" : "...",
"valuesYaml" : "...",
"experienceClusterName" : "...",
"containerizedClusterName" : "...",
"datalakeClusterName" : "...",
"selectedFeatures" : "..."
},
"description" : "Arguments used to install a Private Cloud Control Plane on embedded kubernetes"
}
,
"ApiJceksFile" : {
"type" : "object",
"title" : "ApiJceksFile",
"properties" : {
"content" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"content" : "..."
},
"description" : ""
}
,
"ApiJournalNodeArguments" : {
"type" : "object",
"title" : "ApiJournalNodeArguments",
"properties" : {
"jnName" : {
"readOnly" : false,
"description" : "Name of new JournalNode to be created. (Optional)",
"type" : "string"
},
"jnHostId" : {
"readOnly" : false,
"description" : "ID of the host where the new JournalNode will be created.",
"type" : "string"
},
"jnEditsDir" : {
"readOnly" : false,
"description" : "Path to the JournalNode edits directory. Need not be specified\nif it is already set at RoleConfigGroup level.",
"type" : "string"
}
},
"example" : {
"jnName" : "...",
"jnHostId" : "...",
"jnEditsDir" : "..."
},
"description" : "Arguments used as part of ApiEnableNnHaArguments to\nspecify JournalNodes."
}
,
"ApiKerberosInfo" : {
"type" : "object",
"title" : "ApiKerberosInfo",
"properties" : {
"kerberized" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"kdcType" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"kerberosRealm" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"kdcHost" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"adminHost" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"domain" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"example" : {
"kerberized" : true,
"kdcType" : "...",
"kerberosRealm" : "...",
"kdcHost" : "...",
"adminHost" : "...",
"domain" : [ "...", "..." ]
},
"description" : "Kerberos information of a Cluster or Cloudera Manager."
}
,
"ApiLicense" : {
"type" : "object",
"title" : "ApiLicense",
"properties" : {
"owner" : {
"readOnly" : false,
"description" : "The owner (organization name) of the license.",
"type" : "string"
},
"uuid" : {
"readOnly" : false,
"description" : "A UUID of this license.",
"type" : "string"
},
"expiration" : {
"readOnly" : false,
"description" : "The expiration date.",
"type" : "string",
"format" : "date-time"
},
"features" : {
"readOnly" : false,
"description" : "Returns the list of available features as per the license",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiLicenseFeature"
}
},
"deactivationDate" : {
"readOnly" : false,
"description" : "The deactivation date.",
"type" : "string",
"format" : "date-time"
},
"startDate" : {
"readOnly" : false,
"description" : "The start date.",
"type" : "string",
"format" : "date-time"
}
},
"example" : {
"owner" : "...",
"uuid" : "...",
"expiration" : "...",
"features" : [ {
"name" : "...",
"enabled" : true,
"description" : "..."
}, {
"name" : "...",
"enabled" : true,
"description" : "..."
} ],
"deactivationDate" : "...",
"startDate" : "..."
},
"description" : "Information about the Cloudera Manager license."
}
,
"ApiLicenseFeature" : {
"type" : "object",
"title" : "ApiLicenseFeature",
"properties" : {
"name" : {
"readOnly" : false,
"description" : "Returns feature name",
"type" : "string"
},
"enabled" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"description" : {
"readOnly" : false,
"description" : "Returns I18n description of the feature.",
"type" : "string"
}
},
"example" : {
"name" : "...",
"enabled" : true,
"description" : "..."
},
"description" : "Information about the Cloudera Manager license feature details."
}
,
"ApiLicensedFeatureUsage" : {
"type" : "object",
"title" : "ApiLicensedFeatureUsage",
"properties" : {
"totals" : {
"readOnly" : false,
"description" : "Map from named features to the total number of nodes using those features.",
"type" : "object",
"additionalProperties" : {
"type" : "integer"
}
},
"clusters" : {
"readOnly" : false,
"description" : "Map from clusters to maps of named features to the number of nodes in the\ncluster using those features.",
"type" : "object",
"additionalProperties" : {
"type" : "object"
}
}
},
"example" : {
"totals" : {
"property1" : 12345,
"property2" : 12345
},
"clusters" : {
"property1" : { },
"property2" : { }
}
},
"description" : "Information about the number of nodes using which product features.\n\n
\n
\n
\n
\n
\nExample: [\"cm_hdfs\", \"cm_hive\"]",
"type" : "array",
"items" : {
"type" : "string"
}
}
},
"example" : {
"rangerServiceNames" : [ "...", "..." ]
},
"description" : "Arguments for EXPORTING Ranger services and policies, to be replicated later."
}
,
"ApiRangerReplicationHdfsToAdlsArgs" : {
"type" : "object",
"title" : "ApiRangerReplicationHdfsToAdlsArgs",
"properties" : {
"adlsStorageAccount" : {
"readOnly" : false,
"description" : "ADLS storage account name for Ranger HDFS policies which need to be transformed to ADLS policy.",
"type" : "string"
},
"adlsStorageAccountContainer" : {
"readOnly" : false,
"description" : "ADLS storage account container name for Ranger HDFS policies\nwhich need to be transformed to ADLS policy.",
"type" : "string"
}
},
"example" : {
"adlsStorageAccount" : "...",
"adlsStorageAccountContainer" : "..."
},
"description" : "Arguments for transforming HDFS Ranger service policies to Azure Data Lake Storage (ADLS) policies.\n
\nDefault value: null",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"example" : {
"importStrategy" : "MERGE",
"extraAuthSiteProperties" : {
"property1" : "...",
"property2" : "..."
}
},
"description" : "Arguments for IMPORTING Ranger services and policies,\nexecuted after EXPORT (see ApiRangerReplicationExportArgs) and\nTRANSFORM (see ApiRangerReplicationTransformArgs)."
}
,
"ApiRangerReplicationResult" : {
"type" : "object",
"title" : "ApiRangerReplicationResult",
"properties" : {
"total" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int32"
},
"created" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int32"
},
"skipped" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int32"
},
"failed" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int32"
},
"skippedDueToTimeout" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int32"
},
"auditLogReplicationResult" : {
"readOnly" : false,
"$ref" : "#/components/schemas/ApiHdfsReplicationResult"
}
},
"example" : {
"total" : 12345,
"created" : 12345,
"skipped" : 12345,
"failed" : 12345,
"skippedDueToTimeout" : 12345,
"auditLogReplicationResult" : {
"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 a RANGER replication job."
}
,
"ApiRangerReplicationTransformArgs" : {
"type" : "object",
"title" : "ApiRangerReplicationTransformArgs",
"properties" : {
"rangerServiceNamesMapping" : {
"readOnly" : false,
"description" : "A mapping between source to destination ranger services.\n
\nDefault: empty or null, every service name will stay the same on the destination",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"rangerUsersMapping" : {
"readOnly" : false,
"description" : "A mapping between source to destination ranger usernames.\n
\nDefault: empty or null, every username will stay the same on the destination",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"rangerResourcesMapping" : {
"readOnly" : false,
"description" : "A mapping between source to destination ranger resources.\n
\n{\"/srcdir1/srcfile1\": \"/destdir1/destfile1\", \"src_url.com\": \"dest_url.com\",\n\"source_db\": \"dest_db\", \"source_table\":\"dest_table\"} }
\nDefault: empty or null, every resource will remain the same on destination\n\n
\n\"hdfs://namenodehost:8020/user/hive/warehouse\": \"s3a://bucket\"
\nthen after transformation hive urls will be:\n\n
HDFS services and health checks<\/h3>\n\nIn CDH4, HDFS services may not present any health checks. This will happen\nif the service has more than one nameservice configured. In those cases,\nthe health information will be available by fetching information about the\nnameservices instead.\n
null<\/code> values are not allowed; use #sourceUnsetConfigs\nto remove configuration properties.\n\nThe configuration of the source file system is built this way:\n\n
sourceAdditionalConfigs<\/code> to each<\/b>\nxml files present in the client configuration, possibly overriding properties\nthat have been already present.<\/li>\nsourceUnsetConfigs<\/code> from\neach<\/b> xml files present in the client configuration.<\/li>\n<\/ol>",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"sourceUnsetConfigs" : {
"readOnly" : false,
"description" : "A set of configuration properties to be unset for the source file system.\n\nThe properties listed here will be removed from the source file system configuration.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"destinationProxyUser" : {
"readOnly" : false,
"description" : "User on the executor cluster accessing the destination file.",
"type" : "string"
},
"destinationPath" : {
"readOnly" : false,
"description" : "Path of the destination file to be created.",
"type" : "string"
},
"additionalConfigs" : {
"readOnly" : false,
"description" : "A map of additional configuration options.\nThese will override the values gathered automatically by getting the\nclient configuration of the destination service.\n\nnull<\/code> values are not allowed; use #unsetConfigs\nto remove configuration properties.\n\nThis configuration will be used for everything apart from the source file system<\/b>;\nit is used e.g. for the destination file system and for the underlying implementation\nof the FS copy (org.apache.hadoop.fs.FileUtil#copy).\n\nThe configuration is built this way:\n\n
additionalConfigs<\/code> to each<\/b>\nxml files present in the client configuration, possibly overriding properties\nthat have been already present.<\/li>\nunsetConfigs<\/code> from\neach<\/b> xml files present in the client configuration.<\/li>\n<\/ol>",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"unsetConfigs" : {
"readOnly" : false,
"description" : "A set of configuration properties to be unset.\n\nThe properties listed here will be removed from the configuration.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"additionalEnvironmentVariables" : {
"readOnly" : false,
"description" : "A map of additional environment variables to be used in the one-off process\n\nThis is the place to add environment variables related to e.g. kinit<\/code>\nthat acquires the TGT on the execution-side (usually the destination)\nor JVM options.\n\nnull<\/code> values are not allowed; this interface must be changed should that be necessary.",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"example" : {
"sourceService" : {
"peerName" : "...",
"clusterName" : "...",
"clusterDisplayName" : "...",
"serviceName" : "...",
"serviceDisplayName" : "...",
"serviceType" : "..."
},
"sourceProxyUser" : "...",
"sourcePath" : "...",
"sourceAdditionalConfigs" : {
"property1" : "...",
"property2" : "..."
},
"sourceUnsetConfigs" : [ "...", "..." ],
"destinationProxyUser" : "...",
"destinationPath" : "...",
"additionalConfigs" : {
"property1" : "...",
"property2" : "..."
},
"unsetConfigs" : [ "...", "..." ],
"additionalEnvironmentVariables" : {
"property1" : "...",
"property2" : "..."
}
},
"description" : "Represents the arguments required for transferring a file."
}
,
"ApiTransformCopylistingReq" : {
"type" : "object",
"title" : "ApiTransformCopylistingReq",
"properties" : {
"pathMappings" : {
"readOnly" : false,
"description" : "Mapping rules from source to target paths.\n/source/path<\/code> to /target/path<\/code>.\nnull<\/code> values are not allowed.\n<\/p>",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"statusType" : {
"readOnly" : false,
"description" : "The type of the status objects in the input sequence file.\nhdfs://namenode:8020/source/seqfile<\/code> or ofs://ozone-service/vol/bkt/file<\/code>.\n<\/p>",
"type" : "string"
},
"fromRenameDeleteSequenceFile" : {
"readOnly" : false,
"description" : "Absolute path (including protocol and HDFS namenode address/Ozone service ID) to the source rename/delete sequence file.\nnull<\/code> values are not allowed.",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"unsetConfigs" : {
"readOnly" : false,
"description" : "A set of configuration options to be unset.\nnull<\/code> values are not allowed.",
"type" : "array",
"items" : {
"type" : "string"
}
},
"additionalEnvironmentVariables" : {
"readOnly" : false,
"description" : "A map of additional environment variables to be used in the one-off process\n\nThis is the place to add environment variables related to e.g. kinit<\/code>\nthat acquires the TGT on the execution-side (usually the destination)\nor JVM options.\n\nnull<\/code> values are not allowed; this interface must be changed should that be necessary.",
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"example" : {
"pathMappings" : {
"property1" : "...",
"property2" : "..."
},
"statusType" : "...",
"fromSequenceFile" : "...",
"fromRenameDeleteSequenceFile" : "...",
"toSequenceFile" : "...",
"toRenameDeleteSequenceFile" : "...",
"additionalConfigs" : {
"property1" : "...",
"property2" : "..."
},
"unsetConfigs" : [ "...", "..." ],
"additionalEnvironmentVariables" : {
"property1" : "...",
"property2" : "..."
}
},
"description" : "Represents the arguments required for transforming copylisting files.\n\n\n
/source/path<\/code> to /target/path<\/code>.<\/li>\nnull<\/code> values are not allowed.\nhdfs://namenode:8020/source/seqfile<\/code> or ofs://ozone-service/vol/bkt/file<\/code>.<\/li>\nnull<\/code> values are not allowed.<\/li>\nnull<\/code> values are not allowed.<\/li>\nnull<\/code> values are not allowed.<\/li>\n<\/ul>"
}
,
"ApiUninstallControlPlaneArgs" : {
"type" : "object",
"title" : "ApiUninstallControlPlaneArgs",
"properties" : {
"kubeConfig" : {
"readOnly" : false,
"description" : "The content of the kubeconfig file of the kubernetes environment on which the control plane is running\nSimplified example:
\n
\napiVersion: v1
\nclusters:
\n- cluster:
\n certificate-authority-data: abc123
\n server: https://example-server.domain.com:6443
\n name: example-cluster.domain.com:6443
\ncontexts:
\n- context:
\n cluster: ocp-cluster1
\n user: admin
\n name: admin
\ncurrent-context: admin
\nkind: Config
\npreferences: {}
\nusers:
\n- name: admin
\n user:
\n client-certificate-data: abc123
\n client-key-data: xyz987
\n
\nFor more information on the kubeconfig file, read the documentation\nhere<\/a>.",
"type" : "string"
},
"valuesYaml" : {
"readOnly" : false,
"description" : "Currently, we only support the following content in the values.yaml:\nother:\nforceCleanup: true|false",
"type" : "string"
}
},
"example" : {
"kubeConfig" : "...",
"valuesYaml" : "..."
},
"description" : "Arguments used to uninstall CDP a Private Cloud Control Plane"
}
,
"ApiUpdateControlPlaneValuesYamlArgs" : {
"type" : "object",
"title" : "ApiUpdateControlPlaneValuesYamlArgs",
"properties" : {
"kubeConfig" : {
"readOnly" : false,
"description" : "The content of the kubeconfig file of the kubernetes environment on which the control plane is running\nSimplified example:
\n
\napiVersion: v1
\nclusters:
\n- cluster:
\n certificate-authority-data: abc123
\n server: https://example-server.domain.com:6443
\n name: example-cluster.domain.com:6443
\ncontexts:
\n- context:
\n cluster: ocp-cluster1
\n user: admin
\n name: admin
\ncurrent-context: admin
\nkind: Config
\npreferences: {}
\nusers:
\n- name: admin
\n user:
\n client-certificate-data: abc123
\n client-key-data: xyz987
\n
\nFor more information on the kubeconfig file, read the documentation\nhere<\/a>.",
"type" : "string"
},
"remoteRepoUrl" : {
"readOnly" : false,
"description" : "The url of the remote repository where the private cloud artifacts are hosted.",
"type" : "string"
}
},
"example" : {
"kubeConfig" : "...",
"remoteRepoUrl" : "..."
},
"description" : "Arguments used to get an existing CDP Private Cloud Control Plane's info"
}
,
"ApiUpdateCspTypeArguments" : {
"type" : "object",
"title" : "ApiUpdateCspTypeArguments",
"properties" : {
"cspType" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"cspStoragePath" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"cspSecretPath" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"cspAddress" : {
"readOnly" : false,
"description" : "",
"type" : "string"
}
},
"example" : {
"cspType" : "...",
"cspStoragePath" : "...",
"cspSecretPath" : "...",
"cspAddress" : "..."
},
"description" : ""
}
,
"ApiUpdateGlobalTruststoreArguments" : {
"type" : "object",
"title" : "ApiUpdateGlobalTruststoreArguments",
"properties" : {
"newCertLocation" : {
"readOnly" : false,
"description" : "The location of the new certificate on the disk to be added to the Auto-TLS truststore.\nPEM format is required.\nSpecify either this or a NewCertContent.",
"type" : "string"
},
"newCertContent" : {
"readOnly" : false,
"description" : "The content of the new certificate to be added to the Auto-TLS truststore.\nSpecify either this or a NewCertLocation.\n
\nThe certificate, 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 CERTIFICATE-----\\n[base-64 encoded key]\\n-----END CERTIFICATE-----\n
",
"type" : "string"
}
},
"example" : {
"newCertLocation" : "...",
"newCertContent" : "..."
},
"description" : "Arguments to update certificates from the Auto-TLS truststore"
}
,
"ApiUpgradeControlPlaneArgs" : {
"type" : "object",
"title" : "ApiUpgradeControlPlaneArgs",
"properties" : {
"kubeConfig" : {
"readOnly" : false,
"description" : "The content of the kubeconfig file of the kubernetes environment on which the control plane is running\nSimplified example:
\n
\napiVersion: v1
\nclusters:
\n- cluster:
\n certificate-authority-data: abc123
\n server: https://example-server.domain.com:6443
\n name: example-cluster.domain.com:6443
\ncontexts:
\n- context:
\n cluster: ocp-cluster1
\n user: admin
\n name: admin
\ncurrent-context: admin
\nkind: Config
\npreferences: {}
\nusers:
\n- name: admin
\n user:
\n client-certificate-data: abc123
\n client-key-data: xyz987
\n
\nFor more information on the kubeconfig file, read the documentation\nhere<\/a>.",
"type" : "string"
},
"valuesYaml" : {
"readOnly" : false,
"description" : "To see sample values.yaml files, read the documentation\nhere<\/a>.",
"type" : "string"
},
"remoteRepoUrl" : {
"readOnly" : false,
"description" : "The url of the remote repository where the private cloud artifacts for the target version of the upgrade are hosted",
"type" : "string"
}
},
"example" : {
"kubeConfig" : "...",
"valuesYaml" : "...",
"remoteRepoUrl" : "..."
},
"description" : "Arguments used to upgrade a CDP Private Cloud Control Plane"
}
,
"ApiUpgradeEmbeddedControlPlaneArgs" : {
"type" : "object",
"title" : "ApiUpgradeEmbeddedControlPlaneArgs",
"properties" : {
"remoteRepoUrl" : {
"readOnly" : false,
"description" : "The url of the remote repository where the private cloud artifacts to upgrade to are hosted",
"type" : "string"
},
"valuesYaml" : {
"readOnly" : false,
"description" : "A yaml file containing configuration parameters for the upgrade.",
"type" : "string"
},
"experienceClusterName" : {
"readOnly" : false,
"description" : "Deprecated. Use containerizedClusterName instead.",
"type" : "string"
},
"containerizedClusterName" : {
"readOnly" : false,
"description" : "The name of the existing Containerized Cluster to upgrade.",
"type" : "string"
}
},
"example" : {
"remoteRepoUrl" : "...",
"valuesYaml" : "...",
"experienceClusterName" : "...",
"containerizedClusterName" : "..."
},
"description" : "Arguments used to upgrade a Private Cloud Control Plane on embedded kubernetes\nand the associated Containerized Cluster."
}
,
"ApiUser" : {
"type" : "object",
"title" : "ApiUser",
"properties" : {
"name" : {
"readOnly" : false,
"description" : "The username, which is unique within a Cloudera Manager installation.",
"type" : "string"
},
"password" : {
"readOnly" : false,
"description" : "Returns the user password.\n\n
\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" : {
"readOnly" : false,
"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."
}
,
"CopyListingSummary" : {
"type" : "object",
"title" : "CopyListingSummary",
"required" : ["totalRecords", "totalFiles", "totalBytes"],
"properties" : {
"totalRecords" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int64"
},
"totalFiles" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int64"
},
"totalBytes" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int64"
}
},
"example" : {
"totalRecords" : 12345,
"totalFiles" : 12345,
"totalBytes" : 12345
},
"description" : "Reflect parts of CopyListingSummary of DistCp.\n\nDistCp passes these values into its job configuration in DistCpOptions"
}
,
"DeleteHdfsPathResult" : {
"type" : "string",
"title" : "DeleteHdfsPathResult",
"enum" : [
"DELETED",
"NOT_DELETED",
"NOT_EXISTS"
],
"description" : ""
}
,
"HBaseDatabaseArgs" : {
"type" : "object",
"title" : "HBaseDatabaseArgs",
"required" : ["initialSnapshot"],
"properties" : {
"failedSnapshotTables" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"type" : "string"
}
},
"initialSnapshot" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"replicationStrategy" : {
"readOnly" : false,
"$ref" : "#/components/schemas/HBaseWholeDbReplicationStrategy"
}
},
"example" : {
"failedSnapshotTables" : [ "...", "..." ],
"initialSnapshot" : true,
"replicationStrategy" : "TABLES_WITH_REPLICATION_SCOPE_SET"
},
"description" : "Holds information for an HBase all database replication."
}
,
"HBasePeerState" : {
"type" : "string",
"title" : "HBasePeerState",
"enum" : [
"ENABLED",
"DISABLED"
],
"description" : ""
}
,
"HBaseTableArgs" : {
"type" : "object",
"title" : "HBaseTableArgs",
"required" : ["initialSnapshot", "snapshotSucceeded"],
"properties" : {
"tableName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"initialSnapshot" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
},
"snapshotSucceeded" : {
"readOnly" : false,
"description" : "",
"type" : "boolean"
}
},
"example" : {
"tableName" : "...",
"initialSnapshot" : true,
"snapshotSucceeded" : true
},
"description" : "Holds information for an HBase table."
}
,
"HBaseWholeDbReplicationStrategy" : {
"type" : "string",
"title" : "HBaseWholeDbReplicationStrategy",
"enum" : [
"ALL_TABLES",
"TABLES_WITH_REPLICATION_SCOPE_SET"
],
"description" : "HBase whole DB replication strategies"
}
,
"HTTPMethod" : {
"type" : "string",
"title" : "HTTPMethod",
"enum" : [
"GET",
"POST",
"PUT",
"DELETE"
],
"description" : ""
}
,
"HaStatus" : {
"type" : "string",
"title" : "HaStatus",
"enum" : [
"ACTIVE",
"STANDBY",
"UNKNOWN"
],
"description" : ""
}
,
"IcebergReplicationSafetyValve" : {
"type" : "object",
"title" : "IcebergReplicationSafetyValve",
"properties" : {
"configs" : {
"readOnly" : false,
"description" : "",
"type" : "array",
"items" : {
"$ref" : "#/components/schemas/ApiMapEntry"
}
}
},
"example" : {
"configs" : [ {
"key" : "...",
"value" : "..."
}, {
"key" : "...",
"value" : "..."
} ]
},
"description" : ""
}
,
"IcebergReplicationYarnOptions" : {
"type" : "object",
"title" : "IcebergReplicationYarnOptions",
"properties" : {
"schedulerPoolName" : {
"readOnly" : false,
"description" : "",
"type" : "string"
},
"numberOfMappers" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int32"
},
"bandwidthPerMap" : {
"readOnly" : false,
"description" : "",
"type" : "integer",
"format" : "int32"
}
},
"example" : {
"schedulerPoolName" : "...",
"numberOfMappers" : 12345,
"bandwidthPerMap" : 12345
},
"description" : ""
}
,
"Origin" : {
"type" : "string",
"title" : "Origin",
"enum" : [
"SOURCE",
"TARGET"
],
"description" : ""
}
,
"OverwriteMode" : {
"type" : "string",
"title" : "OverwriteMode",
"enum" : [
"ALWAYS",
"NEVER"
],
"description" : "Specifies whether to preserve metadata indicating the last time that a file was written to\nbefore the PREPARING<\/code> phase of the DataSync task execution."
}
,
"OzoneReplicationCommandType" : {
"type" : "string",
"title" : "OzoneReplicationCommandType",
"enum" : [
"FULL_FILE_LISTING",
"INCREMENTAL",
"FULL_FILE_LISTING_FALLBACK"
],
"description" : ""
}
,
"OzoneReplicationType" : {
"type" : "string",
"title" : "OzoneReplicationType",
"enum" : [
"FULL_FILE_LISTING",
"INCREMENTAL_WITH_FALLBACK_TO_FULL_FILE_LISTING",
"INCREMENTAL_ONLY"
],
"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" : ""
}
,
"RangerReplicationImportStrategy" : {
"type" : "string",
"title" : "RangerReplicationImportStrategy",
"enum" : [
"MERGE",
"OVERRIDE"
],
"description" : "The strategy to be used for Ranger replication import step."
}
,
"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",
"PRE_OPTIMIZED_BOOTSTRAP",
"OPTIMIZED_BOOTSTRAP"
],
"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."
}
,
"SourceStorageFilter" : {
"type" : "string",
"title" : "SourceStorageFilter",
"enum" : [
"OZONE",
"S3",
"HDFS"
],
"description" : ""
}
,
"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" : ""
}
,
"SubStatus" : {
"type" : "string",
"title" : "SubStatus",
"enum" : [
"CONFIGURING",
"RESTARTING"
],
"description" : ""
}
,
"TransferMode" : {
"type" : "string",
"title" : "TransferMode",
"enum" : [
"CHANGED",
"ALL"
],
"description" : "Determines whether DataSync transfers only the data and metadata that differ\nbetween the source and the destination location or\ntransfers all the content from the source (without comparing what's in the destination)."
}
,
"ValidationState" : {
"type" : "string",
"title" : "ValidationState",
"enum" : [
"OK",
"WARNING",
"ERROR"
],
"description" : ""
}
,
"VerifyMode" : {
"type" : "string",
"title" : "VerifyMode",
"enum" : [
"ONLY_FILES_TRANSFERRED",
"POINT_IN_TIME_CONSISTENT",
"NONE"
],
"description" : "Specifies how and when DataSync checks the integrity of the data during a transfer."
}
,
"ZooKeeperServerMode" : {
"type" : "string",
"title" : "ZooKeeperServerMode",
"enum" : [
"STANDALONE",
"REPLICATED_FOLLOWER",
"REPLICATED_LEADER",
"REPLICATED_LEADER_ELECTION",
"REPLICATED_OBSERVER",
"UNKNOWN"
],
"description" : "The state of the Zookeeper server."
}
},
"securitySchemes": {
"basic": {
"type": "http",
"scheme": "basic"
}
}
},
"security": [
{ "basic": [] }
],
"paths": {
"\/audits" : {
"get" : {
"tags" : [ "AuditsResource" ],
"description" : "Fetch audit events from Cloudera Manager (CM) and CM managed services\nlike HDFS, HBase, Impala, Hive, and Sentry.\n\n
\n
\n Selector <\/th>\n Description <\/th>\n SCM <\/th>\n HDFS <\/th>\n HBase <\/th>\n Hive <\/th>\n Impala <\/th>\n Sentry <\/th>\n<\/tr>\n \n service <\/td>\n Cloudera Manager Service <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n<\/tr>\n \n operation <\/td>\n Operation name <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n<\/tr>\n \n username <\/td>\n User name <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n<\/tr>\n \n impersonator<\/td>\n Impersonator <\/td>\n <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n<\/tr>\n \n ip_address <\/td>\n IP Address <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n<\/tr>\n \n allowed <\/td>\n Whether the request was allowed or denied <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n<\/tr>\n \n qualifier<\/td>\n Column qualifier <\/td>\n <\/td>\n <\/td>\n x <\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n \n source <\/td>\n Source resource of the operation <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n <\/td>\n<\/tr>\n \n destination <\/td>\n Destination resource of the operation <\/td>\n <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n <\/td>\n<\/tr>\n \n hostIpAddress <\/td>\n Host IP Address <\/td>\n x <\/td>\n <\/td>\n <\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n \n role <\/td>\n Cloudera Manager Role <\/td>\n x <\/td>\n <\/td>\n <\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n \n family <\/td>\n Column family <\/td>\n <\/td>\n <\/td>\n x <\/td>\n <\/td>\n <\/td>\n <\/td>\n<\/tr>\n \n database_name <\/td>\n Database name <\/td>\n <\/td>\n <\/td>\n <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n<\/tr>\n \n table_name <\/td>\n Table name <\/td>\n <\/td>\n <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n<\/tr>\n \n object_type <\/td>\n Type of object being handled <\/td>\n <\/td>\n <\/td>\n <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n<\/tr>\n \n operation_text <\/td>\n Command/query text <\/td>\n <\/td>\n <\/td>\n <\/td>\n x <\/td>\n x <\/td>\n x <\/td>\n<\/tr>\n<\/table>\n \n
\n
\n
\n
\n
\n\n
\n \nCluster Version<\/th>\n Available Service Types<\/th>\n<\/tr>\n<\/thead>\n \n CDH4<\/td>\n HDFS, MAPREDUCE, HBASE, OOZIE, ZOOKEEPER, HUE, YARN, IMPALA, FLUME, HIVE, SOLR, SQOOP, KS_INDEXER<\/td>\n<\/tr>\n \n CDH5<\/td>\n HDFS, MAPREDUCE, HBASE, OOZIE, ZOOKEEPER, HUE, YARN, IMPALA,\nFLUME, HIVE, SOLR, SQOOP, KS_INDEXER, SQOOP_CLIENT, SENTRY,\nACCUMULO16, KMS, SPARK_ON_YARN, KAFKA\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\nAs of V6, GET /{clusterName}/serviceTypes should be used to get\nthe service types available to the cluster.",
"operationId" : "createServices",
"requestBody" : {
"description" : "Details of the services to create.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"HISTORY_NOT_AVAILABLE\",\n \"healthSummary\" : \"GOOD\",\n \"configStalenessStatus\" : \"STALE\",\n \"clientConfigStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"HISTORY_NOT_AVAILABLE\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"CONCERNING\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"HOST\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ { }, { } ],\n \"items\" : [ { }, { } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"UNKNOWN\",\n \"commissionState\" : \"COMMISSIONED\",\n \"healthSummary\" : \"CONCERNING\",\n \"configStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"STANDBY\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"CLUSTER\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"REPLICATED_LEADER_ELECTION\",\n \"entityStatus\" : \"GOOD_HEALTH\",\n \"tags\" : [ { }, { } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"HISTORY_NOT_AVAILABLE\",\n \"commissionState\" : \"OFFLINING\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"STALE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"STANDBY\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"SERVICE\", \"ROLE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"STANDALONE\",\n \"entityStatus\" : \"STOPPED\",\n \"tags\" : [ { }, { } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"WEEK\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"YEAR\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"STARTING\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"STOPPED\",\n \"healthSummary\" : \"DISABLED\",\n \"configStalenessStatus\" : \"FRESH\",\n \"clientConfigStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"DISABLED\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"BAD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"SERVICE\", \"ROLE\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ { }, { } ],\n \"items\" : [ { }, { } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STARTING\",\n \"commissionState\" : \"OFFLINING\",\n \"healthSummary\" : \"GOOD\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"STANDBY\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"HOST\", \"ROLE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"REPLICATED_OBSERVER\",\n \"entityStatus\" : \"UNKNOWN\",\n \"tags\" : [ { }, { } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STOPPING\",\n \"commissionState\" : \"DECOMMISSIONED\",\n \"healthSummary\" : \"BAD\",\n \"configStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"STANDBY\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"SERVICE\", \"ROLE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"REPLICATED_FOLLOWER\",\n \"entityStatus\" : \"STOPPING\",\n \"tags\" : [ { }, { } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"HOUR\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"YEAR\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"HISTORY_NOT_AVAILABLE\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiServiceList"
}
}
}
},
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"STOPPED\",\n \"healthSummary\" : \"BAD\",\n \"configStalenessStatus\" : \"STALE\",\n \"clientConfigStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"GOOD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"DISABLED\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"SERVICE\", \"CONTROL_PLANE\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ { }, { } ],\n \"items\" : [ { }, { } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STARTED\",\n \"commissionState\" : \"DECOMMISSIONING\",\n \"healthSummary\" : \"DISABLED\",\n \"configStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"ACTIVE\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"ROLE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"UNKNOWN\",\n \"entityStatus\" : \"STOPPED\",\n \"tags\" : [ { }, { } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STOPPING\",\n \"commissionState\" : \"OFFLINING\",\n \"healthSummary\" : \"GOOD\",\n \"configStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"ACTIVE\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"CLUSTER\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"REPLICATED_LEADER_ELECTION\",\n \"entityStatus\" : \"DISABLED_HEALTH\",\n \"tags\" : [ { }, { } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"YEAR\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"YEAR\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"UNKNOWN\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"UNKNOWN\",\n \"healthSummary\" : \"GOOD\",\n \"configStalenessStatus\" : \"FRESH\",\n \"clientConfigStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"GOOD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"GOOD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"ROLE\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ { }, { } ],\n \"items\" : [ { }, { } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STARTING\",\n \"commissionState\" : \"UNKNOWN\",\n \"healthSummary\" : \"CONCERNING\",\n \"configStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"UNKNOWN\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"HOST\", \"SERVICE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"UNKNOWN\",\n \"entityStatus\" : \"STARTING\",\n \"tags\" : [ { }, { } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : { },\n \"serviceRef\" : { },\n \"roleState\" : \"STARTED\",\n \"commissionState\" : \"COMMISSIONED\",\n \"healthSummary\" : \"BAD\",\n \"configStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ { }, { } ],\n \"haStatus\" : \"ACTIVE\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CONTROL_PLANE\", \"SERVICE\" ],\n \"config\" : { },\n \"roleConfigGroupRef\" : { },\n \"zooKeeperServerMode\" : \"STANDALONE\",\n \"entityStatus\" : \"STARTING\",\n \"tags\" : [ { }, { } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : { },\n \"displayName\" : \"...\",\n \"serviceRef\" : { }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"WEEK\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : { },\n \"hiveArguments\" : { },\n \"hdfsCloudArguments\" : { },\n \"ozoneReplicationArguments\" : { },\n \"history\" : [ { }, { } ],\n \"active\" : true,\n \"hiveCloudArguments\" : { },\n \"hbaseArguments\" : { },\n \"hive3Arguments\" : { },\n \"rangerArguments\" : { },\n \"icebergArguments\" : { },\n \"atlasReplicationArguments\" : { },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"MONTH\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : { },\n \"hdfsArguments\" : { },\n \"ozoneArguments\" : { },\n \"lastCommand\" : { },\n \"lastSuccessfulCommand\" : { },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"NONE\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiServiceList"
}
}
},
"description" : "List of created services."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}" : {
"delete" : {
"tags" : [ "ServicesResource" ],
"description" : "Deletes a service from the system.",
"operationId" : "deleteService",
"responses" : {
"204" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"STOPPED\",\n \"healthSummary\" : \"CONCERNING\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"clientConfigStalenessStatus\" : \"STALE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"DISABLED\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"GOOD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"SERVICE\", \"ROLE\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ {\n \"roleType\" : \"...\",\n \"items\" : [ { }, { } ]\n }, {\n \"roleType\" : \"...\",\n \"items\" : [ { }, { } ]\n } ],\n \"items\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\",\n \"required\" : true,\n \"default\" : \"...\",\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"relatedName\" : \"...\",\n \"sensitive\" : true,\n \"validationState\" : \"ERROR\",\n \"validationMessage\" : \"...\",\n \"validationWarningsSuppressed\" : true\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\",\n \"required\" : true,\n \"default\" : \"...\",\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"relatedName\" : \"...\",\n \"sensitive\" : true,\n \"validationState\" : \"WARNING\",\n \"validationMessage\" : \"...\",\n \"validationWarningsSuppressed\" : true\n } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleState\" : \"NA\",\n \"commissionState\" : \"COMMISSIONED\",\n \"healthSummary\" : \"DISABLED\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"GOOD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"HISTORY_NOT_AVAILABLE\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"haStatus\" : \"UNKNOWN\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"HOST\" ],\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"roleConfigGroupRef\" : {\n \"roleConfigGroupName\" : \"...\"\n },\n \"zooKeeperServerMode\" : \"REPLICATED_FOLLOWER\",\n \"entityStatus\" : \"HISTORY_NOT_AVAILABLE\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleState\" : \"UNKNOWN\",\n \"commissionState\" : \"DECOMMISSIONING\",\n \"healthSummary\" : \"DISABLED\",\n \"configStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"BAD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"HISTORY_NOT_AVAILABLE\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"haStatus\" : \"STANDBY\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"CLUSTER\" ],\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"roleConfigGroupRef\" : {\n \"roleConfigGroupName\" : \"...\"\n },\n \"zooKeeperServerMode\" : \"STANDALONE\",\n \"entityStatus\" : \"UNKNOWN_HEALTH\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"displayName\" : \"...\",\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"displayName\" : \"...\",\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : {\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"DYNAMIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"hiveArguments\" : {\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceService\" : { },\n \"tableFilters\" : [ { }, { } ],\n \"exportDir\" : \"...\",\n \"force\" : true,\n \"replicateData\" : true,\n \"hdfsArguments\" : { },\n \"replicateImpalaMetadata\" : true,\n \"runInvalidateMetadata\" : true,\n \"dryRun\" : true,\n \"numThreads\" : 12345,\n \"sentryMigration\" : true,\n \"skipUrlPermissions\" : true,\n \"atlasReplicationNeeded\" : true,\n \"atlasChangeMarker\" : \"...\",\n \"sentryExportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"rangerImportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"hdfsCloudArguments\" : {\n \"sourceAccount\" : \"...\",\n \"destinationAccount\" : \"...\",\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"STATIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"ozoneReplicationArguments\" : {\n \"originalSourcePath\" : \"...\",\n \"originalDestinationPath\" : \"...\",\n \"replicationType\" : \"INCREMENTAL_WITH_FALLBACK_TO_FULL_FILE_LISTING\",\n \"inclusionFilters\" : [ \"...\", \"...\" ],\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"DYNAMIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"history\" : [ {\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"hiveResult\" : { },\n \"hiveOnTezResult\" : { },\n \"hbaseInfo\" : { },\n \"rangerResult\" : { },\n \"icebergResult\" : { },\n \"apiReplicationCommandsWithSameIntent\" : [ { }, { } ],\n \"apiAtlasReplicationResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"hiveResult\" : { },\n \"hiveOnTezResult\" : { },\n \"hbaseInfo\" : { },\n \"rangerResult\" : { },\n \"icebergResult\" : { },\n \"apiReplicationCommandsWithSameIntent\" : [ { }, { } ],\n \"apiAtlasReplicationResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ],\n \"active\" : true,\n \"hiveCloudArguments\" : {\n \"sourceAccount\" : \"...\",\n \"destinationAccount\" : \"...\",\n \"cloudRootPath\" : \"...\",\n \"replicationOption\" : \"METADATA_AND_DATA\",\n \"exportFilesPrefix\" : \"...\",\n \"awsDataSyncTaskArgs\" : { },\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceService\" : { },\n \"tableFilters\" : [ { }, { } ],\n \"exportDir\" : \"...\",\n \"force\" : true,\n \"replicateData\" : true,\n \"hdfsArguments\" : { },\n \"replicateImpalaMetadata\" : true,\n \"runInvalidateMetadata\" : true,\n \"dryRun\" : true,\n \"numThreads\" : 12345,\n \"sentryMigration\" : true,\n \"skipUrlPermissions\" : true,\n \"atlasReplicationNeeded\" : true,\n \"atlasChangeMarker\" : \"...\",\n \"sentryExportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"rangerImportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"hbaseArguments\" : {\n \"sourceHBaseService\" : { },\n \"peerState\" : \"ENABLED\",\n \"hbasePeerId\" : \"...\",\n \"hbaseClusterKey\" : \"...\",\n \"endPointClassName\" : \"...\",\n \"tables\" : [ { }, { } ],\n \"database\" : { },\n \"replicationProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceAccount\" : \"...\",\n \"sourceSchedulerPool\" : \"...\",\n \"numMappers\" : 12345,\n \"bandwidthPerMap\" : 12345,\n \"exportSnapshotUser\" : \"...\",\n \"snapshotScratchLocation\" : \"...\",\n \"validateReplicationSetup\" : true,\n \"maxParallelSnapshots\" : 12345\n },\n \"hive3Arguments\" : {\n \"sourceHiveService\" : { },\n \"status\" : \"FAILED_ADMIN\",\n \"rangerReplication\" : true,\n \"atlasReplication\" : true,\n \"externalTableReplication\" : true,\n \"externalTableBaseDir\" : \"...\",\n \"distcpOnTarget\" : true,\n \"numMaps\" : 12345,\n \"bandwidthPerMap\" : 12345,\n \"policyOptions\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceDbName\" : \"...\",\n \"targetDbName\" : \"...\",\n \"policyName\" : \"...\",\n \"scheduleClause\" : \"...\",\n \"runAs\" : \"...\",\n \"hiveOp\" : \"...\",\n \"hiveUpdateOp\" : \"...\",\n \"excludeSource\" : true,\n \"excludeTarget\" : true,\n \"failoverStatus\" : \"...\",\n \"cloudArgs\" : { },\n \"remoteDbParams\" : \"...\"\n },\n \"rangerArguments\" : {\n \"sourceRangerService\" : { },\n \"exportArgs\" : { },\n \"transformArgs\" : { },\n \"importArgs\" : { },\n \"auditLogDistCpArgs\" : { },\n \"auditLogDistCpCloudArgs\" : { }\n },\n \"icebergArguments\" : {\n \"sourceIcebergReplicationService\" : { },\n \"policyName\" : \"...\",\n \"includedTableFilters\" : [ { }, { } ],\n \"excludedTableFilters\" : [ { }, { } ],\n \"batchSize\" : 12345,\n \"proxyName\" : \"...\",\n \"exportYarnOptions\" : { },\n \"xferYarnOptions\" : { },\n \"syncYarnOptions\" : { },\n \"shouldReplicateColumnStats\" : true,\n \"atlasReplicationNeeded\" : true,\n \"policyOptions\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"atlasChangeMarker\" : \"...\",\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"safetyValvesSource\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"safetyValvesTarget\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"runDistcpOnSource\" : true,\n \"altStagingLocation\" : \"...\",\n \"forceTest\" : true,\n \"deleteOperation\" : true,\n \"jvmOptsForExport\" : \"...\",\n \"jvmOptsForXfer\" : \"...\",\n \"jvmOptsForSync\" : \"...\",\n \"locationMapping\" : [ { }, { } ],\n \"sourceStorageFilter\" : \"HDFS\",\n \"proxyNameOnSource\" : \"...\"\n },\n \"atlasReplicationArguments\" : {\n \"sourceService\" : { },\n \"sourceStorageFilter\" : \"HDFS\",\n \"policyName\" : \"...\",\n \"stagingDir\" : \"...\",\n \"atlasEntityRegexPattern\" : \"...\",\n \"safetyValvesTarget\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"matchType\" : \"...\",\n \"atlasEntityType\" : [ \"...\", \"...\" ],\n \"skipLineage\" : true,\n \"fetchType\" : \"...\",\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"MINUTE\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : {\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"STATIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"hiveArguments\" : {\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceService\" : { },\n \"tableFilters\" : [ { }, { } ],\n \"exportDir\" : \"...\",\n \"force\" : true,\n \"replicateData\" : true,\n \"hdfsArguments\" : { },\n \"replicateImpalaMetadata\" : true,\n \"runInvalidateMetadata\" : true,\n \"dryRun\" : true,\n \"numThreads\" : 12345,\n \"sentryMigration\" : true,\n \"skipUrlPermissions\" : true,\n \"atlasReplicationNeeded\" : true,\n \"atlasChangeMarker\" : \"...\",\n \"sentryExportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"rangerImportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"hdfsCloudArguments\" : {\n \"sourceAccount\" : \"...\",\n \"destinationAccount\" : \"...\",\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"DYNAMIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"ozoneReplicationArguments\" : {\n \"originalSourcePath\" : \"...\",\n \"originalDestinationPath\" : \"...\",\n \"replicationType\" : \"FULL_FILE_LISTING\",\n \"inclusionFilters\" : [ \"...\", \"...\" ],\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"STATIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"history\" : [ {\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"hiveResult\" : { },\n \"hiveOnTezResult\" : { },\n \"hbaseInfo\" : { },\n \"rangerResult\" : { },\n \"icebergResult\" : { },\n \"apiReplicationCommandsWithSameIntent\" : [ { }, { } ],\n \"apiAtlasReplicationResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"hiveResult\" : { },\n \"hiveOnTezResult\" : { },\n \"hbaseInfo\" : { },\n \"rangerResult\" : { },\n \"icebergResult\" : { },\n \"apiReplicationCommandsWithSameIntent\" : [ { }, { } ],\n \"apiAtlasReplicationResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ],\n \"active\" : true,\n \"hiveCloudArguments\" : {\n \"sourceAccount\" : \"...\",\n \"destinationAccount\" : \"...\",\n \"cloudRootPath\" : \"...\",\n \"replicationOption\" : \"KEEP_DATA_IN_CLOUD\",\n \"exportFilesPrefix\" : \"...\",\n \"awsDataSyncTaskArgs\" : { },\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceService\" : { },\n \"tableFilters\" : [ { }, { } ],\n \"exportDir\" : \"...\",\n \"force\" : true,\n \"replicateData\" : true,\n \"hdfsArguments\" : { },\n \"replicateImpalaMetadata\" : true,\n \"runInvalidateMetadata\" : true,\n \"dryRun\" : true,\n \"numThreads\" : 12345,\n \"sentryMigration\" : true,\n \"skipUrlPermissions\" : true,\n \"atlasReplicationNeeded\" : true,\n \"atlasChangeMarker\" : \"...\",\n \"sentryExportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"rangerImportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"hbaseArguments\" : {\n \"sourceHBaseService\" : { },\n \"peerState\" : \"ENABLED\",\n \"hbasePeerId\" : \"...\",\n \"hbaseClusterKey\" : \"...\",\n \"endPointClassName\" : \"...\",\n \"tables\" : [ { }, { } ],\n \"database\" : { },\n \"replicationProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceAccount\" : \"...\",\n \"sourceSchedulerPool\" : \"...\",\n \"numMappers\" : 12345,\n \"bandwidthPerMap\" : 12345,\n \"exportSnapshotUser\" : \"...\",\n \"snapshotScratchLocation\" : \"...\",\n \"validateReplicationSetup\" : true,\n \"maxParallelSnapshots\" : 12345\n },\n \"hive3Arguments\" : {\n \"sourceHiveService\" : { },\n \"status\" : \"DISABLED\",\n \"rangerReplication\" : true,\n \"atlasReplication\" : true,\n \"externalTableReplication\" : true,\n \"externalTableBaseDir\" : \"...\",\n \"distcpOnTarget\" : true,\n \"numMaps\" : 12345,\n \"bandwidthPerMap\" : 12345,\n \"policyOptions\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceDbName\" : \"...\",\n \"targetDbName\" : \"...\",\n \"policyName\" : \"...\",\n \"scheduleClause\" : \"...\",\n \"runAs\" : \"...\",\n \"hiveOp\" : \"...\",\n \"hiveUpdateOp\" : \"...\",\n \"excludeSource\" : true,\n \"excludeTarget\" : true,\n \"failoverStatus\" : \"...\",\n \"cloudArgs\" : { },\n \"remoteDbParams\" : \"...\"\n },\n \"rangerArguments\" : {\n \"sourceRangerService\" : { },\n \"exportArgs\" : { },\n \"transformArgs\" : { },\n \"importArgs\" : { },\n \"auditLogDistCpArgs\" : { },\n \"auditLogDistCpCloudArgs\" : { }\n },\n \"icebergArguments\" : {\n \"sourceIcebergReplicationService\" : { },\n \"policyName\" : \"...\",\n \"includedTableFilters\" : [ { }, { } ],\n \"excludedTableFilters\" : [ { }, { } ],\n \"batchSize\" : 12345,\n \"proxyName\" : \"...\",\n \"exportYarnOptions\" : { },\n \"xferYarnOptions\" : { },\n \"syncYarnOptions\" : { },\n \"shouldReplicateColumnStats\" : true,\n \"atlasReplicationNeeded\" : true,\n \"policyOptions\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"atlasChangeMarker\" : \"...\",\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"safetyValvesSource\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"safetyValvesTarget\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"runDistcpOnSource\" : true,\n \"altStagingLocation\" : \"...\",\n \"forceTest\" : true,\n \"deleteOperation\" : true,\n \"jvmOptsForExport\" : \"...\",\n \"jvmOptsForXfer\" : \"...\",\n \"jvmOptsForSync\" : \"...\",\n \"locationMapping\" : [ { }, { } ],\n \"sourceStorageFilter\" : \"OZONE\",\n \"proxyNameOnSource\" : \"...\"\n },\n \"atlasReplicationArguments\" : {\n \"sourceService\" : { },\n \"sourceStorageFilter\" : \"HDFS\",\n \"policyName\" : \"...\",\n \"stagingDir\" : \"...\",\n \"atlasEntityRegexPattern\" : \"...\",\n \"safetyValvesTarget\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"matchType\" : \"...\",\n \"atlasEntityType\" : [ \"...\", \"...\" ],\n \"skipLineage\" : true,\n \"fetchType\" : \"...\",\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"YEAR\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : {\n \"tableRegExps\" : [ \"...\", \"...\" ],\n \"storage\" : \"REMOTE_S3\"\n },\n \"hdfsArguments\" : {\n \"pathPatterns\" : [ \"...\", \"...\" ]\n },\n \"ozoneArguments\" : {\n \"buckets\" : [ { }, { } ]\n },\n \"lastCommand\" : {\n \"hbaseResult\" : { },\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n },\n \"lastSuccessfulCommand\" : {\n \"hbaseResult\" : { },\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : {\n \"tableRegExps\" : [ \"...\", \"...\" ],\n \"storage\" : \"REMOTE_S3\"\n },\n \"hdfsArguments\" : {\n \"pathPatterns\" : [ \"...\", \"...\" ]\n },\n \"ozoneArguments\" : {\n \"buckets\" : [ { }, { } ]\n },\n \"lastCommand\" : {\n \"hbaseResult\" : { },\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n },\n \"lastSuccessfulCommand\" : {\n \"hbaseResult\" : { },\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"BAD_HEALTH\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiService"
}
}
},
"description" : "The details of the deleted service."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the service to delete."
}
]
},
"get" : {
"tags" : [ "ServicesResource" ],
"description" : "Retrieves details information about a service.",
"operationId" : "readService",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"NA\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"FRESH\",\n \"clientConfigStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"BAD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"CONCERNING\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"HOST\", \"SERVICE\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ {\n \"roleType\" : \"...\",\n \"items\" : [ { }, { } ]\n }, {\n \"roleType\" : \"...\",\n \"items\" : [ { }, { } ]\n } ],\n \"items\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\",\n \"required\" : true,\n \"default\" : \"...\",\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"relatedName\" : \"...\",\n \"sensitive\" : true,\n \"validationState\" : \"ERROR\",\n \"validationMessage\" : \"...\",\n \"validationWarningsSuppressed\" : true\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\",\n \"required\" : true,\n \"default\" : \"...\",\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"relatedName\" : \"...\",\n \"sensitive\" : true,\n \"validationState\" : \"ERROR\",\n \"validationMessage\" : \"...\",\n \"validationWarningsSuppressed\" : true\n } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleState\" : \"STARTING\",\n \"commissionState\" : \"DECOMMISSIONED\",\n \"healthSummary\" : \"GOOD\",\n \"configStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"BAD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"CONCERNING\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"haStatus\" : \"STANDBY\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CONTROL_PLANE\", \"HOST\" ],\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"roleConfigGroupRef\" : {\n \"roleConfigGroupName\" : \"...\"\n },\n \"zooKeeperServerMode\" : \"REPLICATED_LEADER_ELECTION\",\n \"entityStatus\" : \"BAD_HEALTH\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleState\" : \"STARTING\",\n \"commissionState\" : \"OFFLINED\",\n \"healthSummary\" : \"BAD\",\n \"configStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"DISABLED\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"DISABLED\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"haStatus\" : \"UNKNOWN\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"ROLE\" ],\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"roleConfigGroupRef\" : {\n \"roleConfigGroupName\" : \"...\"\n },\n \"zooKeeperServerMode\" : \"REPLICATED_FOLLOWER\",\n \"entityStatus\" : \"STOPPING\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"displayName\" : \"...\",\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"displayName\" : \"...\",\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : {\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"STATIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"hiveArguments\" : {\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceService\" : { },\n \"tableFilters\" : [ { }, { } ],\n \"exportDir\" : \"...\",\n \"force\" : true,\n \"replicateData\" : true,\n \"hdfsArguments\" : { },\n \"replicateImpalaMetadata\" : true,\n \"runInvalidateMetadata\" : true,\n \"dryRun\" : true,\n \"numThreads\" : 12345,\n \"sentryMigration\" : true,\n \"skipUrlPermissions\" : true,\n \"atlasReplicationNeeded\" : true,\n \"atlasChangeMarker\" : \"...\",\n \"sentryExportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"rangerImportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"hdfsCloudArguments\" : {\n \"sourceAccount\" : \"...\",\n \"destinationAccount\" : \"...\",\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"STATIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"ozoneReplicationArguments\" : {\n \"originalSourcePath\" : \"...\",\n \"originalDestinationPath\" : \"...\",\n \"replicationType\" : \"INCREMENTAL_WITH_FALLBACK_TO_FULL_FILE_LISTING\",\n \"inclusionFilters\" : [ \"...\", \"...\" ],\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"DYNAMIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"history\" : [ {\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"hiveResult\" : { },\n \"hiveOnTezResult\" : { },\n \"hbaseInfo\" : { },\n \"rangerResult\" : { },\n \"icebergResult\" : { },\n \"apiReplicationCommandsWithSameIntent\" : [ { }, { } ],\n \"apiAtlasReplicationResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"hiveResult\" : { },\n \"hiveOnTezResult\" : { },\n \"hbaseInfo\" : { },\n \"rangerResult\" : { },\n \"icebergResult\" : { },\n \"apiReplicationCommandsWithSameIntent\" : [ { }, { } ],\n \"apiAtlasReplicationResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ],\n \"active\" : true,\n \"hiveCloudArguments\" : {\n \"sourceAccount\" : \"...\",\n \"destinationAccount\" : \"...\",\n \"cloudRootPath\" : \"...\",\n \"replicationOption\" : \"METADATA_ONLY\",\n \"exportFilesPrefix\" : \"...\",\n \"awsDataSyncTaskArgs\" : { },\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceService\" : { },\n \"tableFilters\" : [ { }, { } ],\n \"exportDir\" : \"...\",\n \"force\" : true,\n \"replicateData\" : true,\n \"hdfsArguments\" : { },\n \"replicateImpalaMetadata\" : true,\n \"runInvalidateMetadata\" : true,\n \"dryRun\" : true,\n \"numThreads\" : 12345,\n \"sentryMigration\" : true,\n \"skipUrlPermissions\" : true,\n \"atlasReplicationNeeded\" : true,\n \"atlasChangeMarker\" : \"...\",\n \"sentryExportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"rangerImportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"hbaseArguments\" : {\n \"sourceHBaseService\" : { },\n \"peerState\" : \"ENABLED\",\n \"hbasePeerId\" : \"...\",\n \"hbaseClusterKey\" : \"...\",\n \"endPointClassName\" : \"...\",\n \"tables\" : [ { }, { } ],\n \"database\" : { },\n \"replicationProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceAccount\" : \"...\",\n \"sourceSchedulerPool\" : \"...\",\n \"numMappers\" : 12345,\n \"bandwidthPerMap\" : 12345,\n \"exportSnapshotUser\" : \"...\",\n \"snapshotScratchLocation\" : \"...\",\n \"validateReplicationSetup\" : true,\n \"maxParallelSnapshots\" : 12345\n },\n \"hive3Arguments\" : {\n \"sourceHiveService\" : { },\n \"status\" : \"ENABLED\",\n \"rangerReplication\" : true,\n \"atlasReplication\" : true,\n \"externalTableReplication\" : true,\n \"externalTableBaseDir\" : \"...\",\n \"distcpOnTarget\" : true,\n \"numMaps\" : 12345,\n \"bandwidthPerMap\" : 12345,\n \"policyOptions\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceDbName\" : \"...\",\n \"targetDbName\" : \"...\",\n \"policyName\" : \"...\",\n \"scheduleClause\" : \"...\",\n \"runAs\" : \"...\",\n \"hiveOp\" : \"...\",\n \"hiveUpdateOp\" : \"...\",\n \"excludeSource\" : true,\n \"excludeTarget\" : true,\n \"failoverStatus\" : \"...\",\n \"cloudArgs\" : { },\n \"remoteDbParams\" : \"...\"\n },\n \"rangerArguments\" : {\n \"sourceRangerService\" : { },\n \"exportArgs\" : { },\n \"transformArgs\" : { },\n \"importArgs\" : { },\n \"auditLogDistCpArgs\" : { },\n \"auditLogDistCpCloudArgs\" : { }\n },\n \"icebergArguments\" : {\n \"sourceIcebergReplicationService\" : { },\n \"policyName\" : \"...\",\n \"includedTableFilters\" : [ { }, { } ],\n \"excludedTableFilters\" : [ { }, { } ],\n \"batchSize\" : 12345,\n \"proxyName\" : \"...\",\n \"exportYarnOptions\" : { },\n \"xferYarnOptions\" : { },\n \"syncYarnOptions\" : { },\n \"shouldReplicateColumnStats\" : true,\n \"atlasReplicationNeeded\" : true,\n \"policyOptions\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"atlasChangeMarker\" : \"...\",\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"safetyValvesSource\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"safetyValvesTarget\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"runDistcpOnSource\" : true,\n \"altStagingLocation\" : \"...\",\n \"forceTest\" : true,\n \"deleteOperation\" : true,\n \"jvmOptsForExport\" : \"...\",\n \"jvmOptsForXfer\" : \"...\",\n \"jvmOptsForSync\" : \"...\",\n \"locationMapping\" : [ { }, { } ],\n \"sourceStorageFilter\" : \"HDFS\",\n \"proxyNameOnSource\" : \"...\"\n },\n \"atlasReplicationArguments\" : {\n \"sourceService\" : { },\n \"sourceStorageFilter\" : \"S3\",\n \"policyName\" : \"...\",\n \"stagingDir\" : \"...\",\n \"atlasEntityRegexPattern\" : \"...\",\n \"safetyValvesTarget\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"matchType\" : \"...\",\n \"atlasEntityType\" : [ \"...\", \"...\" ],\n \"skipLineage\" : true,\n \"fetchType\" : \"...\",\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"YEAR\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : {\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"DYNAMIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"hiveArguments\" : {\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceService\" : { },\n \"tableFilters\" : [ { }, { } ],\n \"exportDir\" : \"...\",\n \"force\" : true,\n \"replicateData\" : true,\n \"hdfsArguments\" : { },\n \"replicateImpalaMetadata\" : true,\n \"runInvalidateMetadata\" : true,\n \"dryRun\" : true,\n \"numThreads\" : 12345,\n \"sentryMigration\" : true,\n \"skipUrlPermissions\" : true,\n \"atlasReplicationNeeded\" : true,\n \"atlasChangeMarker\" : \"...\",\n \"sentryExportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"rangerImportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"hdfsCloudArguments\" : {\n \"sourceAccount\" : \"...\",\n \"destinationAccount\" : \"...\",\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"DYNAMIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"ozoneReplicationArguments\" : {\n \"originalSourcePath\" : \"...\",\n \"originalDestinationPath\" : \"...\",\n \"replicationType\" : \"INCREMENTAL_ONLY\",\n \"inclusionFilters\" : [ \"...\", \"...\" ],\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"STATIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"history\" : [ {\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"hiveResult\" : { },\n \"hiveOnTezResult\" : { },\n \"hbaseInfo\" : { },\n \"rangerResult\" : { },\n \"icebergResult\" : { },\n \"apiReplicationCommandsWithSameIntent\" : [ { }, { } ],\n \"apiAtlasReplicationResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"hiveResult\" : { },\n \"hiveOnTezResult\" : { },\n \"hbaseInfo\" : { },\n \"rangerResult\" : { },\n \"icebergResult\" : { },\n \"apiReplicationCommandsWithSameIntent\" : [ { }, { } ],\n \"apiAtlasReplicationResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ],\n \"active\" : true,\n \"hiveCloudArguments\" : {\n \"sourceAccount\" : \"...\",\n \"destinationAccount\" : \"...\",\n \"cloudRootPath\" : \"...\",\n \"replicationOption\" : \"METADATA_ONLY\",\n \"exportFilesPrefix\" : \"...\",\n \"awsDataSyncTaskArgs\" : { },\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceService\" : { },\n \"tableFilters\" : [ { }, { } ],\n \"exportDir\" : \"...\",\n \"force\" : true,\n \"replicateData\" : true,\n \"hdfsArguments\" : { },\n \"replicateImpalaMetadata\" : true,\n \"runInvalidateMetadata\" : true,\n \"dryRun\" : true,\n \"numThreads\" : 12345,\n \"sentryMigration\" : true,\n \"skipUrlPermissions\" : true,\n \"atlasReplicationNeeded\" : true,\n \"atlasChangeMarker\" : \"...\",\n \"sentryExportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"rangerImportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"hbaseArguments\" : {\n \"sourceHBaseService\" : { },\n \"peerState\" : \"ENABLED\",\n \"hbasePeerId\" : \"...\",\n \"hbaseClusterKey\" : \"...\",\n \"endPointClassName\" : \"...\",\n \"tables\" : [ { }, { } ],\n \"database\" : { },\n \"replicationProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceAccount\" : \"...\",\n \"sourceSchedulerPool\" : \"...\",\n \"numMappers\" : 12345,\n \"bandwidthPerMap\" : 12345,\n \"exportSnapshotUser\" : \"...\",\n \"snapshotScratchLocation\" : \"...\",\n \"validateReplicationSetup\" : true,\n \"maxParallelSnapshots\" : 12345\n },\n \"hive3Arguments\" : {\n \"sourceHiveService\" : { },\n \"status\" : \"DISABLED\",\n \"rangerReplication\" : true,\n \"atlasReplication\" : true,\n \"externalTableReplication\" : true,\n \"externalTableBaseDir\" : \"...\",\n \"distcpOnTarget\" : true,\n \"numMaps\" : 12345,\n \"bandwidthPerMap\" : 12345,\n \"policyOptions\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceDbName\" : \"...\",\n \"targetDbName\" : \"...\",\n \"policyName\" : \"...\",\n \"scheduleClause\" : \"...\",\n \"runAs\" : \"...\",\n \"hiveOp\" : \"...\",\n \"hiveUpdateOp\" : \"...\",\n \"excludeSource\" : true,\n \"excludeTarget\" : true,\n \"failoverStatus\" : \"...\",\n \"cloudArgs\" : { },\n \"remoteDbParams\" : \"...\"\n },\n \"rangerArguments\" : {\n \"sourceRangerService\" : { },\n \"exportArgs\" : { },\n \"transformArgs\" : { },\n \"importArgs\" : { },\n \"auditLogDistCpArgs\" : { },\n \"auditLogDistCpCloudArgs\" : { }\n },\n \"icebergArguments\" : {\n \"sourceIcebergReplicationService\" : { },\n \"policyName\" : \"...\",\n \"includedTableFilters\" : [ { }, { } ],\n \"excludedTableFilters\" : [ { }, { } ],\n \"batchSize\" : 12345,\n \"proxyName\" : \"...\",\n \"exportYarnOptions\" : { },\n \"xferYarnOptions\" : { },\n \"syncYarnOptions\" : { },\n \"shouldReplicateColumnStats\" : true,\n \"atlasReplicationNeeded\" : true,\n \"policyOptions\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"atlasChangeMarker\" : \"...\",\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"safetyValvesSource\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"safetyValvesTarget\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"runDistcpOnSource\" : true,\n \"altStagingLocation\" : \"...\",\n \"forceTest\" : true,\n \"deleteOperation\" : true,\n \"jvmOptsForExport\" : \"...\",\n \"jvmOptsForXfer\" : \"...\",\n \"jvmOptsForSync\" : \"...\",\n \"locationMapping\" : [ { }, { } ],\n \"sourceStorageFilter\" : \"S3\",\n \"proxyNameOnSource\" : \"...\"\n },\n \"atlasReplicationArguments\" : {\n \"sourceService\" : { },\n \"sourceStorageFilter\" : \"S3\",\n \"policyName\" : \"...\",\n \"stagingDir\" : \"...\",\n \"atlasEntityRegexPattern\" : \"...\",\n \"safetyValvesTarget\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"matchType\" : \"...\",\n \"atlasEntityType\" : [ \"...\", \"...\" ],\n \"skipLineage\" : true,\n \"fetchType\" : \"...\",\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"DAY\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : {\n \"tableRegExps\" : [ \"...\", \"...\" ],\n \"storage\" : \"LOCAL\"\n },\n \"hdfsArguments\" : {\n \"pathPatterns\" : [ \"...\", \"...\" ]\n },\n \"ozoneArguments\" : {\n \"buckets\" : [ { }, { } ]\n },\n \"lastCommand\" : {\n \"hbaseResult\" : { },\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n },\n \"lastSuccessfulCommand\" : {\n \"hbaseResult\" : { },\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : {\n \"tableRegExps\" : [ \"...\", \"...\" ],\n \"storage\" : \"LOCAL\"\n },\n \"hdfsArguments\" : {\n \"pathPatterns\" : [ \"...\", \"...\" ]\n },\n \"ozoneArguments\" : {\n \"buckets\" : [ { }, { } ]\n },\n \"lastCommand\" : {\n \"hbaseResult\" : { },\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n },\n \"lastSuccessfulCommand\" : {\n \"hbaseResult\" : { },\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"GOOD_HEALTH\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiService"
}
}
},
"description" : "The details of the service."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The service name."
},
{
"name" : "view",
"in" : "query",
"schema" : {
"default" : "full",
"type" : "string",
"enum" : ["EXPORT", "EXPORT_REDACTED", "FULL", "FULL_WITH_HEALTH_CHECK_EXPLANATION", "FULL_WITH_NO_HEALTH_CHECK", "SUMMARY", "SUMMARY_WITH_NO_HEALTH_CHECK"]
},
"description" : "DataView to materialize. Defaults to 'full'."
}
]
},
"put" : {
"tags" : [ "ServicesResource" ],
"description" : "Updates service information.\n\nThis method will update only writable fields of the service information.\nCurrently this only includes the service display name.\n\nAvailable since API v3.",
"operationId" : "updateService",
"requestBody" : {
"description" : "Updated service information.",
"required" : false,
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"NA\",\n \"healthSummary\" : \"NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"STALE\",\n \"clientConfigStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"BAD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"NOT_AVAILABLE\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"HOST\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ {\n \"roleType\" : \"...\",\n \"items\" : [ { }, { } ]\n }, {\n \"roleType\" : \"...\",\n \"items\" : [ { }, { } ]\n } ],\n \"items\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\",\n \"required\" : true,\n \"default\" : \"...\",\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"relatedName\" : \"...\",\n \"sensitive\" : true,\n \"validationState\" : \"OK\",\n \"validationMessage\" : \"...\",\n \"validationWarningsSuppressed\" : true\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\",\n \"required\" : true,\n \"default\" : \"...\",\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"relatedName\" : \"...\",\n \"sensitive\" : true,\n \"validationState\" : \"ERROR\",\n \"validationMessage\" : \"...\",\n \"validationWarningsSuppressed\" : true\n } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleState\" : \"UNKNOWN\",\n \"commissionState\" : \"COMMISSIONED\",\n \"healthSummary\" : \"BAD\",\n \"configStalenessStatus\" : \"STALE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"GOOD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"NOT_AVAILABLE\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"haStatus\" : \"UNKNOWN\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"SERVICE\" ],\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"roleConfigGroupRef\" : {\n \"roleConfigGroupName\" : \"...\"\n },\n \"zooKeeperServerMode\" : \"REPLICATED_OBSERVER\",\n \"entityStatus\" : \"UNKNOWN_HEALTH\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleState\" : \"STOPPING\",\n \"commissionState\" : \"DECOMMISSIONING\",\n \"healthSummary\" : \"DISABLED\",\n \"configStalenessStatus\" : \"STALE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"BAD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"CONCERNING\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"haStatus\" : \"STANDBY\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"ROLE\", \"SERVICE\" ],\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"roleConfigGroupRef\" : {\n \"roleConfigGroupName\" : \"...\"\n },\n \"zooKeeperServerMode\" : \"REPLICATED_FOLLOWER\",\n \"entityStatus\" : \"UNKNOWN_HEALTH\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"displayName\" : \"...\",\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"displayName\" : \"...\",\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : {\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"DYNAMIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"hiveArguments\" : {\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceService\" : { },\n \"tableFilters\" : [ { }, { } ],\n \"exportDir\" : \"...\",\n \"force\" : true,\n \"replicateData\" : true,\n \"hdfsArguments\" : { },\n \"replicateImpalaMetadata\" : true,\n \"runInvalidateMetadata\" : true,\n \"dryRun\" : true,\n \"numThreads\" : 12345,\n \"sentryMigration\" : true,\n \"skipUrlPermissions\" : true,\n \"atlasReplicationNeeded\" : true,\n \"atlasChangeMarker\" : \"...\",\n \"sentryExportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"rangerImportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"hdfsCloudArguments\" : {\n \"sourceAccount\" : \"...\",\n \"destinationAccount\" : \"...\",\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"STATIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"ozoneReplicationArguments\" : {\n \"originalSourcePath\" : \"...\",\n \"originalDestinationPath\" : \"...\",\n \"replicationType\" : \"INCREMENTAL_ONLY\",\n \"inclusionFilters\" : [ \"...\", \"...\" ],\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"STATIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"history\" : [ {\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"hiveResult\" : { },\n \"hiveOnTezResult\" : { },\n \"hbaseInfo\" : { },\n \"rangerResult\" : { },\n \"icebergResult\" : { },\n \"apiReplicationCommandsWithSameIntent\" : [ { }, { } ],\n \"apiAtlasReplicationResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"hiveResult\" : { },\n \"hiveOnTezResult\" : { },\n \"hbaseInfo\" : { },\n \"rangerResult\" : { },\n \"icebergResult\" : { },\n \"apiReplicationCommandsWithSameIntent\" : [ { }, { } ],\n \"apiAtlasReplicationResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ],\n \"active\" : true,\n \"hiveCloudArguments\" : {\n \"sourceAccount\" : \"...\",\n \"destinationAccount\" : \"...\",\n \"cloudRootPath\" : \"...\",\n \"replicationOption\" : \"KEEP_DATA_IN_CLOUD\",\n \"exportFilesPrefix\" : \"...\",\n \"awsDataSyncTaskArgs\" : { },\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceService\" : { },\n \"tableFilters\" : [ { }, { } ],\n \"exportDir\" : \"...\",\n \"force\" : true,\n \"replicateData\" : true,\n \"hdfsArguments\" : { },\n \"replicateImpalaMetadata\" : true,\n \"runInvalidateMetadata\" : true,\n \"dryRun\" : true,\n \"numThreads\" : 12345,\n \"sentryMigration\" : true,\n \"skipUrlPermissions\" : true,\n \"atlasReplicationNeeded\" : true,\n \"atlasChangeMarker\" : \"...\",\n \"sentryExportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"rangerImportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"hbaseArguments\" : {\n \"sourceHBaseService\" : { },\n \"peerState\" : \"DISABLED\",\n \"hbasePeerId\" : \"...\",\n \"hbaseClusterKey\" : \"...\",\n \"endPointClassName\" : \"...\",\n \"tables\" : [ { }, { } ],\n \"database\" : { },\n \"replicationProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceAccount\" : \"...\",\n \"sourceSchedulerPool\" : \"...\",\n \"numMappers\" : 12345,\n \"bandwidthPerMap\" : 12345,\n \"exportSnapshotUser\" : \"...\",\n \"snapshotScratchLocation\" : \"...\",\n \"validateReplicationSetup\" : true,\n \"maxParallelSnapshots\" : 12345\n },\n \"hive3Arguments\" : {\n \"sourceHiveService\" : { },\n \"status\" : \"DISABLED\",\n \"rangerReplication\" : true,\n \"atlasReplication\" : true,\n \"externalTableReplication\" : true,\n \"externalTableBaseDir\" : \"...\",\n \"distcpOnTarget\" : true,\n \"numMaps\" : 12345,\n \"bandwidthPerMap\" : 12345,\n \"policyOptions\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceDbName\" : \"...\",\n \"targetDbName\" : \"...\",\n \"policyName\" : \"...\",\n \"scheduleClause\" : \"...\",\n \"runAs\" : \"...\",\n \"hiveOp\" : \"...\",\n \"hiveUpdateOp\" : \"...\",\n \"excludeSource\" : true,\n \"excludeTarget\" : true,\n \"failoverStatus\" : \"...\",\n \"cloudArgs\" : { },\n \"remoteDbParams\" : \"...\"\n },\n \"rangerArguments\" : {\n \"sourceRangerService\" : { },\n \"exportArgs\" : { },\n \"transformArgs\" : { },\n \"importArgs\" : { },\n \"auditLogDistCpArgs\" : { },\n \"auditLogDistCpCloudArgs\" : { }\n },\n \"icebergArguments\" : {\n \"sourceIcebergReplicationService\" : { },\n \"policyName\" : \"...\",\n \"includedTableFilters\" : [ { }, { } ],\n \"excludedTableFilters\" : [ { }, { } ],\n \"batchSize\" : 12345,\n \"proxyName\" : \"...\",\n \"exportYarnOptions\" : { },\n \"xferYarnOptions\" : { },\n \"syncYarnOptions\" : { },\n \"shouldReplicateColumnStats\" : true,\n \"atlasReplicationNeeded\" : true,\n \"policyOptions\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"atlasChangeMarker\" : \"...\",\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"safetyValvesSource\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"safetyValvesTarget\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"runDistcpOnSource\" : true,\n \"altStagingLocation\" : \"...\",\n \"forceTest\" : true,\n \"deleteOperation\" : true,\n \"jvmOptsForExport\" : \"...\",\n \"jvmOptsForXfer\" : \"...\",\n \"jvmOptsForSync\" : \"...\",\n \"locationMapping\" : [ { }, { } ],\n \"sourceStorageFilter\" : \"S3\",\n \"proxyNameOnSource\" : \"...\"\n },\n \"atlasReplicationArguments\" : {\n \"sourceService\" : { },\n \"sourceStorageFilter\" : \"OZONE\",\n \"policyName\" : \"...\",\n \"stagingDir\" : \"...\",\n \"atlasEntityRegexPattern\" : \"...\",\n \"safetyValvesTarget\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"matchType\" : \"...\",\n \"atlasEntityType\" : [ \"...\", \"...\" ],\n \"skipLineage\" : true,\n \"fetchType\" : \"...\",\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"WEEK\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : {\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"DYNAMIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"hiveArguments\" : {\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceService\" : { },\n \"tableFilters\" : [ { }, { } ],\n \"exportDir\" : \"...\",\n \"force\" : true,\n \"replicateData\" : true,\n \"hdfsArguments\" : { },\n \"replicateImpalaMetadata\" : true,\n \"runInvalidateMetadata\" : true,\n \"dryRun\" : true,\n \"numThreads\" : 12345,\n \"sentryMigration\" : true,\n \"skipUrlPermissions\" : true,\n \"atlasReplicationNeeded\" : true,\n \"atlasChangeMarker\" : \"...\",\n \"sentryExportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"rangerImportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"hdfsCloudArguments\" : {\n \"sourceAccount\" : \"...\",\n \"destinationAccount\" : \"...\",\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"DYNAMIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"ozoneReplicationArguments\" : {\n \"originalSourcePath\" : \"...\",\n \"originalDestinationPath\" : \"...\",\n \"replicationType\" : \"INCREMENTAL_WITH_FALLBACK_TO_FULL_FILE_LISTING\",\n \"inclusionFilters\" : [ \"...\", \"...\" ],\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"DYNAMIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"history\" : [ {\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"hiveResult\" : { },\n \"hiveOnTezResult\" : { },\n \"hbaseInfo\" : { },\n \"rangerResult\" : { },\n \"icebergResult\" : { },\n \"apiReplicationCommandsWithSameIntent\" : [ { }, { } ],\n \"apiAtlasReplicationResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"hiveResult\" : { },\n \"hiveOnTezResult\" : { },\n \"hbaseInfo\" : { },\n \"rangerResult\" : { },\n \"icebergResult\" : { },\n \"apiReplicationCommandsWithSameIntent\" : [ { }, { } ],\n \"apiAtlasReplicationResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ],\n \"active\" : true,\n \"hiveCloudArguments\" : {\n \"sourceAccount\" : \"...\",\n \"destinationAccount\" : \"...\",\n \"cloudRootPath\" : \"...\",\n \"replicationOption\" : \"KEEP_DATA_IN_CLOUD\",\n \"exportFilesPrefix\" : \"...\",\n \"awsDataSyncTaskArgs\" : { },\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceService\" : { },\n \"tableFilters\" : [ { }, { } ],\n \"exportDir\" : \"...\",\n \"force\" : true,\n \"replicateData\" : true,\n \"hdfsArguments\" : { },\n \"replicateImpalaMetadata\" : true,\n \"runInvalidateMetadata\" : true,\n \"dryRun\" : true,\n \"numThreads\" : 12345,\n \"sentryMigration\" : true,\n \"skipUrlPermissions\" : true,\n \"atlasReplicationNeeded\" : true,\n \"atlasChangeMarker\" : \"...\",\n \"sentryExportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"rangerImportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"hbaseArguments\" : {\n \"sourceHBaseService\" : { },\n \"peerState\" : \"DISABLED\",\n \"hbasePeerId\" : \"...\",\n \"hbaseClusterKey\" : \"...\",\n \"endPointClassName\" : \"...\",\n \"tables\" : [ { }, { } ],\n \"database\" : { },\n \"replicationProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceAccount\" : \"...\",\n \"sourceSchedulerPool\" : \"...\",\n \"numMappers\" : 12345,\n \"bandwidthPerMap\" : 12345,\n \"exportSnapshotUser\" : \"...\",\n \"snapshotScratchLocation\" : \"...\",\n \"validateReplicationSetup\" : true,\n \"maxParallelSnapshots\" : 12345\n },\n \"hive3Arguments\" : {\n \"sourceHiveService\" : { },\n \"status\" : \"DISABLED\",\n \"rangerReplication\" : true,\n \"atlasReplication\" : true,\n \"externalTableReplication\" : true,\n \"externalTableBaseDir\" : \"...\",\n \"distcpOnTarget\" : true,\n \"numMaps\" : 12345,\n \"bandwidthPerMap\" : 12345,\n \"policyOptions\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceDbName\" : \"...\",\n \"targetDbName\" : \"...\",\n \"policyName\" : \"...\",\n \"scheduleClause\" : \"...\",\n \"runAs\" : \"...\",\n \"hiveOp\" : \"...\",\n \"hiveUpdateOp\" : \"...\",\n \"excludeSource\" : true,\n \"excludeTarget\" : true,\n \"failoverStatus\" : \"...\",\n \"cloudArgs\" : { },\n \"remoteDbParams\" : \"...\"\n },\n \"rangerArguments\" : {\n \"sourceRangerService\" : { },\n \"exportArgs\" : { },\n \"transformArgs\" : { },\n \"importArgs\" : { },\n \"auditLogDistCpArgs\" : { },\n \"auditLogDistCpCloudArgs\" : { }\n },\n \"icebergArguments\" : {\n \"sourceIcebergReplicationService\" : { },\n \"policyName\" : \"...\",\n \"includedTableFilters\" : [ { }, { } ],\n \"excludedTableFilters\" : [ { }, { } ],\n \"batchSize\" : 12345,\n \"proxyName\" : \"...\",\n \"exportYarnOptions\" : { },\n \"xferYarnOptions\" : { },\n \"syncYarnOptions\" : { },\n \"shouldReplicateColumnStats\" : true,\n \"atlasReplicationNeeded\" : true,\n \"policyOptions\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"atlasChangeMarker\" : \"...\",\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"safetyValvesSource\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"safetyValvesTarget\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"runDistcpOnSource\" : true,\n \"altStagingLocation\" : \"...\",\n \"forceTest\" : true,\n \"deleteOperation\" : true,\n \"jvmOptsForExport\" : \"...\",\n \"jvmOptsForXfer\" : \"...\",\n \"jvmOptsForSync\" : \"...\",\n \"locationMapping\" : [ { }, { } ],\n \"sourceStorageFilter\" : \"HDFS\",\n \"proxyNameOnSource\" : \"...\"\n },\n \"atlasReplicationArguments\" : {\n \"sourceService\" : { },\n \"sourceStorageFilter\" : \"HDFS\",\n \"policyName\" : \"...\",\n \"stagingDir\" : \"...\",\n \"atlasEntityRegexPattern\" : \"...\",\n \"safetyValvesTarget\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"matchType\" : \"...\",\n \"atlasEntityType\" : [ \"...\", \"...\" ],\n \"skipLineage\" : true,\n \"fetchType\" : \"...\",\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"MINUTE\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : {\n \"tableRegExps\" : [ \"...\", \"...\" ],\n \"storage\" : \"LOCAL\"\n },\n \"hdfsArguments\" : {\n \"pathPatterns\" : [ \"...\", \"...\" ]\n },\n \"ozoneArguments\" : {\n \"buckets\" : [ { }, { } ]\n },\n \"lastCommand\" : {\n \"hbaseResult\" : { },\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n },\n \"lastSuccessfulCommand\" : {\n \"hbaseResult\" : { },\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : {\n \"tableRegExps\" : [ \"...\", \"...\" ],\n \"storage\" : \"LOCAL\"\n },\n \"hdfsArguments\" : {\n \"pathPatterns\" : [ \"...\", \"...\" ]\n },\n \"ozoneArguments\" : {\n \"buckets\" : [ { }, { } ]\n },\n \"lastCommand\" : {\n \"hbaseResult\" : { },\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n },\n \"lastSuccessfulCommand\" : {\n \"hbaseResult\" : { },\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"UNKNOWN\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiService"
}
}
}
},
"responses" : {
"204" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceState\" : \"UNKNOWN\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"FRESH\",\n \"clientConfigStalenessStatus\" : \"STALE_REFRESHABLE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"BAD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"DISABLED\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"serviceUrl\" : \"...\",\n \"roleInstancesUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CLUSTER\", \"SERVICE\" ],\n \"config\" : {\n \"roleTypeConfigs\" : [ {\n \"roleType\" : \"...\",\n \"items\" : [ { }, { } ]\n }, {\n \"roleType\" : \"...\",\n \"items\" : [ { }, { } ]\n } ],\n \"items\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\",\n \"required\" : true,\n \"default\" : \"...\",\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"relatedName\" : \"...\",\n \"sensitive\" : true,\n \"validationState\" : \"ERROR\",\n \"validationMessage\" : \"...\",\n \"validationWarningsSuppressed\" : true\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\",\n \"required\" : true,\n \"default\" : \"...\",\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"relatedName\" : \"...\",\n \"sensitive\" : true,\n \"validationState\" : \"WARNING\",\n \"validationMessage\" : \"...\",\n \"validationWarningsSuppressed\" : true\n } ]\n },\n \"roles\" : [ {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleState\" : \"NA\",\n \"commissionState\" : \"DECOMMISSIONED\",\n \"healthSummary\" : \"BAD\",\n \"configStalenessStatus\" : \"STALE\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"BAD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"HISTORY_NOT_AVAILABLE\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"haStatus\" : \"STANDBY\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"CONTROL_PLANE\", \"SERVICE\" ],\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"roleConfigGroupRef\" : {\n \"roleConfigGroupName\" : \"...\"\n },\n \"zooKeeperServerMode\" : \"STANDALONE\",\n \"entityStatus\" : \"UNKNOWN\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n }, {\n \"name\" : \"...\",\n \"type\" : \"...\",\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleState\" : \"NA\",\n \"commissionState\" : \"OFFLINING\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"configStalenessStatus\" : \"FRESH\",\n \"healthChecks\" : [ {\n \"name\" : \"...\",\n \"summary\" : \"HISTORY_NOT_AVAILABLE\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n }, {\n \"name\" : \"...\",\n \"summary\" : \"BAD\",\n \"explanation\" : \"...\",\n \"suppressed\" : true\n } ],\n \"haStatus\" : \"ACTIVE\",\n \"roleUrl\" : \"...\",\n \"maintenanceMode\" : true,\n \"maintenanceOwners\" : [ \"SERVICE\", \"CLUSTER\" ],\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"roleConfigGroupRef\" : {\n \"roleConfigGroupName\" : \"...\"\n },\n \"zooKeeperServerMode\" : \"UNKNOWN\",\n \"entityStatus\" : \"DOWN\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ]\n } ],\n \"displayName\" : \"...\",\n \"roleConfigGroups\" : [ {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"displayName\" : \"...\",\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n }\n }, {\n \"name\" : \"...\",\n \"roleType\" : \"...\",\n \"base\" : true,\n \"config\" : {\n \"items\" : [ { }, { } ]\n },\n \"displayName\" : \"...\",\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n }\n } ],\n \"replicationSchedules\" : [ {\n \"hdfsArguments\" : {\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"DYNAMIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"hiveArguments\" : {\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceService\" : { },\n \"tableFilters\" : [ { }, { } ],\n \"exportDir\" : \"...\",\n \"force\" : true,\n \"replicateData\" : true,\n \"hdfsArguments\" : { },\n \"replicateImpalaMetadata\" : true,\n \"runInvalidateMetadata\" : true,\n \"dryRun\" : true,\n \"numThreads\" : 12345,\n \"sentryMigration\" : true,\n \"skipUrlPermissions\" : true,\n \"atlasReplicationNeeded\" : true,\n \"atlasChangeMarker\" : \"...\",\n \"sentryExportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"rangerImportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"hdfsCloudArguments\" : {\n \"sourceAccount\" : \"...\",\n \"destinationAccount\" : \"...\",\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"STATIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"ozoneReplicationArguments\" : {\n \"originalSourcePath\" : \"...\",\n \"originalDestinationPath\" : \"...\",\n \"replicationType\" : \"INCREMENTAL_WITH_FALLBACK_TO_FULL_FILE_LISTING\",\n \"inclusionFilters\" : [ \"...\", \"...\" ],\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"DYNAMIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"history\" : [ {\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"hiveResult\" : { },\n \"hiveOnTezResult\" : { },\n \"hbaseInfo\" : { },\n \"rangerResult\" : { },\n \"icebergResult\" : { },\n \"apiReplicationCommandsWithSameIntent\" : [ { }, { } ],\n \"apiAtlasReplicationResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"hiveResult\" : { },\n \"hiveOnTezResult\" : { },\n \"hbaseInfo\" : { },\n \"rangerResult\" : { },\n \"icebergResult\" : { },\n \"apiReplicationCommandsWithSameIntent\" : [ { }, { } ],\n \"apiAtlasReplicationResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ],\n \"active\" : true,\n \"hiveCloudArguments\" : {\n \"sourceAccount\" : \"...\",\n \"destinationAccount\" : \"...\",\n \"cloudRootPath\" : \"...\",\n \"replicationOption\" : \"METADATA_AND_DATA\",\n \"exportFilesPrefix\" : \"...\",\n \"awsDataSyncTaskArgs\" : { },\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceService\" : { },\n \"tableFilters\" : [ { }, { } ],\n \"exportDir\" : \"...\",\n \"force\" : true,\n \"replicateData\" : true,\n \"hdfsArguments\" : { },\n \"replicateImpalaMetadata\" : true,\n \"runInvalidateMetadata\" : true,\n \"dryRun\" : true,\n \"numThreads\" : 12345,\n \"sentryMigration\" : true,\n \"skipUrlPermissions\" : true,\n \"atlasReplicationNeeded\" : true,\n \"atlasChangeMarker\" : \"...\",\n \"sentryExportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"rangerImportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"hbaseArguments\" : {\n \"sourceHBaseService\" : { },\n \"peerState\" : \"DISABLED\",\n \"hbasePeerId\" : \"...\",\n \"hbaseClusterKey\" : \"...\",\n \"endPointClassName\" : \"...\",\n \"tables\" : [ { }, { } ],\n \"database\" : { },\n \"replicationProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceAccount\" : \"...\",\n \"sourceSchedulerPool\" : \"...\",\n \"numMappers\" : 12345,\n \"bandwidthPerMap\" : 12345,\n \"exportSnapshotUser\" : \"...\",\n \"snapshotScratchLocation\" : \"...\",\n \"validateReplicationSetup\" : true,\n \"maxParallelSnapshots\" : 12345\n },\n \"hive3Arguments\" : {\n \"sourceHiveService\" : { },\n \"status\" : \"FAILED_ADMIN\",\n \"rangerReplication\" : true,\n \"atlasReplication\" : true,\n \"externalTableReplication\" : true,\n \"externalTableBaseDir\" : \"...\",\n \"distcpOnTarget\" : true,\n \"numMaps\" : 12345,\n \"bandwidthPerMap\" : 12345,\n \"policyOptions\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceDbName\" : \"...\",\n \"targetDbName\" : \"...\",\n \"policyName\" : \"...\",\n \"scheduleClause\" : \"...\",\n \"runAs\" : \"...\",\n \"hiveOp\" : \"...\",\n \"hiveUpdateOp\" : \"...\",\n \"excludeSource\" : true,\n \"excludeTarget\" : true,\n \"failoverStatus\" : \"...\",\n \"cloudArgs\" : { },\n \"remoteDbParams\" : \"...\"\n },\n \"rangerArguments\" : {\n \"sourceRangerService\" : { },\n \"exportArgs\" : { },\n \"transformArgs\" : { },\n \"importArgs\" : { },\n \"auditLogDistCpArgs\" : { },\n \"auditLogDistCpCloudArgs\" : { }\n },\n \"icebergArguments\" : {\n \"sourceIcebergReplicationService\" : { },\n \"policyName\" : \"...\",\n \"includedTableFilters\" : [ { }, { } ],\n \"excludedTableFilters\" : [ { }, { } ],\n \"batchSize\" : 12345,\n \"proxyName\" : \"...\",\n \"exportYarnOptions\" : { },\n \"xferYarnOptions\" : { },\n \"syncYarnOptions\" : { },\n \"shouldReplicateColumnStats\" : true,\n \"atlasReplicationNeeded\" : true,\n \"policyOptions\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"atlasChangeMarker\" : \"...\",\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"safetyValvesSource\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"safetyValvesTarget\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"runDistcpOnSource\" : true,\n \"altStagingLocation\" : \"...\",\n \"forceTest\" : true,\n \"deleteOperation\" : true,\n \"jvmOptsForExport\" : \"...\",\n \"jvmOptsForXfer\" : \"...\",\n \"jvmOptsForSync\" : \"...\",\n \"locationMapping\" : [ { }, { } ],\n \"sourceStorageFilter\" : \"HDFS\",\n \"proxyNameOnSource\" : \"...\"\n },\n \"atlasReplicationArguments\" : {\n \"sourceService\" : { },\n \"sourceStorageFilter\" : \"OZONE\",\n \"policyName\" : \"...\",\n \"stagingDir\" : \"...\",\n \"atlasEntityRegexPattern\" : \"...\",\n \"safetyValvesTarget\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"matchType\" : \"...\",\n \"atlasEntityType\" : [ \"...\", \"...\" ],\n \"skipLineage\" : true,\n \"fetchType\" : \"...\",\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"YEAR\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n }, {\n \"hdfsArguments\" : {\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"DYNAMIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"hiveArguments\" : {\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceService\" : { },\n \"tableFilters\" : [ { }, { } ],\n \"exportDir\" : \"...\",\n \"force\" : true,\n \"replicateData\" : true,\n \"hdfsArguments\" : { },\n \"replicateImpalaMetadata\" : true,\n \"runInvalidateMetadata\" : true,\n \"dryRun\" : true,\n \"numThreads\" : 12345,\n \"sentryMigration\" : true,\n \"skipUrlPermissions\" : true,\n \"atlasReplicationNeeded\" : true,\n \"atlasChangeMarker\" : \"...\",\n \"sentryExportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"rangerImportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"hdfsCloudArguments\" : {\n \"sourceAccount\" : \"...\",\n \"destinationAccount\" : \"...\",\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"STATIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"ozoneReplicationArguments\" : {\n \"originalSourcePath\" : \"...\",\n \"originalDestinationPath\" : \"...\",\n \"replicationType\" : \"INCREMENTAL_WITH_FALLBACK_TO_FULL_FILE_LISTING\",\n \"inclusionFilters\" : [ \"...\", \"...\" ],\n \"sourceService\" : { },\n \"sourcePath\" : \"...\",\n \"destinationPath\" : \"...\",\n \"mapreduceServiceName\" : \"...\",\n \"schedulerPoolName\" : \"...\",\n \"userName\" : \"...\",\n \"sourceUser\" : \"...\",\n \"numMaps\" : 12345,\n \"dryRun\" : true,\n \"bandwidthPerMap\" : 12345,\n \"abortOnError\" : true,\n \"removeMissingFiles\" : true,\n \"preserveReplicationCount\" : true,\n \"preserveBlockSize\" : true,\n \"preservePermissions\" : true,\n \"logPath\" : \"...\",\n \"skipChecksumChecks\" : true,\n \"skipListingChecksumChecks\" : true,\n \"skipTrash\" : true,\n \"replicationStrategy\" : \"STATIC\",\n \"preserveXAttrs\" : true,\n \"exclusionFilters\" : [ \"...\", \"...\" ],\n \"raiseSnapshotDiffFailures\" : true,\n \"deleteLatestSourceSnapshotOnJobFailure\" : true,\n \"numFetchThreads\" : 12345,\n \"destinationCloudAccount\" : \"...\"\n },\n \"history\" : [ {\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"hiveResult\" : { },\n \"hiveOnTezResult\" : { },\n \"hbaseInfo\" : { },\n \"rangerResult\" : { },\n \"icebergResult\" : { },\n \"apiReplicationCommandsWithSameIntent\" : [ { }, { } ],\n \"apiAtlasReplicationResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"hiveResult\" : { },\n \"hiveOnTezResult\" : { },\n \"hbaseInfo\" : { },\n \"rangerResult\" : { },\n \"icebergResult\" : { },\n \"apiReplicationCommandsWithSameIntent\" : [ { }, { } ],\n \"apiAtlasReplicationResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ],\n \"active\" : true,\n \"hiveCloudArguments\" : {\n \"sourceAccount\" : \"...\",\n \"destinationAccount\" : \"...\",\n \"cloudRootPath\" : \"...\",\n \"replicationOption\" : \"METADATA_ONLY\",\n \"exportFilesPrefix\" : \"...\",\n \"awsDataSyncTaskArgs\" : { },\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceService\" : { },\n \"tableFilters\" : [ { }, { } ],\n \"exportDir\" : \"...\",\n \"force\" : true,\n \"replicateData\" : true,\n \"hdfsArguments\" : { },\n \"replicateImpalaMetadata\" : true,\n \"runInvalidateMetadata\" : true,\n \"dryRun\" : true,\n \"numThreads\" : 12345,\n \"sentryMigration\" : true,\n \"skipUrlPermissions\" : true,\n \"atlasReplicationNeeded\" : true,\n \"atlasChangeMarker\" : \"...\",\n \"sentryExportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"rangerImportProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"hbaseArguments\" : {\n \"sourceHBaseService\" : { },\n \"peerState\" : \"ENABLED\",\n \"hbasePeerId\" : \"...\",\n \"hbaseClusterKey\" : \"...\",\n \"endPointClassName\" : \"...\",\n \"tables\" : [ { }, { } ],\n \"database\" : { },\n \"replicationProperties\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceAccount\" : \"...\",\n \"sourceSchedulerPool\" : \"...\",\n \"numMappers\" : 12345,\n \"bandwidthPerMap\" : 12345,\n \"exportSnapshotUser\" : \"...\",\n \"snapshotScratchLocation\" : \"...\",\n \"validateReplicationSetup\" : true,\n \"maxParallelSnapshots\" : 12345\n },\n \"hive3Arguments\" : {\n \"sourceHiveService\" : { },\n \"status\" : \"DISABLED\",\n \"rangerReplication\" : true,\n \"atlasReplication\" : true,\n \"externalTableReplication\" : true,\n \"externalTableBaseDir\" : \"...\",\n \"distcpOnTarget\" : true,\n \"numMaps\" : 12345,\n \"bandwidthPerMap\" : 12345,\n \"policyOptions\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"sourceDbName\" : \"...\",\n \"targetDbName\" : \"...\",\n \"policyName\" : \"...\",\n \"scheduleClause\" : \"...\",\n \"runAs\" : \"...\",\n \"hiveOp\" : \"...\",\n \"hiveUpdateOp\" : \"...\",\n \"excludeSource\" : true,\n \"excludeTarget\" : true,\n \"failoverStatus\" : \"...\",\n \"cloudArgs\" : { },\n \"remoteDbParams\" : \"...\"\n },\n \"rangerArguments\" : {\n \"sourceRangerService\" : { },\n \"exportArgs\" : { },\n \"transformArgs\" : { },\n \"importArgs\" : { },\n \"auditLogDistCpArgs\" : { },\n \"auditLogDistCpCloudArgs\" : { }\n },\n \"icebergArguments\" : {\n \"sourceIcebergReplicationService\" : { },\n \"policyName\" : \"...\",\n \"includedTableFilters\" : [ { }, { } ],\n \"excludedTableFilters\" : [ { }, { } ],\n \"batchSize\" : 12345,\n \"proxyName\" : \"...\",\n \"exportYarnOptions\" : { },\n \"xferYarnOptions\" : { },\n \"syncYarnOptions\" : { },\n \"shouldReplicateColumnStats\" : true,\n \"atlasReplicationNeeded\" : true,\n \"policyOptions\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"atlasChangeMarker\" : \"...\",\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n },\n \"safetyValvesSource\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"safetyValvesTarget\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"runDistcpOnSource\" : true,\n \"altStagingLocation\" : \"...\",\n \"forceTest\" : true,\n \"deleteOperation\" : true,\n \"jvmOptsForExport\" : \"...\",\n \"jvmOptsForXfer\" : \"...\",\n \"jvmOptsForSync\" : \"...\",\n \"locationMapping\" : [ { }, { } ],\n \"sourceStorageFilter\" : \"HDFS\",\n \"proxyNameOnSource\" : \"...\"\n },\n \"atlasReplicationArguments\" : {\n \"sourceService\" : { },\n \"sourceStorageFilter\" : \"S3\",\n \"policyName\" : \"...\",\n \"stagingDir\" : \"...\",\n \"atlasEntityRegexPattern\" : \"...\",\n \"safetyValvesTarget\" : {\n \"property1\" : { },\n \"property2\" : { }\n },\n \"matchType\" : \"...\",\n \"atlasEntityType\" : [ \"...\", \"...\" ],\n \"skipLineage\" : true,\n \"fetchType\" : \"...\",\n \"atlasClientAdvanceConfigs\" : {\n \"property1\" : \"...\",\n \"property2\" : \"...\"\n }\n },\n \"id\" : 12345,\n \"displayName\" : \"...\",\n \"description\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"interval\" : 12345,\n \"intervalUnit\" : \"HOUR\",\n \"nextRun\" : \"...\",\n \"paused\" : true,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true\n } ],\n \"snapshotPolicies\" : [ {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : {\n \"tableRegExps\" : [ \"...\", \"...\" ],\n \"storage\" : \"REMOTE_S3\"\n },\n \"hdfsArguments\" : {\n \"pathPatterns\" : [ \"...\", \"...\" ]\n },\n \"ozoneArguments\" : {\n \"buckets\" : [ { }, { } ]\n },\n \"lastCommand\" : {\n \"hbaseResult\" : { },\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n },\n \"lastSuccessfulCommand\" : {\n \"hbaseResult\" : { },\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n },\n \"paused\" : true\n }, {\n \"name\" : \"...\",\n \"description\" : \"...\",\n \"hourlySnapshots\" : 12345,\n \"dailySnapshots\" : 12345,\n \"weeklySnapshots\" : 12345,\n \"monthlySnapshots\" : 12345,\n \"yearlySnapshots\" : 12345,\n \"minuteOfHour\" : 12345,\n \"hoursForHourlySnapshots\" : [ 12345, 12345 ],\n \"hourOfDay\" : 12345,\n \"dayOfWeek\" : 12345,\n \"dayOfMonth\" : 12345,\n \"monthOfYear\" : 12345,\n \"alertOnStart\" : true,\n \"alertOnSuccess\" : true,\n \"alertOnFail\" : true,\n \"alertOnAbort\" : true,\n \"hbaseArguments\" : {\n \"tableRegExps\" : [ \"...\", \"...\" ],\n \"storage\" : \"LOCAL\"\n },\n \"hdfsArguments\" : {\n \"pathPatterns\" : [ \"...\", \"...\" ]\n },\n \"ozoneArguments\" : {\n \"buckets\" : [ { }, { } ]\n },\n \"lastCommand\" : {\n \"hbaseResult\" : { },\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n },\n \"lastSuccessfulCommand\" : {\n \"hbaseResult\" : { },\n \"hdfsResult\" : { },\n \"ozoneResult\" : { },\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n },\n \"paused\" : true\n } ],\n \"entityStatus\" : \"UNKNOWN_HEALTH\",\n \"tags\" : [ {\n \"name\" : \"...\",\n \"value\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"value\" : \"...\"\n } ],\n \"serviceVersion\" : \"...\"\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiService"
}
}
},
"description" : "The updated service information."
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/activities" : {
"get" : {
"tags" : [ "ActivitiesResource" ],
"description" : "Read all activities in the system",
"operationId" : "readActivities",
"responses" : {
"200" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"items\" : [ {\n \"name\" : \"...\",\n \"type\" : \"MR\",\n \"parent\" : \"...\",\n \"startTime\" : \"...\",\n \"finishTime\" : \"...\",\n \"id\" : \"...\",\n \"status\" : \"SUSPENDED\",\n \"user\" : \"...\",\n \"group\" : \"...\",\n \"inputDir\" : \"...\",\n \"outputDir\" : \"...\",\n \"mapper\" : \"...\",\n \"combiner\" : \"...\",\n \"reducer\" : \"...\",\n \"queueName\" : \"...\",\n \"schedulerPriority\" : \"...\"\n }, {\n \"name\" : \"...\",\n \"type\" : \"OOZIE\",\n \"parent\" : \"...\",\n \"startTime\" : \"...\",\n \"finishTime\" : \"...\",\n \"id\" : \"...\",\n \"status\" : \"SUCCEEDED\",\n \"user\" : \"...\",\n \"group\" : \"...\",\n \"inputDir\" : \"...\",\n \"outputDir\" : \"...\",\n \"mapper\" : \"...\",\n \"combiner\" : \"...\",\n \"reducer\" : \"...\",\n \"queueName\" : \"...\",\n \"schedulerPriority\" : \"...\"\n } ]\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiActivityList"
}
}
},
"description" : "A list of activities"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the cluster"
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "The name of the service"
},
{
"name" : "maxResults",
"in" : "query",
"schema" : {
"default" : "100",
"type" : "integer",
"format" : "int32"
},
"description" : "The maximum number of activities to return."
},
{
"name" : "query",
"in" : "query",
"schema" : {
"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 \n
\n
\n
KeyStore Indexer service should be in Stopped state.<\/ul>\n
This is only needed for upgrading to CDH6.0.<\/ul>\n
\n
Solr service should be in Stopped state.<\/ul>\n
HDFS and Zookeeper services should in Running state.<\/ul>\n
This is only needed for upgrading to CDH6.0.<\/ul>\n<\/p>\nAvailable since API v30.",
"operationId" : "solrConfigBackupCommand",
"responses" : {
"201" : {
"content" : {
"application/json" : {
"examples" : {
"example" : {
"value" : "{\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"HISTORY_NOT_AVAILABLE\",\n \"roleStatus\" : \"BUSY\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : {\n \"clusterName\" : \"...\",\n \"displayName\" : \"...\"\n },\n \"serviceRef\" : {\n \"peerName\" : \"...\",\n \"clusterName\" : \"...\",\n \"clusterDisplayName\" : \"...\",\n \"serviceName\" : \"...\",\n \"serviceDisplayName\" : \"...\",\n \"serviceType\" : \"...\"\n },\n \"roleRef\" : {\n \"clusterName\" : \"...\",\n \"serviceName\" : \"...\",\n \"roleName\" : \"...\",\n \"healthSummary\" : \"GOOD\",\n \"roleStatus\" : \"STOPPING\"\n },\n \"hostRef\" : {\n \"hostId\" : \"...\",\n \"hostname\" : \"...\"\n },\n \"parent\" : { },\n \"children\" : {\n \"items\" : [ { }, { } ]\n },\n \"canRetry\" : true\n },\n \"children\" : {\n \"items\" : [ {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n }, {\n \"id\" : 12345,\n \"name\" : \"...\",\n \"startTime\" : \"...\",\n \"endTime\" : \"...\",\n \"active\" : true,\n \"success\" : true,\n \"resultMessage\" : \"...\",\n \"resultDataUrl\" : \"...\",\n \"clusterRef\" : { },\n \"serviceRef\" : { },\n \"roleRef\" : { },\n \"hostRef\" : { },\n \"parent\" : { },\n \"children\" : { },\n \"canRetry\" : true\n } ]\n },\n \"canRetry\" : true\n}"
}
},
"schema" : {
"$ref" : "#/components/schemas/ApiCommand"
}
}
},
"description" : "the created command instance"
}
},
"parameters" : [
{
"name" : "clusterName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : ""
},
{
"name" : "serviceName",
"in" : "path",
"required" : true,
"schema" : {
"type" : "string"
},
"description" : "A String representing the Solr service name."
}
]
}
},
"\/clusters/{clusterName}/services/{serviceName}/commands/solrMigrateSentryPrivilegesCommand" : {
"post" : {
"tags" : [ "ServicesResource" ],
"description" : "Migrates Sentry privileges to new model compatible to support\nmore granular permissions if Solr is configured with a\nSentry service.\n