tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDeviceMonitorInfo

Last updated: 2024-11-20 11:12:39

    1. API Description

    Domain name for API request: cdb.intl.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.

    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 Params. The value used for this API: DescribeDeviceMonitorInfo.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region Yes String Common Params. 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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Querying the monitoring information of the physical machine where an instance is deployed

    Input Example

    POST / HTTP/1.1
Host: cdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceMonitorInfo
<Common request parameters>

{
    "InstanceId": "cdb-uns231ns",
    "Count": "2"
}

    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": {
            "CapacityRatio": [
                5433344,
                49153024,
                0,
                40931328,
                1024,
                40946688,
                272384,
                40945664,
                0,
                40945664,
                123813888,
                195940352,
                12439552,
                587817984
            ],
            "Read": [
                0,
                0
            ],
            "Write": [
                740,
                797
            ],
            "IoRatioPerSec": [
                0,
                0
            ],
            "IoWaitTime": [
                61,
                65
            ]
        },
        "RequestId": "85b295bb-8f43-ce01-e35f-5a02e2beeeac"
    }
}

    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
    CdbError Backend or process error.
    FailedOperation.StatusConflict Task status conflict.
    InternalError.DatabaseAccessError Internal database error.
    InternalError.HttpError Exceptional HTTP request
    InternalError.UnknownError Unknown error
    InvalidParameter Parameter error.
    InvalidParameter.InstanceNotFound The instance does not exist.
    OperationDenied Operation denied.
    OperationDenied.ActionNotSupport Unsupported operation.
    OperationDenied.FunctionDenied This instance needs permissions to use this feature.
    OperationDenied.InstanceStatusError Exceptional instance status
    ResourceNotFound.InstanceNotFundError The instance does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy