Use GetDoctorHBaseTable to retrieve HBase table metrics and diagnostics - E-MapReduce

Get HBase Table information.

Operation description

get Doctor HBaseTable

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

emr:GetDoctorHBaseTable

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	Region ID.	cn-hangzhou
ClusterId	string	Yes	Cluster ID.	c-b933c5aac8fe****
DateTime	string	Yes	Date.	2023-01-01
TableName	string	Yes	Table name.	namespace1:tb_item

Response elements

Element	Type	Description	Example
	object	Returned data
Data	object	Returned data.
Metrics	object	Metrics information.
RegionServerCount	object	Number of RegionServers.
Name	string	Metric name.	regionServerCount
Value	integer	Usage.	10
Unit	string	Metric unit.	“”
Description	string	Metric description.	Number of region servers count
RegionCount	object	Number of regions.
Name	string	Metric name.	regionCount
Value	integer	Metric value.	10
Unit	string	Metric unit.	""
Description	string	Metric description.	Number of regions count
TableSize	object	Table size.
Name	string	Metric name.	tableSize
Value	integer	Metric value.	tb_item
Unit	string	Unit of the metric	""
Description	string	Description of the metric.	Size of the table
StoreFileCount	object	Number of store files.
Name	string	Name of the metric.	storeFileCount
Value	integer	Value of the metric.	1000
Unit	string	Unit of the metric.	""
Description	string	Description of the metric.	Number of store files
DailyReadRequest	object	Number of read requests per day.
Name	string	Name of the item.	dailyReadRequest
Value	integer	Value of the metric.	1000
Unit	string	Unit of the metric.	""
Description	string	Description of the metric.	test-update
DailyWriteRequest	object	Number of write requests per day.
Name	string	Name of the metric.	dailyWriteRequest
Value	integer	Value of the metric.	1000
Unit	string	Unit of the metric.	""
Description	string	Description of the metric.	Number of write requests per day
RegionBalance	object	Region balance.
Name	string	Metric name.	regionBalance
Value	number	The metric value.	1.0
Unit	string	The unit of the metric.	""
Description	string	Description of the metric.	The ability to evenly distribute Regions on different RegionServer nodes
RequestBalance	object	Request balance.
Name	string	Name of the metric.	requestBalance
Value	number	The metric value.	1.0
Unit	string	The unit of the metric.	""
Description	string	Description of the metric.	The balance of distributing requests
HotDataSize	object	Hot data size.
Name	string	Name of the metric.	hotDataSize
Value	integer	The metric value.	1000
Unit	string	The unit of the metric.	MB
Description	string	Description of the metric.	Size of the hot data size
WarmDataSize	object	Warm data size.
Name	string	Name of the metric.	warmDataSize
Value	integer	Usage rate.	1000
Unit	string	The unit of the metric.	MB
Description	string	Description of the metric.	Size of the warm data size
ColdDataSize	object	Cold data size.
Name	string	Metric name.	coldDataSize
Value	integer	Metric value.	1000
Unit	string	Metric unit.	""
Description	string	Metric description.	Size of the cold data size
FreezeDataSize	object	Frozen data size.
Name	string	Metric name.	freezeDataSize
Value	integer	Metric value.	1000
Unit	string	Metric unit.	MB
Description	string	Metric description.	Size of the freeze data size
WarmConfigDay	object	Warm data access days configuration.
Name	string	Metric name.	warmConfigDay
Value	integer	Metric value.	1000
Unit	string	Metric unit.	MB
Description	string	Metric description.	Size of the warm data size
ColdConfigDay	object	Cold data access days configuration.
Name	string	Metric name.	coldConfigDay
Value	integer	Metric value.	10
Unit	string	Unit of the metric.	day
Description	string	Description of the metric.	Cold config day
FreezeConfigDay	object	Configuration for the number of days cold data is accessed.
Name	string	Name of the metric.	freezeConfigDay
Value	integer	Value of the metric.	10
Unit	string	Unit of the metric.	day
Description	string	Description of the metric.	Freeze config day
Locality	object	Locality rate.
Name	string	Name of the metric.	locality
Value	number	Value of the metric.	0.5
Unit	string	Unit of the metric.	""
Description	string	Description of the metric.	The locality of data
ColdAccessDay	object	Number of days the table has not been accessed.
Name	string	Name of the metric.	coldAccessDay
Value	integer	Value of the metric.	3
Unit	string	Unit of the metric.	day
Description	string	Description of the metric.	Cold access day
RegionCountDayGrowthRatio	object	Daily incremental ratio of regions
Name	string	Metric name.	regionCountDayGrowthRatio
Value	number	Metric value.	0.8
Unit	string	Metric unit.	""
Description	string	Metric description.	Day growth ratio of region count
TableSizeDayGrowthRatio	object	Daily growth ratio of table size.
Name	string	Metric name.	tableSizeDayGrowthRatio
Value	number	Metric value.	1.5
Unit	string	Metric unit.	""
Description	string	Metric description.	Day growth ratio of table size
StoreFileCountDayGrowthRatio	object	Daily growth ratio of store file count.
Name	string	Metric name.	storeFileCountDayGrowthRatio
Value	number	Metric value.	1.5
Unit	string	Metric unit.	""
Description	string	Metric description.	Day growth ratio of store file count
DailyReadRequestDayGrowthRatio	object	Daily growth ratio of daily read requests.
Name	string	Metric name.	dailyReadRequestDayGrowthRatio
Value	number	The value of the metric.	1.5
Unit	string	The unit of the metric.	""
Description	string	Description of the metric.	Day growth ratio of table size
DailyWriteRequestDayGrowthRatio	object	Daily write request growth ratio.
Name	string	Name of the metric.	dailyWriteRequestDayGrowthRatio
Value	number	The value of the metric.	0.5
Unit	string	The unit of the metric.	""
Description	string	Description of the metric.	The balance of distributing requests
ReadRequestBalance	object	Read request balance.
Name	string	Name of the metric.	readRequestBalance
Value	number	The value of the metric.	0.5
Unit	string	The unit of the metric.	""
Description	string	Description of the metric.	The balance of distributing read requests
WriteRequestBalance	object	Write request balance.
Name	string	Name of the metric.	writeRequestBalance
Value	number	The value of the metric.	0.5
Unit	string	Unit of the metric.	""
Description	string	Description of the metric.	The balance of distributing write requests
Analysis	object	Diagnostic results.
TableScore	integer	Table score.	85
RequestUnbalanceSuggestion	string	Description of read/write imbalance.	read request unbalance is Total number of table regions: 14,Average read requests per region: 5032486,The following regions have read request hotspots: RegionServer: emr-worker-4 Region Id: 4ac818a3ab3fd727490a5b4d4dac7667 Read requests: 15485664 RegionServer: emr-worker-2 Region Id: 021b387ae92959def65041e25eade3aa Read requests: 7731980 RegionServer: emr-worker-2 Region Id: d58f33abfe857e5fd0045eaa31c93df8 Read requests: 7705237 RegionServer: emr-worker-2 Region Id: 4ca84757a7d0948b8552cfeebefa25a9 Read requests: 7703492 RegionServer: emr-worker-4 Region Id: 1018192dae42995fc75c6d5b5981a9b7 Read requests: 7695284
RequestHotspotRegionList	array	List of read/write hotspot regions.	null
	string	Read/write hotspot region.	5f019e8cf7c16be9768634cb99ccbe05
