DescribeBaseMetrics

Last updated: 2020-08-14 10:35:06

1. API Description

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

This API is used to get the details of basic metrics.

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: monitor.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: DescribeBaseMetrics.
Version Yes String Common parameter. The value used for this API: 2018-07-24.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-beijing-fsi, ap-changsha-ec, ap-chengdu, ap-chongqing, ap-fuzhou-ec, ap-guangzhou, ap-guangzhou-open, ap-hangzhou-ec, ap-hongkong, ap-jinan-ec, ap-mumbai, ap-nanjing, ap-qingyuan, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen, ap-shenzhen-fsi, ap-shijiazhuang-ec, ap-singapore, ap-taipei, ap-tianjin, ap-tokyo, ap-wuhan-ec, ap-xibei-ec, eu-frankfurt, eu-moscow, na-ashburn, na-siliconvalley, na-toronto
Namespace Yes String Service namespace. Tencent Cloud services have different namespaces. For more information on service namespaces, see the monitoring metric documentation of each service. For example, see CVM Monitoring Metrics for the namespace of CVM
MetricName No String Metric name. Tencent Cloud services have different metric names. For more information on metric names, see the monitoring metric documentation of each service. For example, see CVM Monitoring Metrics for the metric names of CVM

3. Output Parameters

Parameter Name Type Description
MetricSet Array of MetricSet Listed of queried metric descriptions
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the list of monitoring metrics

This example shows you how to query the types of basic monitoring metrics under the corresponding namespace.

Input Example

https://monitor.tencentcloudapi.com/?Action=DescribeBaseMetrics
&Namespace=QCE/CVM
&MetricName=AccOuttraffic
&<Common request parameter>

Output Example

{
  "Response": {
    "RequestId": "15e8eb48-e445-48b5-97ca-985908e207bb",
    "MetricSet": [
      {
        "Namespace": "QCE/CVM",
        "MetricName": "AccOuttraffic",
        "Unit": "MB",
        "UnitCname": "",
        "Period": [
          10,
          60,
          300,
          3600,
          86400
        ],
        "Periods": [
          {
            "Period": "10",
            "StatType": [
              "sum"
            ]
          },
          {
            "Period": "60",
            "StatType": [
              "sum"
            ]
          },
          {
            "Period": "300",
            "StatType": [
              "sum"
            ]
          },
          {
            "Period": "3600",
            "StatType": [
              "sum"
            ]
          },
          {
            "Period": "86400",
            "StatType": [
              "sum"
            ]
          }
        ],
        "Dimensions": [
          {
            "Dimensions": [
              "InstanceId"
            ]
          }
        ],
        "Meaning": {
          "En": "",
          "Zh": "Average outbound traffic per second of the public ENI"
        }
      }
    ]
  }
}

Example2 Getting the list of monitoring metrics (QCE/CDB)

This example shows you how to query the types of basic monitoring metrics under the corresponding namespace.

Input Example

https://monitor.tencentcloudapi.com/?Action=DescribeBaseMetrics
&Namespace=QCE/CDB
&MetricName=BytesReceived
&<Common request parameter>

Output Example

{
  "Response": {
    "RequestId": "2102703c-a1bb-4f71-9eb8-58cdfb544590",
    "MetricSet": [
      {
        "Namespace": "QCE/CDB",
        "MetricName": "BytesReceived",
        "Unit": "Bps",
        "UnitCname": "",
        "Period": [
          60,
          300,
          3600,
          86400
        ],
        "Periods": [
          {
            "Period": "60",
            "StatType": [
              "max"
            ]
          },
          {
            "Period": "300",
            "StatType": [
              "max"
            ]
          },
          {
            "Period": "3600",
            "StatType": [
              "max"
            ]
          },
          {
            "Period": "86400",
            "StatType": [
              "max"
            ]
          }
        ],
        "Dimensions": [
          {
            "Dimensions": [
              "InstanceId",
              "InstanceType"
            ]
          }
        ],
        "Meaning": {
          "En": "",
          "Zh": "Amount of accepted data"
        }
      }
    ]
  }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Was this page helpful?

Was this page helpful?

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