GetDoctorHBaseCluster - E-MapReduce - Alibaba Cloud Documentation Center

Obtains the metrics of an HBase cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

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 date.	2023-01-01

Response parameters

Parameter	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	long	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 size of the cluster.
Name	string	The name of the metric.	totalDataSize
Value	long	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	long	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	long	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	float	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	float	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	float	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	long	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	long	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	long	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 memory size.
Name	string	The name of the metric.	memHeap
Value	long	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	long	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 number of read requests in a day.
Name	string	The name of the metric.	dailyReadRequest
Value	long	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 number of write requests in a day.
Name	string	The name of the metric.	dailyWriteRequest
Value	long	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

Sample success responses

JSONformat

{
  "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
404	ResourceNotFound	The resource not found by %s.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history