ReadRequestUnbalanceSuggestion	string	Description of read imbalance.	read request unbalance is Total number of table regions: 14,Average read requests per region: 5032486,The following regions have read request hotspots: RegionServer: emr-worker-4 Region Id: 4ac818a3ab3fd727490a5b4d4dac7667 Read requests: 15485664 RegionServer: emr-worker-2 Region Id: 021b387ae92959def65041e25eade3aa Read requests: 7731980 RegionServer: emr-worker-2 Region Id: d58f33abfe857e5fd0045eaa31c93df8 Read requests: 7705237 RegionServer: emr-worker-2 Region Id: 4ca84757a7d0948b8552cfeebefa25a9 Read requests: 7703492 RegionServer: emr-worker-4 Region Id: 1018192dae42995fc75c6d5b5981a9b7 Read requests: 7695284
ReadRequestHotspotRegionList	array	List of read hotspot regions.	null
	string	Read hotspot region.	5f019e8cf7c16be9768634cb99ccbe05
WriteRequestUnbalanceSuggestion	string	Description of write imbalance.	write request unbalance is Total number of table regions: 15,Average write requests per region: 769954,The following regions have write request hotspots: RegionServer: emr-worker-2 Region Id: 4a938c08750869c47b7a92edeeec2ccc Write requests: 2115051 RegionServer: emr-worker-2 Region Id: b4d21974df92bdf3589e63e4da1fc923 Write requests: 1592509 RegionServer: emr-worker-2 Region Id: 25eb6717470f4ddbabe9187ff0fc0cb3 Write requests: 1585420
WriteRequestHotspotRegionList	array	List of write hotspot regions.	null
	string	Write hotspot region.	5f019e8cf7c16be9768634cb99ccbe05
