Submit a Map-Reduce Compute Job
post
/bdcsce/api/v1.1/clustermgmt/{identityDomainId}/instances/{clusterId}/jobs/mapred
Request
Path Parameters
-
clusterId: string
Identifier for the Cluster
-
identityDomainId: string
Identity domain ID of the Oracle Cloud Service instance, used for authentication.
Definition of the Map-Reduce Job that you want to submit.
Nested Schema : YarnMapReduceJob
Type:
Show Source
object
-
amCores(optional):
object amCores
-
amEnv(optional):
object amEnv
Additional Properties Allowed: additionalProperties
-
amExtraJavaOptions(optional):
array amExtraJavaOptions
-
amMemory(optional):
object amMemory
-
amMemoryOverhead(optional):
object amMemoryOverhead
-
amNodeLabelExpression(optional):
string
-
applicationArguments(optional):
array applicationArguments
Arguments that need to be sent to the _Application Main_ or the _Application Script_.
-
applicationClass(optional):
string
Qualified name of the Class
-
applicationExtraLibraryPath(optional):
array applicationExtraLibraryPath
-
applicationFile:
string
The name of the file, script, or jar file that will be used to submit the Job.
-
applicationJarFiles(optional):
array applicationJarFiles
List of jars that will be downloaded and added to the classpath of the given Job.
-
applicationName:
string
The name given to the application, mainly used for UI or Audit Logs.
-
applicationSupportArchives(optional):
array applicationSupportArchives
-
applicationSupportFiles(optional):
array applicationSupportFiles
List of files that will be downloaded and collocated for the given Job.
-
applicationTags(optional):
array applicationTags
-
applicationType(optional):
string
Allowed Values:
[ "hive", "mapreduce", "spark", "tez", "yarn", "unkown" ]
-
attemptFailuresValidityInterval(optional):
object attemptFailuresValidityInterval
-
clusterId(optional):
string
The Cluster where the given Job is assigned to run.
-
containerMemory(optional):
object containerMemory
-
containerMemoryOverhead(optional):
object containerMemoryOverhead
-
env(optional):
object env
Additional Properties Allowed: additionalPropertiesMap of environment variable that should be available to the Job containers.
-
extraJavaOptions(optional):
array extraJavaOptions
A map of extra JVM options to pass to the mapper and reducer. For instance, GC settings or other logging.
-
hadoopConf(optional):
object hadoopConf
Additional Properties Allowed: additionalPropertiesMap of Hadoop configuration options that will be used to submit the Job.
-
id(optional):
string
Unique Identifier of this Job.
-
jobType(optional):
string
Allowed Values:
[ "batch", "streaming" ]
-
mapCPUVCores(optional):
object mapCPUVCores
-
mapMemoryMB(optional):
object mapMemoryMB
-
maxAppAttempts(optional):
object maxAppAttempts
-
maxJobDurationInSecs(optional):
object maxJobDurationInSecs
Maximum duration of a Job in seconds. When a Job exceeds the amount of time the Job will be terminated.
-
maxSubmissionLatencyInSecs(optional):
object maxSubmissionLatencyInSecs
The maximum waiting period that the requester is willing to wait for the job to actually start running inside a cluster before the Job is considered failed, REQUEST_TIMEOUT.
-
queue(optional):
string
Server queue used to submit too.
-
reduceCPUVCores(optional):
object reduceCPUVCores
-
reduceMemoryMB(optional):
object reduceMemoryMB
Nested Schema : amCores
Type:
object
Nested Schema : amMemory
Type:
object
Nested Schema : amMemoryOverhead
Type:
object
Nested Schema : applicationArguments
Type:
array
Arguments that need to be sent to the _Application Main_ or the _Application Script_.
Show Source
Nested Schema : applicationJarFiles
Type:
array
List of jars that will be downloaded and added to the classpath of the given Job.
Show Source
Nested Schema : applicationSupportFiles
Type:
array
List of files that will be downloaded and collocated for the given Job.
Show Source
Nested Schema : attemptFailuresValidityInterval
Type:
object
Nested Schema : containerMemory
Type:
object
Nested Schema : containerMemoryOverhead
Type:
object
Nested Schema : env
Type:
object
Additional Properties Allowed
Show Source
Map of environment variable that should be available to the Job containers.
Nested Schema : extraJavaOptions
Type:
array
A map of extra JVM options to pass to the mapper and reducer. For instance, GC settings or other logging.
Show Source
Nested Schema : hadoopConf
Type:
object
Additional Properties Allowed
Show Source
Map of Hadoop configuration options that will be used to submit the Job.
Nested Schema : mapCPUVCores
Type:
object
Nested Schema : mapMemoryMB
Type:
object
Nested Schema : maxAppAttempts
Type:
object
Nested Schema : maxJobDurationInSecs
Type:
object
Maximum duration of a Job in seconds. When a Job exceeds the amount of time the Job will be terminated.
Nested Schema : maxSubmissionLatencyInSecs
Type:
object
The maximum waiting period that the requester is willing to wait for the job to actually start running inside a cluster before the Job is considered failed, REQUEST_TIMEOUT.
Nested Schema : reduceCPUVCores
Type:
object
Nested Schema : reduceMemoryMB
Type:
object
Security
-
basicAuth: basic
Type:
basic
Response
200 Response
Root Schema : AsyncJobStatus
Type:
Show Source
object
-
aggregatedLogs(optional):
object JobAggregatedLogs
-
aggregatedStoredLogs(optional):
object JobAggregatedStoredLogs
-
allocatedMB(optional):
integer(int32)
Sum of memory in MB allocated to the job's running containers.
-
allocatedOCores(optional):
object allocatedOCores
Read Only:
true
Sum of virtual cores allocated to the job???s running containers. -
allocatedVCores(optional):
integer(int32)
Sum of virtual cores allocated to the job's running containers.
-
applicationTags(optional):
array applicationTags
A collection of tags or labels associated with this job.
-
applicationType(optional):
string
Allowed Values:
[ "hive", "mapreduce", "spark", "tez", "yarn", "unkown" ]
The kind of application that this job represents. -
completed(optional):
object completed
Read Only:
true
Specifies whether the job has been completed. It can be used to determine whether the client needs to keep polling the -progress- status. -
completedPercentage(optional):
integer(int32)
A value between 0 and 100 that specifies the percentage that the job is complete.
-
connectors(optional):
array connectors
Connecting interfaces that this Job offers. An example of this connector will be the Spark UI.
-
containerLogs(optional):
array containerLogs
Location of log file(s) for a running job.
-
displayName(optional):
string
Read Only:
true
-
elapsedTime(optional):
integer(int64)
Time since the job started (in ms)
-
endTime(optional):
string(date-time)
Read Only:
true
Specifies the time at which the job has ended. This property is available only after a job has ended. -
endTimeMillis(optional):
integer(int64)
Time in which job ended (in ms since epoch)
-
error(optional):
object Error
-
id(optional):
string
Read Only:
true
Unique Job Identifier -
intervalToPoll(optional):
integer(int64)
Specifies the number of milliseconds to wait before rechecking the status of a job.
-
jobType(optional):
string
Read Only:
true
-
links(optional):
array links
Hyperlinks to other associated resources.
-
memorySeconds(optional):
integer(int64)
The amount of memory the job has allocated
-
message(optional):
string
Human-readable message that describes the current processing status.
-
name(optional):
string
Name of the Job, used for visual identification. It is not unique.
-
nameAlias(optional):
string
Read Only:
true
-
progress(optional):
string
Allowed Values:
[ "aborted", "aborting", "accepted", "failed", "paused", "pending", "processing", "succeeded", "undefined" ]
Current progress of the Job. -
queue(optional):
string
Job Queue where this job was scheduled to run.
-
runningContainers(optional):
integer(int32)
Number of containers currently running for the job.
-
sessionType(optional):
string
Read Only:
true
-
snapshotTime(optional):
integer(int64)
-
startTime(optional):
string(date-time)
Read Only:
true
Specifies the time at which the job started. -
startTimeMillis(optional):
integer(int64)
Time in which job started (in ms since epoch)
-
vcoreSeconds(optional):
integer(int64)
The amount of CPU resources the job has allocated
Nested Schema : allocatedOCores
Type:
object
Read Only:
true
Sum of virtual cores allocated to the job???s running containers.
Nested Schema : applicationTags
Type:
array
A collection of tags or labels associated with this job.
Show Source
Nested Schema : completed
Type:
object
Read Only:
true
Specifies whether the job has been completed. It can be used to determine whether the client needs to keep polling the -progress- status.
Nested Schema : connectors
Type:
array
Connecting interfaces that this Job offers. An example of this connector will be the Spark UI.
Show Source
Nested Schema : Error
Type:
Show Source
object
-
detail(optional):
string
detail
-
instance(optional):
string
instance
-
o:errorCode(optional):
string
Read Only:
true
error code -
o:errorDetails(optional):
array o:errorDetails
Read Only:
true
error details -
o:errorPath(optional):
string
Read Only:
true
error path -
status:
integer(int32)
status
-
title:
string
title
-
type(optional):
string
Read Only:
true
RFC Link
Nested Schema : JobConnectorReference
Type:
Show Source
object
-
description:
string
The description of the interface.
-
name:
string
The name of the interface. e.g. Spark UI
-
rel:
string(uri)
Related uri
-
type(optional):
string
Read Only:
true
The media type to apply to the URI -
uris:
array uris
The URI of the linked resource
Nested Schema : JobConnectorResourceIdentifier
Type:
Show Source
object
-
description:
string
The description of the interface.
-
id:
string
The id of the interface. e.g. 1
-
uri:
string(uri)
The URI of the linked resource
Nested Schema : JobContainerLogs
Type:
Show Source
object
-
containerId:
string
Unique Identifier of the Container that is generating the Log.
-
files:
array files
Log files with path relative to the Container.
Nested Schema : ModelLink
Type:
Show Source
object
-
href:
string
The URI of the linked resource
-
mediaType(optional):
string
The media type to apply to the URI
-
method(optional):
string
The method to apply to the URI
-
profile(optional):
string
The profile
-
rel:
string
Relation link
-
templated(optional):
object templated
Is the URI a template
Nested Schema : templated
Type:
object
Is the URI a template
400 Response
List of errors related to the request.
404 Response
The Compute Job was not found.
500 Response
An internal error occurred.
Root Schema : Error
Type:
Show Source
object
-
detail(optional):
string
detail
-
instance(optional):
string
instance
-
o:errorCode(optional):
string
Read Only:
true
error code -
o:errorDetails(optional):
array o:errorDetails
Read Only:
true
error details -
o:errorPath(optional):
string
Read Only:
true
error path -
status:
integer(int32)
status
-
title:
string
title
-
type(optional):
string
Read Only:
true
RFC Link