OpenAPI Specification
openapi: 3.0.3
info:
title: Apache HBase REST Regions API
version: 1.0.0
description: REST API (Stargate) for Apache HBase distributed NoSQL database, providing table management, row and cell operations, and table scanning via HTTP.
contact:
email: dev@hbase.apache.org
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: http://localhost:8080
description: HBase REST Gateway (Stargate)
tags:
- name: Regions
description: Region information
paths:
/{tableName}/regions:
get:
operationId: getTableRegions
summary: Apache HBase Get Table Regions
description: Get region information for an HBase table including server assignments and key ranges.
tags:
- Regions
parameters:
- name: tableName
in: path
required: true
schema:
type: string
responses:
'200':
description: Regions retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/TableRegions'
components:
schemas:
TableRegions:
type: object
description: Region layout for an HBase table
properties:
name:
type: string
description: Table name
example: my-table
Region:
type: array
description: List of regions
items:
type: object
properties:
id:
type: integer
format: int64
description: Region ID
example: 1718153645993
startKey:
type: string
description: Region start key
example: ''
endKey:
type: string
description: Region end key
example: row500
location:
type: string
description: RegionServer hostname:port
example: regionserver1:16020
name:
type: string
description: Region name
example: my-table,,1718153645993.abc123.