DescribeDeviceMonitorInfo

Last updated: 2020-08-07 14:26:03

1. API Description

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

This API (DescribeDeviceMonitorInfo) is used to query the monitoring information of a TencentDB physical machine on the day. Currently, it only supports instances with 488 GB memory and 6 TB disk.

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: cdb.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: DescribeDeviceMonitorInfo.
Version Yes String Common parameter. The value used for this API: 2017-03-20.
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 cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.
Count No Integer This parameter is used to return the monitoring data of Count 5-minute time periods on the day. Value range: 1-288. If this parameter is not passed in, all monitoring data in a 5-minute granularity on the day will be returned by default.

3. Output Parameters

Parameter Name Type Description
Cpu DeviceCpuInfo CPU monitoring data of the instance
Mem DeviceMemInfo Memory monitoring data of the instance
Net DeviceNetInfo Network monitoring data of the instance
Disk DeviceDiskInfo Disk monitoring data of the instance
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting physical machine monitoring information

Input Example

https://cdb.tencentcloudapi.com/?Action=DescribeDeviceMonitorInfo
&InstanceId=cdb-uns231ns
&Count=2
&<common request parameters>

Output Example

{
  "Response": {
    "Cpu": {
      "Load": [
        174,
        169
      ],
      "Rate": [
        {
          "CpuCore": 0,
          "Rate": [
            4,
            5
          ]
        },
        {
          "CpuCore": 0,
          "Rate": [
            7,
            7
          ]
        },
        {
          "CpuCore": 1,
          "Rate": [
            15,
            7
          ]
        },
        {
          "CpuCore": 2,
          "Rate": [
            7,
            7
          ]
        },
        {
          "CpuCore": 3,
          "Rate": [
            6,
            5
          ]
        },
        {
          "CpuCore": 4,
          "Rate": [
            4,
            2
          ]
        },
        {
          "CpuCore": 5,
          "Rate": [
            4,
            5
          ]
        },
        {
          "CpuCore": 6,
          "Rate": [
            7,
            5
          ]
        },
        {
          "CpuCore": 7,
          "Rate": [
            7,
            9
          ]
        },
        {
          "CpuCore": 8,
          "Rate": [
            8,
            8
          ]
        },
        {
          "CpuCore": 9,
          "Rate": [
            6,
            4
          ]
        },
        {
          "CpuCore": 10,
          "Rate": [
            4,
            14
          ]
        },
        {
          "CpuCore": 11,
          "Rate": [
            2,
            2
          ]
        },
        {
          "CpuCore": 12,
          "Rate": [
            6,
            3
          ]
        },
        {
          "CpuCore": 13,
          "Rate": [
            10,
            14
          ]
        },
        {
          "CpuCore": 14,
          "Rate": [
            12,
            6
          ]
        },
        {
          "CpuCore": 15,
          "Rate": [
            5,
            2
          ]
        },
        {
          "CpuCore": 16,
          "Rate": [
            4,
            2
          ]
        },
        {
          "CpuCore": 17,
          "Rate": [
            2,
            4
          ]
        },
        {
          "CpuCore": 18,
          "Rate": [
            4,
            6
          ]
        },
        {
          "CpuCore": 19,
          "Rate": [
            14,
            9
          ]
        },
        {
          "CpuCore": 20,
          "Rate": [
            6,
            6
          ]
        },
        {
          "CpuCore": 21,
          "Rate": [
            5,
            5
          ]
        },
        {
          "CpuCore": 22,
          "Rate": [
            3,
            12
          ]
        },
        {
          "CpuCore": 23,
          "Rate": [
            2,
            2
          ]
        }
      ]
    },
    "Mem": {
      "Total": [
        65716676,
        65716676
      ],
      "Used": [
        57163160,
        57158148
      ]
    },
    "Net": {
      "Conn": [
        133,
        130
      ],
      "PackageIn": [
        960,
        960
      ],
      "PackageOut": [],
      "FlowIn": [
        150,
        112
      ],
      "FlowOut": [
        1342,
        1260
      ]
    },
    "Disk": {
      "Read": [
        0,
        0
      ],
      "Write": [
        740,
        797
      ],
      "IoRatioPerSec": [
        0,
        0
      ],
      "IoWaitTime": [
        61,
        65
      ]
    },
    "RequestId": "85b295bb-8f43-ce01-e35f-5a02e2beeeac"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
CdbError Backend or process error.
FailedOperation.StatusConflict Task status conflict.
InternalError.DatabaseAccessError Internal database error.
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound The instance does not exist.
OperationDenied The operation is denied.
OperationDenied.ActionNotSupport Unsupported operation.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help