Use ListDoctorHBaseTables to query diagnostic information for HBase tables - E-MapReduce

Obtains the information about multiple HBase tables at a time.

Operation description

list Doctor HBaseTables

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:ListDoctorHBaseTables

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region.	cn-hangzhou
ClusterId	string	Yes	The ID of the cluster.	c-b933c5aac8fe****
NextToken	string	No	Marks the current position to start reading. If this field is empty, the data is read from the beginning.	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	No	The maximum number of entries that are returned.	20
DateTime	string	Yes	The query date.	2023-01-01
TableNames	array	No	The table names, which are used to filter the query results.	null
	string	No	The table names.	namespace1:tb_item
OrderType	string	No	The order in which you want to sort the query results. Valid value: ASC: in ascending order DESC: in descending order	ASC
OrderBy	string	No	The field that you use to sort the query results. Valid values: tableSize	tableSize

Response elements

Element	Type	Description	Example
	object	The response parameters.
Data	array<object>	The data returned.
	array<object>
TableName	string	The name of the table.	tb_item
Metrics	object	The metric information.
RegionServerCount	object	The number of region servers that host the table.
Name	string	The name of the metric.	regionServerCount
Value	integer	The value of the metric.	2
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Number of region servers count
RegionCount	object	The number of regions that host the table.
Name	string	The name of the metric.	regionCount
Value	integer	The value of the metric.	3
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Number of regions count
TableSize	object	The size of the table.
Name	string	The name of the metric.	tableSize
Value	integer	The value of the metric.	678
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Size of the table
StoreFileCount	object	The number of StoreFiles.
Name	string	The name of the metric.	storeFileCount
Value	integer	The value of the metric.	36
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Number of store files
DailyReadRequest	object	The total number of read requests for the table in a day.
Name	string	The name of the metric.	dailyReadRequest
Value	integer	The value of the metric.	1000
Unit	string	The unit of the metric.	“”
Description	string	The description of the metric.	Number of read requests per day
DailyWriteRequest	object	The total number of write requests for the table in a day.
Name	string	The name of the metric.	dailyWriteRequest
Value	integer	The value of the metric.	1000
Unit	string	The unit of the metric.	“”
Description	string	The description of the metric.	Number of write requests per day
RegionBalance	object	The balancing degree.
Name	string	The name of the metric.	regionBalance
Value	number	The value of the metric.	1.0
Unit	string	The unit of the metric.	“”
Description	string	The description of the metric.	The ability to evenly distribute Regions on different RegionServer nodes
RequestBalance	object	The request balancing degree.
Name	string	The name of the metric.	requestBalance
Value	number	The value of the metric.	0.9
Unit	string	The unit of the metric.	“”
Description	string	The description of the metric.	The balance of distributing requests
HotDataSize	object	The size of hot data.
Name	string	The name of the metric.	hotDataSize
Value	integer	The value of the metric.	100
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Size of the hot data size
WarmDataSize	object	The size of warm data.
Name	string	The name of the metric.	warmDataSize
Value	integer	The value of the metric.	100
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Size of the warm data size
ColdDataSize	object	The size of cold data.
Name	string	The name of the metric.	coldDataSize
Value	integer	The value of the metric.	100
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Size of the cold data size
FreezeDataSize	object	The size of very cold data.
Name	string	The name of the metric.	freezeDataSize
Value	integer	The value of the metric.	100
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Size of the freeze data size
WarmConfigDay	object	The number of consecutive days without access to data before the data is considered as cold data.
Name	string	The name of the metric.	warmConfigDay
Value	integer	The value of the metric.	1
Unit	string	The unit of the metric.	day
Description	string	The description of the metric.	Warm config day
ColdConfigDay	object	The number of consecutive days without access to data before the data is considered as very cold data.
Name	string	The name of the metric.	coldConfigDay
Value	integer	The value of the metric.	1
Unit	string	The unit of the metric.	day
Description	string	The description of the metric.	Cold config day
FreezeConfigDay	object	The number of consecutive days without access to data before the data was considered as very cold data.
Name	string	The name of the metric.	freezeConfigDay
Value	integer	The value of the metric.	1
Unit	string	The unit of the metric.	day
Description	string	The description of the metric.	Freeze config day
Locality	object	The localization rate.
Name	string	The name of the metric.	locality
Value	number	The value of the metric.	0
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	The locality of data
ColdAccessDay	object	The number of days during which the table was not accessed.
Name	string	The name of the metric.	coldAccessDay
Value	integer	The value of the metric.	1
Unit	string	The unit of the metric.	day
Description	string	The description of the metric.	Cold access day
RegionCountDayGrowthRatio	object	The daily increment ratio of the number of regions.
Name	string	The name of the metric.	regionCountDayGrowthRatio
Value	number	The value of the metric.	1.0
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Day growth ratio of region count
TableSizeDayGrowthRatio	object	The daily increment ratio of the table size.
Name	string	The name of the metric.	tableSizeDayGrowthRatio
Value	number	The value of the metric.	1.0
Unit	string	The unit of the metric.	'"
Description	string	The description of the metric.	Day growth ratio of table size
StoreFileCountDayGrowthRatio	object	The daily increment ratio of the number of StoreFiles.
Name	string	The name of the metric.	storeFileCountDayGrowthRatio
Value	number	The value of the metric.	0.7
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Day growth ratio of store file count
DailyReadRequestDayGrowthRatio	object	The daily increment ratio of the number of read requests in a day.
Name	string	The name of the metric.	dailyReadRequestDayGrowthRatio
Value	number	The value of the metric.	0.8
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Day growth ratio of read requests
DailyWriteRequestDayGrowthRatio	object	The daily increment ratio of the number of write requests in a day.
Name	string	The name of the metric.	dailyWriteRequestDayGrowthRatio
Value	number	The value of the metric.	0.8
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	The balance of distributing requests
ReadRequestBalance	object	The read balancing degree.
Name	string	The name of the metric.	readRequestBalance
Value	number	The value of the metric.	1.0
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	The balance of distributing read requests
WriteRequestBalance	object	The write balancing degree.
Name	string	The name of the metric.	writeRequestBalance
Value	number	The value of the metric.	1.0
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	The balance of distributing write requests
Analysis	object	The diagnosis result.
TableScore	integer	The score of the table.	67
RequestUnbalanceSuggestion	string	The description of read/write imbalance.	ead request unbalance is Total number of table regions: 15,Average read requests per region: 764361,The following regions have read request hotspots: RegionServer: emr-worker-2 Region Id: f1c922d41529785e21b61cf4c672b98a Read requests: 1543919 RegionServer: emr-worker-2 Region Id: 5f019e8cf7c16be9768634cb99ccbe05 Read requests: 1512817 RegionServer: emr-worker-2 Region Id: d113992fea3a457f60b8b8aa5d6fa037 Read requests: 1504293
RequestHotspotRegionList	array	The regions that have read/write hotspot issues.	null
	string	The region that has read/write hotspot issues.	5f019e8cf7c16be9768634cb99ccbe05
