All Products
Search
Document Center

E-MapReduce:GetDoctorHBaseCluster

Last Updated:Dec 12, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
emr:GetDoctorHBaseClusterget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ClusterIdstringYes

The cluster ID.

c-b933c5aac8fe****
DateTimestringYes

The date.

2023-01-01

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Dataobject

The returned data.

Metricsobject

The metric information.

TableCountobject

The number of tables.

Namestring

The name of the metric.

tableCount
Valuelong

The value of the metric.

10
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

Number of tables
TotalDataSizeobject

The size of the cluster.

Namestring

The name of the metric.

totalDataSize
Valuelong

The value of the metric.

256
Unitstring

The unit of the metric.

MB
Descriptionstring

The description of the metric.

Total data size in megabytes (MB)
TotalReadRequestobject

The total number of read requests.

Namestring

The name of the metric.

totalReadRequest
Valuelong

The value of the metric.

430
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

Total number of read requests
TotalWriteRequestobject

The total number of write requests.

Namestring

The name of the metric.

totalWriteRequest
Valuelong

The value of the metric.

520
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

Total number of write requests
AvgLoadobject

The average load.

Namestring

The name of the metric.

avgLoad
Valuefloat

The value of the metric.

36.0
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

The average load under normal working conditions
NormalAvgLoadobject

The normal average load.

Namestring

The name of the metric.

normalAvgLoad
Valuefloat

The value of the metric.

526.4
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

The average load under normal working conditions
RegionBalanceobject

The region balance degree.

Namestring

The name of the metric.

regionBalance
Valuefloat

The value of the metric.

1.0
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

The ability to evenly distribute Regions on different RegionServer nodes
TotalRequestobject

The total number of requests in the cluster.

Namestring

The name of the metric.

totalRequest
Valuelong

The value of the metric.

576
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

Total number of requests
RegionServerCountobject

The number of region servers.

Namestring

The name of the metric.

regionServerCount
Valuelong

The value of the metric.

6
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

Number of region servers count
RegionCountobject

The number of regions.

Namestring

The name of the metric.

regionCount
Valuelong

The value of the metric.

161
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

Number of regions count
MemHeapobject

The memory size.

Namestring

The name of the metric.

memHeap
Valuelong

The value of the metric.

240
Unitstring

The unit of the metric.

MB
Descriptionstring

The description of the metric.

Memory heap usage in megabytes (MB)
StoreFileCountobject

The number of StoreFiles.

Namestring

The name of the metric.

storeFileCount
Valuelong

The value of the metric.

298
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

Number of store files
DailyReadRequestobject

The number of read requests in a day.

Namestring

The name of the metric.

dailyReadRequest
Valuelong

The value of the metric.

430
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

Number of read requests per day
DailyWriteRequestobject

The number of write requests in a day.

Namestring

The name of the metric.

dailyWriteRequest
Valuelong

The value of the metric.

128
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

Number of write requests per day
Analysisobject

The analysis result.

HbaseScoreinteger

The overall score of the HBase cluster.

85
RequestIdstring

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 codeError codeError message
400ConflictParametersParameters that must not be used together. %s
400IncompleteSignatureThe request signature is invalid.
400InvalidActionThe action %s requested is invalid.
400InvalidParameterThe specified parameter %s is not valid.
400InvalidParameterValueThe input parameter %s is invalid or out of range.
400MissingActionThe action %s requested is missing.
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.
400NotAuthorizedYou do not have permission to perform this action. %s
400ThrottlingExceptionThe request was denied due to request throttling. %s
404ResourceNotFoundThe resource not found by %s.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.
503ServiceFailureThe request has failed due to a temporary failure of %s service.
503ServiceUnavailableThe 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 timeSummary of changesOperation
No change history