RequestId	string	Request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****

Examples

Success response

JSON format

{
  "Data": {
    "Metrics": {
      "RegionServerCount": {
        "Name": "regionServerCount",
        "Value": 10,
        "Unit": "“”",
        "Description": "Number of region servers count"
      },
      "RegionCount": {
        "Name": "regionCount",
        "Value": 10,
        "Unit": "\"\"",
        "Description": "Number of regions count"
      },
      "TableSize": {
        "Name": "tableSize",
        "Value": 0,
        "Unit": "\"\"",
        "Description": "Size of the table"
      },
      "StoreFileCount": {
        "Name": "storeFileCount",
        "Value": 1000,
        "Unit": "\"\"",
        "Description": "Number of store files"
      },
      "DailyReadRequest": {
        "Name": "dailyReadRequest",
        "Value": 1000,
        "Unit": "\"\"",
        "Description": "test-update"
      },
      "DailyWriteRequest": {
        "Name": "dailyWriteRequest",
        "Value": 1000,
        "Unit": "\"\"",
        "Description": "Number of write requests per day"
      },
      "RegionBalance": {
        "Name": "regionBalance",
        "Value": 1,
        "Unit": "\"\"",
        "Description": "The ability to evenly distribute Regions on different RegionServer nodes"
      },
      "RequestBalance": {
        "Name": "requestBalance",
        "Value": 1,
        "Unit": "\"\"",
        "Description": "The balance of distributing requests"
      },
      "HotDataSize": {
        "Name": "hotDataSize",
        "Value": 1000,
        "Unit": "MB",
        "Description": "Size of the hot data size"
      },
      "WarmDataSize": {
        "Name": "warmDataSize",
        "Value": 1000,
        "Unit": "MB",
        "Description": "Size of the warm data size\n"
      },
      "ColdDataSize": {
        "Name": "coldDataSize",
        "Value": 1000,
        "Unit": "\"\"",
        "Description": "Size of the cold data size"
      },
      "FreezeDataSize": {
        "Name": "freezeDataSize",
        "Value": 1000,
        "Unit": "MB",
        "Description": "Size of the freeze data size"
      },
      "WarmConfigDay": {
        "Name": "warmConfigDay",
        "Value": 1000,
        "Unit": "MB",
        "Description": "Size of the warm data size"
      },
      "ColdConfigDay": {
        "Name": "coldConfigDay",
        "Value": 10,
        "Unit": "day",
        "Description": "Cold config day"
      },
      "FreezeConfigDay": {
        "Name": "freezeConfigDay",
        "Value": 10,
        "Unit": "day",
        "Description": "Freeze config day\n"
      },
      "Locality": {
        "Name": "locality",
        "Value": 0.5,
        "Unit": "\"\"",
        "Description": "The locality of data"
      },
      "ColdAccessDay": {
        "Name": "coldAccessDay",
        "Value": 3,
        "Unit": "day",
        "Description": "Cold access day"
      },
      "RegionCountDayGrowthRatio": {
        "Name": "regionCountDayGrowthRatio",
        "Value": 0.8,
        "Unit": "\"\"",
        "Description": "Day growth ratio of region count"
      },
      "TableSizeDayGrowthRatio": {
        "Name": "tableSizeDayGrowthRatio",
        "Value": 1.5,
        "Unit": "\"\"",
        "Description": "Day growth ratio of table size"
      },
      "StoreFileCountDayGrowthRatio": {
        "Name": "storeFileCountDayGrowthRatio",
        "Value": 1.5,
        "Unit": "\"\"",
        "Description": "Day growth ratio of store file count"
      },
      "DailyReadRequestDayGrowthRatio": {
        "Name": "dailyReadRequestDayGrowthRatio",
        "Value": 1.5,
        "Unit": "\"\"",
        "Description": "Day growth ratio of table size"
      },
      "DailyWriteRequestDayGrowthRatio": {
        "Name": "dailyWriteRequestDayGrowthRatio",
        "Value": 0.5,
        "Unit": "\"\"",
        "Description": "The balance of distributing requests"
      },
      "ReadRequestBalance": {
        "Name": "readRequestBalance",
        "Value": 0.5,
        "Unit": "\"\"",
        "Description": "The balance of distributing read requests"
      },
      "WriteRequestBalance": {
        "Name": "writeRequestBalance",
        "Value": 0.5,
        "Unit": "\"\"",
        "Description": "The balance of distributing write requests"
      }
    },
    "Analysis": {
      "TableScore": 85,
      "RequestUnbalanceSuggestion": "read request unbalance is 
Total number of table regions: 14,Average read requests per region: 5032486,The following regions have read request hotspots:
RegionServer: emr-worker-4 Region Id: 4ac818a3ab3fd727490a5b4d4dac7667 Read requests: 15485664
RegionServer: emr-worker-2 Region Id: 021b387ae92959def65041e25eade3aa Read requests: 7731980
RegionServer: emr-worker-2 Region Id: d58f33abfe857e5fd0045eaa31c93df8 Read requests: 7705237
RegionServer: emr-worker-2 Region Id: 4ca84757a7d0948b8552cfeebefa25a9 Read requests: 7703492
RegionServer: emr-worker-4 Region Id: 1018192dae42995fc75c6d5b5981a9b7 Read requests: 7695284
 ",
      "RequestHotspotRegionList": [
        "5f019e8cf7c16be9768634cb99ccbe05"
      ],
      "ReadRequestUnbalanceSuggestion": "read request unbalance is 
Total number of table regions: 14,Average read requests per region: 5032486,The following regions have read request hotspots:
RegionServer: emr-worker-4 Region Id: 4ac818a3ab3fd727490a5b4d4dac7667 Read requests: 15485664
RegionServer: emr-worker-2 Region Id: 021b387ae92959def65041e25eade3aa Read requests: 7731980
RegionServer: emr-worker-2 Region Id: d58f33abfe857e5fd0045eaa31c93df8 Read requests: 7705237
RegionServer: emr-worker-2 Region Id: 4ca84757a7d0948b8552cfeebefa25a9 Read requests: 7703492
RegionServer: emr-worker-4 Region Id: 1018192dae42995fc75c6d5b5981a9b7 Read requests: 7695284
 ",
      "ReadRequestHotspotRegionList": [
        "5f019e8cf7c16be9768634cb99ccbe05"
      ],
      "WriteRequestUnbalanceSuggestion": "write request unbalance is 
Total number of table regions: 15,Average write requests per region: 769954,The following regions have write request hotspots:
RegionServer: emr-worker-2 Region Id: 4a938c08750869c47b7a92edeeec2ccc Write requests: 2115051
RegionServer: emr-worker-2 Region Id: b4d21974df92bdf3589e63e4da1fc923 Write requests: 1592509
RegionServer: emr-worker-2 Region Id: 25eb6717470f4ddbabe9187ff0fc0cb3 Write requests: 1585420
 ",
      "WriteRequestHotspotRegionList": [
        "5f019e8cf7c16be9768634cb99ccbe05"
      ]
    }
  },
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}

Error codes

HTTP status code	Error code	Error message
400	ConflictParameters	Parameters that must not be used together. %s
400	IncompleteSignature	The request signature is invalid.
400	InvalidAction	The action %s requested is invalid.
400	InvalidParameter	The specified parameter %s is not valid.
400	InvalidParameterValue	The input parameter %s is invalid or out of range.
400	MissingAction	The action %s requested is missing.
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
400	NotAuthorized	You do not have permission to perform this action. %s
400	ThrottlingException	The request was denied due to request throttling. %s
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
404	ResourceNotFound	The resource not found by %s.
503	ServiceFailure	The request has failed due to a temporary failure of %s service.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.