GetDoctorHBaseCluster - Query HBase cluster metrics - E-MapReduce

Queries the metrics and health score of an HBase cluster for a specified date.

Operation description

Queries the metrics of an HBase cluster, including table count, data size, request statistics, region distribution, and an overall health score.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ClusterId	string	Yes	The cluster ID.	c-b933c5aac8fe****
DateTime	string	Yes	The query date, in the yyyy-MM-dd format.	2023-01-01

Response elements

Element	Type	Description	Example
	object	The response parameters.
Data	object	The returned data.
Metrics	object	The metric information.
TableCount	object	The number of tables.
Name	string	The name of the metric.	tableCount
Value	integer	The value of the metric.	10
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Number of tables
TotalDataSize	object	The total data size of the cluster.
Name	string	The name of the metric.	totalDataSize
Value	integer	The value of the metric.	256
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Total data size in megabytes (MB)
TotalReadRequest	object	The total number of read requests.
Name	string	The name of the metric.	totalReadRequest
Value	integer	The value of the metric.	430
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Total number of read requests
TotalWriteRequest	object	The total number of write requests.
Name	string	The name of the metric.	totalWriteRequest
Value	integer	The value of the metric.	520
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Total number of write requests
AvgLoad	object	The average load.
Name	string	The name of the metric.	avgLoad
Value	number	The value of the metric.	36.0
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	The average load under normal working conditions
NormalAvgLoad	object	The normal average load.
Name	string	The name of the metric.	normalAvgLoad
Value	number	The value of the metric.	526.4
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	The average load under normal working conditions
RegionBalance	object	The region balance 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
TotalRequest	object	The total number of requests in the cluster.
Name	string	The name of the metric.	totalRequest
Value	integer	The value of the metric.	576
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Total number of requests
RegionServerCount	object	The number of region servers.
Name	string	The name of the metric.	regionServerCount
Value	integer	The value of the metric.	6
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.
Name	string	The name of the metric.	regionCount
Value	integer	The value of the metric.	161
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Number of regions count
MemHeap	object	The heap memory size.
Name	string	The name of the metric.	memHeap
Value	integer	The value of the metric.	240
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Memory heap usage in megabytes (MB)
StoreFileCount	object	The number of StoreFiles.
Name	string	The name of the metric.	storeFileCount
Value	integer	The value of the metric.	298
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Number of store files
DailyReadRequest	object	The daily read request count.
Name	string	The name of the metric.	dailyReadRequest
Value	integer	The value of the metric.	430
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Number of read requests per day
DailyWriteRequest	object	The daily write request count.
Name	string	The name of the metric.	dailyWriteRequest
Value	integer	The value of the metric.	128
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Number of write requests per day
Analysis	object	The analysis result.
HbaseScore	integer	The overall score of the HBase cluster.	85
RequestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****

Examples

Success response

JSON format

{
  "Data": {
    "Metrics": {
      "TableCount": {
        "Name": "tableCount",
        "Value": 10,
        "Unit": "\"\"",
        "Description": "Number of tables"
      },
      "TotalDataSize": {
        "Name": "totalDataSize",
        "Value": 256,
        "Unit": "MB",
        "Description": "Total data size in megabytes (MB)"
      },
      "TotalReadRequest": {
        "Name": "totalReadRequest",
        "Value": 430,
        "Unit": "\"\"",
        "Description": "Total number of read requests"
      },
      "TotalWriteRequest": {
        "Name": "totalWriteRequest",
        "Value": 520,
        "Unit": "\"\"",
        "Description": "Total number of write requests"
      },
      "AvgLoad": {
        "Name": "avgLoad",
        "Value": 36,
        "Unit": "\"\"",
        "Description": "The average load under normal working conditions"
      },
      "NormalAvgLoad": {
        "Name": "normalAvgLoad",
        "Value": 526.4,
        "Unit": "\"\"",
        "Description": "The average load under normal working conditions"
      },
      "RegionBalance": {
        "Name": "regionBalance",
        "Value": 1,
        "Unit": "\"\"",
        "Description": "The ability to evenly distribute Regions on different RegionServer nodes"
      },
      "TotalRequest": {
        "Name": "totalRequest",
        "Value": 576,
        "Unit": "\"\"",
        "Description": "Total number of requests"
      },
      "RegionServerCount": {
        "Name": "regionServerCount",
        "Value": 6,
        "Unit": "\"\"",
        "Description": "Number of region servers count"
      },
      "RegionCount": {
        "Name": "regionCount",
        "Value": 161,
        "Unit": "\"\"",
        "Description": "Number of regions count"
      },
      "MemHeap": {
        "Name": "memHeap",
        "Value": 240,
        "Unit": "MB",
        "Description": "Memory heap usage in megabytes (MB)"
      },
      "StoreFileCount": {
        "Name": "storeFileCount",
        "Value": 298,
        "Unit": "\"\"",
        "Description": "Number of store files"
      },
      "DailyReadRequest": {
        "Name": "dailyReadRequest",
        "Value": 430,
        "Unit": "\"\"",
        "Description": "Number of read requests per day"
      },
      "DailyWriteRequest": {
        "Name": "dailyWriteRequest",
        "Value": 128,
        "Unit": "\"\"",
        "Description": "Number of write requests per day"
      }
    },
    "Analysis": {
      "HbaseScore": 85
    }
  },
  "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.