PrevNext
search by keyword

Recent Pages

Documentation
TencentDB for DBbrain
    Documentation
    Download PDF

    DescribeTopSpaceTables

    Last updated: 2021-08-09 10:49:16
    Download PDF

    1. API Description

    Domain name for API request: dbbrain.tencentcloudapi.com.

    This API is used to get the real-time space statistics of top tables of an instance. The returned results are sorted by size by default.

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

    Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: dbbrain.ap-shanghai-fsi.tencentcloudapi.com

    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 parameter. The value used for this API: DescribeTopSpaceTables.
    Version Yes String Common parameter. The value used for this API: 2021-05-27.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    InstanceId Yes String Instance ID.
    Limit No Integer Number of returned top tables. Maximum value: 100. Default value: 20.
    SortBy No String Field used to sort top tables. Valid values: DataLength, IndexLength, TotalLength, DataFree, FragRatio, TableRows, PhysicalFileSize (only supported for TencentDB for MySQL instances). For TencentDB for MySQL instances, the default value is PhysicalFileSize. For other database instances, the default value is TotalLength.
    Product No String Service type. Valid values: mysql (TencentDB for MySQL), cynosdb (TDSQL-C for MySQL). Default value: mysql.

    3. Output Parameters

    Parameter Name Type Description
    TopSpaceTables Array of TableSpaceData List of the returned space statistics of top tables.
    Timestamp Integer Timestamp (in seconds) of tablespace data collection points
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Getting the space statistics of top tables

    Input Example

    https://dbbrain.tencentcloudapi.com/?Action=DescribeTopSpaceTables
&InstanceId=cdb-test
&Limit=2
&SortBy=TableRows
&<Common request parameters>

    Output Example

    {
  "Response": {
    "RequestId": "ed279d8b-a9d9-48d6-9429-e0fde000994a",
    "Timestamp": 1603819881,
    "TopSpaceTables": [
      {
        "DataFree": 0,
        "TableName": "test",
        "TotalLength": 0.1,
        "TableSchema": "test_bak",
        "FragRatio": 0,
        "DataLength": 0.1,
        "PhysicalFileSize": 0.1,
        "TableRows": 9,
        "Engine": "InnoDB",
        "IndexLength": 0
      },
      {
        "DataFree": 0,
        "TableName": "test",
        "TotalLength": 0.1,
        "TableSchema": "test_bak",
        "FragRatio": 0,
        "DataLength": 0.1,
        "PhysicalFileSize": 0.1,
        "TableRows": 9,
        "Engine": "InnoDB",
        "IndexLength": 0
      }
    ]
  }
}

    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

    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
    InvalidParameter Incorrect parameter.
    InvalidParameterValue Incorrect parameter value.
    OperationDenied.UserHasNoStrategy Error with CAM authentication.
    UnauthorizedOperation The operation is unauthorized.
    tencent
    Copyright © 2013-2021 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy