tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
云数据库 MariaDB
    文档
    Download PDF

    DescribeDBResourceUsageDetails

    最后更新时间：2022-01-27 10:36:35
    下载PDF

    1. API Description

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

    This API is used to view the current performance data 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: DescribeDBResourceUsageDetails.
    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
    Master ResourceUsageMonitorSet Master node resource usage monitoring node
    Slave1 ResourceUsageMonitorSet Slave 1 resource usage monitoring node
    Note: this field may return null, indicating that no valid values can be obtained.
    Slave2 ResourceUsageMonitorSet Slave 2 resource usage monitoring node
    Note: this field may return null, indicating that no valid values can be obtained.
    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 details

    Input Example

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

    Output Example

    {
  "Response": {
    "Slave1": {
      "BinlogDiskAvailable": {
        "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"
      },
      "MemAvailable": {
        "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"
      }
    },
    "Master": {
      "BinlogDiskAvailable": {
        "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"
      },
      "MemAvailable": {
        "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"
      }
    },
    "RequestId": "6ce468ba-206a-4ad1-a1e6-7f2194657649"
  }
}

    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
    InternalError.CamAuthFailed CAM authentication request failed.
    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.
    联系我们

    联系我们，为您的业务提供专属服务。

    联系我们
    技术支持

    如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

    提交工单
    7x24 电话支持
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款