ReadRequestUnbalanceSuggestion	string	The description of read imbalance.	ead request unbalance is Total number of table regions: 15,Average read requests per region: 764361,The following regions have read request hotspots: RegionServer: emr-worker-2 Region Id: f1c922d41529785e21b61cf4c672b98a Read requests: 1543919 RegionServer: emr-worker-2 Region Id: 5f019e8cf7c16be9768634cb99ccbe05 Read requests: 1512817 RegionServer: emr-worker-2 Region Id: d113992fea3a457f60b8b8aa5d6fa037 Read requests: 1504293
ReadRequestHotspotRegionList	array	The regions that have read hotspot issues.	null
	string	The region that has read hotspot issues.	5f019e8cf7c16be9768634cb99ccbe05
WriteRequestUnbalanceSuggestion	string	The description of write imbalance.	write request unbalance is Total number of table regions: 15,Average write requests per region: 786142,The following regions have write request hotspots: RegionServer: emr-worker-2 Region Id: f1c922d41529785e21b61cf4c672b98a Write requests: 1588305 RegionServer: emr-worker-2 Region Id: 5f019e8cf7c16be9768634cb99ccbe05 Write requests: 1556984 RegionServer: emr-worker-2 Region Id: d113992fea3a457f60b8b8aa5d6fa037 Write requests: 1548764
WriteRequestHotspotRegionList	array	The regions that have write hotspot issues.	null
	string	The region that has write hotspot issues.	5f019e8cf7c16be9768634cb99ccbe05
RequestId	string	The ID of the request.	DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextToken	string	The page number of the next page returned.	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	The maximum number of entries returned.	20
TotalCount	integer	The total number of entries returned.	200

Examples

Success response

JSON format

