DescribeHBaseTableOverview

Last updated: 2025-11-13 20:49:07

DescribeHBaseTableOverview

Last updated: 2025-11-13 20:49:07

1. API Description

Domain name for API request: emr.intl.tencentcloudapi.com.

This API is used to access the overview of HBase table-level monitoring data.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeHBaseTableOverview.
Version	Yes	String	Common Params. The value used for this API: 2019-01-03.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
InstanceId	Yes	String	Instance ID.
Offset	Yes	Integer	Pagination query number offset, starting from 0.
Limit	Yes	Integer	Page size for pagination query. The minimum value is 1, and the maximum value is 100.
Table	No	String	Table name, supporting fuzzy matching
OrderField	No	String	Field for sorting, with a default value
OrderType	No	String	asc: Ascending; desc: Descending (default)

3. Output Parameters

Parameter Name	Type	Description
TableMonitorList	Array of OverviewRow	Overview data array
TotalCount	Integer	Overview data array length
SchemaList	Array of TableSchemaItem	Table schema information
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying Overview Information on HBase Table Monitoring

Input Example

https://emr.intl.tencentcloudapi.com/?Action=DescribeHBaseTableOverview
&InstanceId=emr-111df6u6
&Table=table_test
&Offset=0
&Limit=10
&OrderField=
&OrderType=
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "63cb3d88-2f61-4ae6-a989-ec4153f2bfd2",
        "SchemaList": [
            {
                "Name": "Table",
                "Sortable": false,
                "WithFilter": false,
                "Candidates": null,
                "Clickable": true,
                "Title": "Table Name"
            },
            {
                "Name": "ReadRequestCount",
                "Sortable": true,
                "WithFilter": false,
                "Candidates": null,
                "Clickable": false,
                "Title": "Read Request Volume (requests per second)"
            },
            {
                "Name": "WriteRequestCount",
                "Sortable": true,
                "WithFilter": false,
                "Candidates": null,
                "Clickable": false,
                "Title": "Write Request Volume (requests per second)"
            },
            {
                "Name": "MemstoreSize",
                "Sortable": true,
                "WithFilter": false,
                "Candidates": null,
                "Clickable": false,
                "Title": "MemStore Size (byte)"
            },
            {
                "Name": "StoreFileSize",
                "Sortable": true,
                "WithFilter": false,
                "Candidates": null,
                "Clickable": false,
                "Title": "StoreFile Size (byte)"
            },
            {
                "Name": "Operation",
                "Sortable": false,
                "WithFilter": false,
                "Candidates": null,
                "Clickable": true,
                "Title": "Operation"
            }
        ],
        "TableMonitorList": [
            {
                "Table": "default_TEST",
                "ReadRequestCount": 0,
                "WriteRequestCount": 0,
                "MemstoreSize": 0,
                "StoreFileSize": 0,
                "Operation": "regions"
            },
            {
                "Table": "default_test",
                "ReadRequestCount": 0,
                "WriteRequestCount": 0,
                "MemstoreSize": 0,
                "StoreFileSize": 4950,
                "Operation": "regions"
            }
        ],
        "TotalCount": 2
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError.DoOpenTSDBRequestException	An exception occurred when OpenTSDB is being requested.
InternalError.OpenTSDBHttpReturnCodeNotOK	Failed to request OpenTSDB.
ResourceNotFound	Resources do not exist.
ResourceNotFound.ClusterNotFound	The instance was not found.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud