DescribeTopSpaceSchemaTimeSeries

Last updated: 2021-08-09 10:49:17

1. API Description

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

This API is used to get the daily space data of top databases consuming the most instance space. The data is daily collected by DBbrain during a specified time period. 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: DescribeTopSpaceSchemaTimeSeries.
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 databases. Maximum value: 100. Default value: 20.
SortBy No String Field used to sort top databases. Valid values: DataLength, IndexLength, TotalLength, DataFree, FragRatio, TableRows, PhysicalFileSize (supported only by TencentDB for MySQL instances). For TencentDB for MySQL instances, the default value is PhysicalFileSize. For other database instances, the default value is TotalLength.
StartDate No Date Start date, such as "2021-01-01". It can be as early as 29 days before the current date and is 6 days before the end date by default.
EndDate No Date End date, such as "2021-01-01". It can be as early as 29 days before the current date and is the current date by default.
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
TopSpaceSchemaTimeSeries Array of SchemaSpaceTimeSeries Time series list of the returned space statistics of top databases.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the daily space statistics of top databases during specified time period

Input Example

https://dbbrain.tencentcloudapi.com/?Action=DescribeTopSpaceSchemaTimeSeries
&InstanceId=cdb-test
&Limit=2
&StartDate=2021-01-01
&EndDate=2021-01-01
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "d97eacb0-cebd-40b6-963b-579092454f05",
    "TopSpaceSchemaTimeSeries": [
      {
        "TableSchema": "test_bak",
        "SeriesData": {
          "Series": [
            {
              "Values": [
                0
              ],
              "Metric": "DataFree",
              "Unit": "MB"
            },
            {
              "Values": [
                0.1
              ],
              "Metric": "DataLength",
              "Unit": "MB"
            },
            {
              "Values": [
                0
              ],
              "Metric": "IndexLength",
              "Unit": "MB"
            },
            {
              "Values": [
                0.1
              ],
              "Metric": "TotalLength",
              "Unit": "MB"
            },
            {
              "Values": [
                0
              ],
              "Metric": "FragRatio",
              "Unit": "%"
            },
            {
              "Values": [
                9
              ],
              "Metric": "TableRows",
              "Unit": ""
            },
            {
              "Values": [
                0.1
              ],
              "Metric": "PhysicalFileSize",
              "Unit": "MB"
            }
          ],
          "Timestamp": [
            1588089600
          ]
        }
      },
      {
        "TableSchema": "test_bak",
        "SeriesData": {
          "Series": [
            {
              "Values": [
                0
              ],
              "Metric": "DataFree",
              "Unit": "MB"
            },
            {
              "Values": [
                0.1
              ],
              "Metric": "DataLength",
              "Unit": "MB"
            },
            {
              "Values": [
                0
              ],
              "Metric": "IndexLength",
              "Unit": "MB"
            },
            {
              "Values": [
                0.1
              ],
              "Metric": "TotalLength",
              "Unit": "MB"
            },
            {
              "Values": [
                0
              ],
              "Metric": "FragRatio",
              "Unit": "%"
            },
            {
              "Values": [
                6
              ],
              "Metric": "TableRows",
              "Unit": ""
            },
            {
              "Values": [
                0.1
              ],
              "Metric": "PhysicalFileSize",
              "Unit": "MB"
            }
          ],
          "Timestamp": [
            1588089600
          ]
        }
      }
    ]
  }
}

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
AuthFailure Error with CAM signature/authentication.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue Incorrect parameter value.
MissingParameter Missing parameter.
OperationDenied Operation denied.
OperationDenied.UserHasNoStrategy Error with CAM authentication.