{
  "Data": [
    {
      "TableName": "tb_item",
      "Metrics": {
        "RegionServerCount": {
          "Name": "regionServerCount",
          "Value": 2,
          "Unit": "\"\"",
          "Description": "Number of region servers count"
        },
        "RegionCount": {
          "Name": "regionCount",
          "Value": 3,
          "Unit": "\"\"",
          "Description": "Number of regions count"
        },
        "TableSize": {
          "Name": "tableSize",
          "Value": 678,
          "Unit": "MB",
          "Description": "Size of the table"
        },
        "StoreFileCount": {
          "Name": "storeFileCount",
          "Value": 36,
          "Unit": "\"\"",
          "Description": "Number of store files"
        },
        "DailyReadRequest": {
          "Name": "dailyReadRequest",
          "Value": 1000,
          "Unit": "“”",
          "Description": "Number of read requests per day"
        },
        "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": 0.9,
          "Unit": "“”",
          "Description": "The balance of distributing requests"
        },
        "HotDataSize": {
          "Name": "hotDataSize",
          "Value": 100,
          "Unit": "MB",
          "Description": "Size of the hot data size"
        },
        "WarmDataSize": {
          "Name": "warmDataSize",
          "Value": 100,
          "Unit": "MB",
          "Description": "Size of the warm data size"
        },
        "ColdDataSize": {
          "Name": "coldDataSize",
          "Value": 100,
          "Unit": "MB",
          "Description": "Size of the cold data size"
        },
        "FreezeDataSize": {
          "Name": "freezeDataSize",
          "Value": 100,
          "Unit": "MB",
          "Description": "Size of the freeze data size"
        },
        "WarmConfigDay": {
          "Name": "warmConfigDay",
          "Value": 1,
          "Unit": "day",
          "Description": "Warm config day"
        },
        "ColdConfigDay": {
          "Name": "coldConfigDay",
          "Value": 1,
          "Unit": "day",
          "Description": "Cold config day"
        },
        "FreezeConfigDay": {
          "Name": "freezeConfigDay",
          "Value": 1,
          "Unit": "day",
          "Description": "Freeze config day"
        },
        "Locality": {
          "Name": "locality",
          "Value": 0,
          "Unit": "\"\"",
          "Description": "The locality of data"
        },
        "ColdAccessDay": {
          "Name": "coldAccessDay",
          "Value": 1,
          "Unit": "day",
          "Description": "Cold access day"
        },
        "RegionCountDayGrowthRatio": {
          "Name": "regionCountDayGrowthRatio",
          "Value": 1,
          "Unit": "\"\"",
          "Description": "Day growth ratio of region count"
        },
        "TableSizeDayGrowthRatio": {
          "Name": "tableSizeDayGrowthRatio",
          "Value": 1,
          "Unit": "'\"",
          "Description": "Day growth ratio of table size"
        },
        "StoreFileCountDayGrowthRatio": {
          "Name": "storeFileCountDayGrowthRatio",
          "Value": 0.7,
          "Unit": "\"\"",
          "Description": "Day growth ratio of store file count"
        },
        "DailyReadRequestDayGrowthRatio": {
          "Name": "dailyReadRequestDayGrowthRatio",
          "Value": 0.8,
          "Unit": "\"\"",
          "Description": "Day growth ratio of read requests"
        },
        "DailyWriteRequestDayGrowthRatio": {
          "Name": "dailyWriteRequestDayGrowthRatio",
          "Value": 0.8,
          "Unit": "\"\"",
          "Description": "The balance of distributing requests"
        },
        "ReadRequestBalance": {
          "Name": "readRequestBalance",
          "Value": 1,
          "Unit": "\"\"",
          "Description": "The balance of distributing read requests"
        },
        "WriteRequestBalance": {
          "Name": "writeRequestBalance",
          "Value": 1,
          "Unit": "\"\"",
          "Description": "The balance of distributing write requests"
        }
      },
      "Analysis": {
        "TableScore": 67,
        "RequestUnbalanceSuggestion": "ead request unbalance is 
Total number of table regions: 15,Average read requests per region: 764361,The following regions have read request hotspots:
RegionServer: emr-worker-2 Region Id: f1c922d41529785e21b61cf4c672b98a Read requests: 1543919
RegionServer: emr-worker-2 Region Id: 5f019e8cf7c16be9768634cb99ccbe05 Read requests: 1512817
RegionServer: emr-worker-2 Region Id: d113992fea3a457f60b8b8aa5d6fa037 Read requests: 1504293
 ",
        "RequestHotspotRegionList": [
          "5f019e8cf7c16be9768634cb99ccbe05"
        ],
        "ReadRequestUnbalanceSuggestion": "ead request unbalance is 
Total number of table regions: 15,Average read requests per region: 764361,The following regions have read request hotspots:
RegionServer: emr-worker-2 Region Id: f1c922d41529785e21b61cf4c672b98a Read requests: 1543919
RegionServer: emr-worker-2 Region Id: 5f019e8cf7c16be9768634cb99ccbe05 Read requests: 1512817
RegionServer: emr-worker-2 Region Id: d113992fea3a457f60b8b8aa5d6fa037 Read requests: 1504293
 ",
        "ReadRequestHotspotRegionList": [
          "5f019e8cf7c16be9768634cb99ccbe05"
        ],
        "WriteRequestUnbalanceSuggestion": "write request unbalance is 
Total number of table regions: 15,Average write requests per region: 786142,The following regions have write request hotspots:
RegionServer: emr-worker-2 Region Id: f1c922d41529785e21b61cf4c672b98a Write requests: 1588305
RegionServer: emr-worker-2 Region Id: 5f019e8cf7c16be9768634cb99ccbe05 Write requests: 1556984
RegionServer: emr-worker-2 Region Id: d113992fea3a457f60b8b8aa5d6fa037 Write requests: 1548764
 ",
        "WriteRequestHotspotRegionList": [
          "5f019e8cf7c16be9768634cb99ccbe05"
        ]
      }
    }
  ],
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "NextToken": "DD6B1B2A-5837-5237-ABE4-FF0C89568980",
  "MaxResults": 20,
  "TotalCount": 200
}

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.