tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDBResourceUsage

Last updated: 2022-02-18 11:36:51

1. API Description

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

This API is used to view the resource usage of a database instance.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeDBResourceUsage.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID in the format of tdsql-ow728lmc.
StartTime Yes Date Start date in the format of yyyy-mm-dd
EndTime Yes Date End date in the format of yyyy-mm-dd
MetricName No String Name of pulled metric. Valid values: data_disk_available, binlog_disk_available, mem_available, cpu_usage_rate

3. Output Parameters

Parameter Name Type Description
BinlogDiskAvailable MonitorData Available capacity of binlog disk in GB
DataDiskAvailable MonitorData Available disk capacity in GB
CpuUsageRate MonitorData CPU utilization
MemAvailable MonitorData Available memory size in GB
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Viewing instance resource usage

Input Example

https://mariadb.tencentcloudapi.com/?Action=DescribeDBResourceUsage
&InstanceId=tdsql-ige1a5k3
&StartTime=2018-03-19
&EndTime=2018-03-19
&<Common request parameters>

Output Example

{
  "Response": {
    "MemAvailable": {
      "EndTime": "2018-03-24 23:59:59",
      "Data": [
        1,
        1,
        1
      ],
      "StartTime": "2018-03-24 00:00:00"
    },
    "CpuUsageRate": {
      "EndTime": "2018-03-24 23:59:59",
      "Data": [
        1,
        1,
        1
      ],
      "StartTime": "2018-03-24 00:00:00"
    },
    "RequestId": "32a93b23-cbd8-48a9-a75a-2274625099ca",
    "BinlogDiskAvailable": {
      "EndTime": "2018-03-24 23:59:59",
      "Data": [
        1,
        1,
        1
      ],
      "StartTime": "2018-03-24 00:00:00"
    },
    "DataDiskAvailable": {
      "EndTime": "2018-03-24 23:59:59",
      "Data": [
        1,
        1,
        1
      ],
      "StartTime": "2018-03-24 00:00:00"
    }
  }
}

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
FailedOperation.OssOperationFailed Failed to request the backend API.
InternalError.CamAuthFailed CAM authentication request failed.
InternalError.FetchMetricDataFailed Failed to obtain monitoring data.
InternalError.GetInstanceDetailFailed Failed to get the instance details.
InternalError.InnerSystemError Internal system error.
InvalidParameter.GenericParameterError An error occurred while verifying parameter validity.
InvalidParameter.InstanceNotFound Failed to find the requested instance.
InvalidParameterValue.ShardNotExist The shard does not exist.
ResourceNotFound.NoInstanceFound The specified database instance was not found.
ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy