All Products
Search
Document Center

E-MapReduce:ListDoctorHBaseRegionServers

Last Updated:Dec 12, 2024

Obtains the information about multiple HBase RegionServers at a time.

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:ListDoctorHBaseRegionServerslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ClusterIdstringYes

The cluster ID.

c-b933c5aac8fe****
NextTokenstringNo

The pagination token that is used in the request to retrieve a new page of results.

DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResultsintegerNo

The maximum number of entries to return on each page.

20
DateTimestringYes

The query date.

2023-01-01
RegionServerHostsarrayNo

The RegionServer hosts.

StringstringNo

The RegionServer host.

emr-worker-4.cluster-20****
OrderTypestringNo

The order in which you want to sort the query results. Valid value:

  • ASC: in ascending order
  • DESC: in descending order
ASC
OrderBystringNo

The field that you use to sort the query results. Valid value:

  • regionCount: the number of regions.
regionCount

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Dataarray<object>

The returned data.

ListDoctorHBaseRegionServersDTOobject
RegionServerHoststring

The RegionServer host.

emr-worker-4.cluster-20****
Metricsobject

The metric information.

RegionCountobject

The number of regions.

Namestring

The name of the metric.

regionCount
Valuelong

The value of the metric.

81
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

Number of regions count
TotalReadRequestobject

The cumulative number of read requests.

Namestring

The name of the metric.

totalReadRequest
Valuelong

The value of the metric.

170500567
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

Total number of read requests
TotalWriteRequestobject

The cumulative number of write requests.

Namestring

The name of the metric.

totalWriteRequest
Valuelong

The value of the metric.

30109837
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

Total number of write requests
TotalRequestobject

The cumulative number of all requests.

Namestring

The name of the metric.

totalRequest
Valuelong

The value of the metric.

89499511
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

Total number of requests
DailyReadRequestobject

The number of daily read requests.

Namestring

The name of the metric.

dailyReadRequest
Valuelong

The value of the metric.

42571
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

Number of read requests per day
DailyWriteRequestobject

The number of daily write requests.

Namestring

The name of the metric.

dailyWriteRequest
Valuelong

The value of the metric.

23124
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

Number of write requests per day
AvgGcobject

The average garbage collection (GC) duration.

Namestring

The name of the metric.

avgGc
Valuefloat

The value of the metric.

37.9
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

The efficiency of garbage collection in the system
CacheRatioobject

The cache hit ratio.

Namestring

The name of the metric.

cacheRatio
Valuefloat

The value of the metric.

96.7
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

Ratio of the BlockCache memory size
DailyReadRequestDayGrowthRatioobject

The growth rate of the number of daily read requests.

Namestring

The name of the metric.

dailyReadRequestDayGrowthRatio
Valuefloat

The value of the metric.

1.0
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

The growth rate of daily read request quantity.
DailyWriteRequestDayGrowthRatioobject

The growth rate of the number of daily write requests.

Namestring

The name of the metric.

dailyWriteRequestDayGrowthRatio
Valuefloat

The value of the metric.

1.0
Unitstring

The unit of the metric.

""
Descriptionstring

The description of the metric.

The growth rate of daily write request quantity.
RequestIdstring

The request ID.

DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextTokenstring

A pagination token.

DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResultsinteger

The maximum number of entries that are returned.

20
TotalCountinteger

The total number of entries returned.

200

Examples

Sample success responses

JSONformat

{
  "Data": [
    {
      "RegionServerHost": "emr-worker-4.cluster-20****",
      "Metrics": {
        "RegionCount": {
          "Name": "regionCount",
          "Value": 81,
          "Unit": "\"\"",
          "Description": "Number of regions count"
        },
        "TotalReadRequest": {
          "Name": "totalReadRequest",
          "Value": 170500567,
          "Unit": "\"\"",
          "Description": "Total number of read requests"
        },
        "TotalWriteRequest": {
          "Name": "totalWriteRequest",
          "Value": 30109837,
          "Unit": "\"\"",
          "Description": "Total number of write requests"
        },
        "TotalRequest": {
          "Name": "totalRequest",
          "Value": 89499511,
          "Unit": "\"\"",
          "Description": "Total number of requests"
        },
        "DailyReadRequest": {
          "Name": "dailyReadRequest",
          "Value": 42571,
          "Unit": "\"\"",
          "Description": "Number of read requests per day"
        },
        "DailyWriteRequest": {
          "Name": "dailyWriteRequest",
          "Value": 23124,
          "Unit": "\"\"",
          "Description": "Number of write requests per day"
        },
        "AvgGc": {
          "Name": "avgGc",
          "Value": 37.9,
          "Unit": "\"\"",
          "Description": "The efficiency of garbage collection in the system"
        },
        "CacheRatio": {
          "Name": "cacheRatio",
          "Value": 96.7,
          "Unit": "\"\"",
          "Description": "Ratio of the BlockCache memory size"
        },
        "DailyReadRequestDayGrowthRatio": {
          "Name": "dailyReadRequestDayGrowthRatio",
          "Value": 1,
          "Unit": "\"\"",
          "Description": "The growth rate of daily read request quantity."
        },
        "DailyWriteRequestDayGrowthRatio": {
          "Name": "dailyWriteRequestDayGrowthRatio",
          "Value": 1,
          "Unit": "\"\"",
          "Description": "The growth rate of daily write request quantity."
        }
      }
    }
  ],
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "NextToken": "DD6B1B2A-5837-5237-ABE4-FF0C89568980",
  "MaxResults": 20,
  "TotalCount": 200
}

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