openapi: 3.0.3 info: title: Apache Hadoop REST APIs description: >- Aggregated OpenAPI definition for the public REST APIs exposed by Apache Hadoop. Includes WebHDFS for filesystem operations and the YARN ResourceManager for cluster, application, and node management. version: stable contact: name: Apache Hadoop url: https://hadoop.apache.org/ license: name: Apache License 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 servers: - url: http://{host}:{port} description: Hadoop service host variables: host: default: localhost port: default: '50070' tags: - name: WebHDFS description: HDFS filesystem REST operations under /webhdfs/v1. - name: YARN Cluster description: Cluster information and metrics. - name: YARN Applications description: Application listing, submission, and lifecycle. - name: YARN Nodes description: Cluster node listing and resource updates. paths: /webhdfs/v1/{path}: get: summary: WebHDFS GET operations description: >- File or directory operations selected by the `op` query parameter: OPEN, GETFILESTATUS, LISTSTATUS, LISTSTATUS_BATCH, GETCONTENTSUMMARY, GETFILECHECKSUM, GETHOMEDIRECTORY, GETXATTRS, GETACLSTATUS. operationId: webhdfsGet tags: - WebHDFS parameters: - name: path in: path required: true schema: type: string - name: op in: query required: true schema: type: string enum: - OPEN - GETFILESTATUS - LISTSTATUS - LISTSTATUS_BATCH - GETCONTENTSUMMARY - GETFILECHECKSUM - GETHOMEDIRECTORY - GETXATTRS - GETACLSTATUS responses: '200': description: Operation result put: summary: WebHDFS PUT operations description: >- Mutation operations selected by `op`: CREATE, MKDIRS, RENAME, SETPERMISSION, SETOWNER, SETREPLICATION, SETXATTR, SETACL. operationId: webhdfsPut tags: - WebHDFS parameters: - name: path in: path required: true schema: type: string - name: op in: query required: true schema: type: string enum: - CREATE - MKDIRS - RENAME - SETPERMISSION - SETOWNER - SETREPLICATION - SETXATTR - SETACL responses: '200': description: Operation result post: summary: WebHDFS POST operations description: APPEND, CONCAT, or TRUNCATE selected by `op`. operationId: webhdfsPost tags: - WebHDFS parameters: - name: path in: path required: true schema: type: string - name: op in: query required: true schema: type: string enum: - APPEND - CONCAT - TRUNCATE responses: '200': description: Operation result delete: summary: WebHDFS DELETE description: Delete a file or directory. operationId: webhdfsDelete tags: - WebHDFS parameters: - name: path in: path required: true schema: type: string - name: op in: query required: true schema: type: string enum: - DELETE responses: '200': description: Deletion result /ws/v1/cluster/info: get: summary: Cluster info operationId: getClusterInfo tags: - YARN Cluster responses: '200': description: Cluster info /ws/v1/cluster/metrics: get: summary: Cluster metrics operationId: getClusterMetrics tags: - YARN Cluster responses: '200': description: Cluster metrics /ws/v1/cluster/scheduler: get: summary: Scheduler info operationId: getScheduler tags: - YARN Cluster responses: '200': description: Scheduler details /ws/v1/cluster/apps: get: summary: List applications operationId: listApps tags: - YARN Applications parameters: - name: state in: query schema: type: string - name: user in: query schema: type: string - name: queue in: query schema: type: string responses: '200': description: Applications list post: summary: Submit a new application operationId: submitApp tags: - YARN Applications responses: '202': description: Submitted /ws/v1/cluster/apps/{appid}: get: summary: Application details operationId: getApp tags: - YARN Applications parameters: - name: appid in: path required: true schema: type: string responses: '200': description: Application details /ws/v1/cluster/apps/{appid}/state: put: summary: Update application state operationId: updateAppState tags: - YARN Applications parameters: - name: appid in: path required: true schema: type: string responses: '200': description: State updated /ws/v1/cluster/apps/{appid}/queue: put: summary: Move application to a different queue operationId: updateAppQueue tags: - YARN Applications parameters: - name: appid in: path required: true schema: type: string responses: '200': description: Queue updated /ws/v1/cluster/apps/{appid}/priority: put: summary: Update application priority operationId: updateAppPriority tags: - YARN Applications parameters: - name: appid in: path required: true schema: type: string responses: '200': description: Priority updated /ws/v1/cluster/apps/{appid}/appattempts: get: summary: List application attempts operationId: listAppAttempts tags: - YARN Applications parameters: - name: appid in: path required: true schema: type: string responses: '200': description: Application attempts /ws/v1/cluster/nodes: get: summary: List nodes operationId: listNodes tags: - YARN Nodes responses: '200': description: Node list /ws/v1/cluster/nodes/{nodeid}: get: summary: Node details operationId: getNode tags: - YARN Nodes parameters: - name: nodeid in: path required: true schema: type: string responses: '200': description: Node details /ws/v1/cluster/appstatistics: get: summary: Application statistics operationId: getAppStatistics tags: - YARN Applications responses: '200': description: Application statistics by type and state components: schemas: {}