VPC - Bandwidth Package Monitoring API

Last updated: 2020-05-19 17:43:02

    1. API Description

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

    This API is used to get the monitoring data of a Tencent Cloud product by passing in the product's namespace, object dimension, and monitoring metric.

    API call rate limit: 20 calls/second (1,200 calls/minute). A single request can get the data of up to 10 instances and up to 1,440 data points.

    This API may fail due to the rate limit if you need to call many metrics and objects. We recommend that you distribute call requests over a period of time.

    To query the monitoring data of a bandwidth package in a VPC, use the following input parameters:
    &Namespace=QCE/BWP
    &Instances.N.Dimensions.0.Name=bandwidthPackageId
    &Instances.N.Dimensions.0.Value=Unique bandwidth package ID

    2. Input Parameters

    The list below contains only the API request parameters and some common parameters. Common request parameters need to be added when a call is made. For more information, see Common Params.

    2.1. Input parameters

    2.1.1. Overview of input parameters

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: GetMonitorData
    Version Yes String Common parameter. The value used for this API: 2018-07-24
    Region No String Common parameter, indicating the region of the instance to be queried. For supported regions, please see the list of regions supported by VPC
    Namespace Yes String Namespace. Each Tencent Cloud product has a namespace, such as QCE/BWP for VPC bandwidth package namespaces. This value must be capitalized for API 3.0
    MetricName Yes String Metric name. For more information, see section 2.2
    Instances.N Yes Array of Instance Combination of instance object dimensions
    Period No Integer Statistical period for monitoring data in seconds. Default value: 300
    StartTime No Timestamp Start time, such as "2016-01-01 10:25:00". The default value is "00:00:00" of the current day
    EndTime No Timestamp End time, which is the current time by default. EndTime cannot be earlier than StartTime

    2.1.2. Overview of parameters in each dimension

    Parameter Name Dimension Name Dimension Description Format
    Instances.N.Dimensions.0.Name bandwidthPackageId Bandwidth package ID Enter a string-type dimension name, such as bandwidthPackageId
    Instances.N.Dimensions.0.Value bandwidthPackageId Specific bandwidth package ID Enter a specific bandwidth package ID, such as pdcg-4d545d

    2.2. Metric names

    The statistical granularity (period) and dimension (dimension) may vary by metric. The DescribeBaseMetrics API can be used to get the period and dimension supported by each metric.

    Metric Name Description Unit Dimension
    OutTraffic Public network outbound bandwidth Mbps bandwidthPackageId
    InTraffic Public network inbound bandwidth Mbps bandwidthPackageId
    Outpkg Outbound packets Packets/sec bandwidthPackageId
    Inpkg Inbound packets Packets/sec bandwidthPackageId

    3. Output Parameters

    Parameter Name Type Description
    MetricName String Monitoring metric
    StartTime Timestamp Data point start time
    EndTime Timestamp Data point end time
    Period Integer Statistical period
    DataPoints Array of PointsObject Monitoring data list
    RequestId String Unique ID of request. Each request returns a unique ID. RequestId is required to troubleshoot issues

    4. Error Codes

    Error Code Error Description Error Message
    -502 The resource does not exist OperationDenied.SourceNotExists
    -503 Incorrect request parameter InvalidParameter
    -505 Missing parameter InvalidParameter.MissingParameter
    -507 Limit exceeded OperationDenied.ExceedLimit
    -509 Incorrect combination of dimensions InvalidParameter.DimensionGroupError
    -513 Database operation failed InternalError.DBoperationFail

    5. Samples

    Sample 1

    This example shows you how to get the monitoring data for the public network outbound bandwidth of one bandwidth package in a VPC using a statistical period of 60 seconds for a specified length of time.

    Input sample code

    https://monitor.tencentcloudapi.com/?Action=GetMonitorData
    &Namespace=QCE/BWP
    &MetricName=Outbandwidth
    &Period=60
    &StartTime=2019-06-11T00:00:00+08:00
    &EndTime=2019-06-11T00:05:00+08:00
    &Instances.0.Dimensions.0.Name=bandwidthPackageId
    &Instances.0.Dimensions.0.Value=bwp-123456
    &<Common request parameters>

    Output sample code

    {
      "Response": {
        "StartTime": "2019-06-11 00:00:00",
        "EndTime": "2019-06-11 00:05:00",
        "Period": 60,
        "MetricName": "Outbandwidth",
        "DataPoints": [
          {
            "Dimensions": [
              {
                "Name": "bandwidthPackageId",
                "Value": "bwp-123456"
              }
            ],
            "Timestamps": [
              1560182400,
              1560182460,
              1560182520,
              1560182580,
              1560182640,
              1560182700
            ],
            "Values": [
              0.004,
              0.003,
              0.003,
              0.003,
              0.003,
              0.003
            ]
          }
        ],
        "RequestId": "922600e6-3fca-4b91-9ff1-dbb02a0ca017"
      }
    }

    Sample 2

    This example shows you how to get the monitoring data for the public network outbound bandwidth of multiple bandwidth packages in a VPC using a statistical period of 60 seconds for a specified length of time.

    Input sample code

    https://monitor.tencentcloudapi.com/?Action=GetMonitorData
    &Namespace=QCE/BWP
    &MetricName=Outbandwidth
    &Period=60
    &StartTime=2019-06-11T00:00:00+08:00
    &EndTime=2019-06-11T00:05:00+08:00
    &Instances.0.Dimensions.0.Name=bandwidthPackageId
    &Instances.0.Dimensions.0.Value=bwp-123456
    &Instances.1.Dimensions.0.Name=bandwidthPackageId
    &Instances.1.Dimensions.0.Value=bwp-1234567
    &<Common request parameters>

    Output sample code

    {
      "Response": {
        "StartTime": "2019-06-11 00:00:00",
        "EndTime": "2019-06-11 00:05:00",
        "Period": 60,
        "MetricName": "Outbandwidth",
        "DataPoints": [
          {
            "Dimensions": [
              {
                "Name": "bandwidthPackageId",
                "Value": "bwp-123456"
              }
            ],
            "Timestamps": [
              1560182400,
              1560182460,
              1560182520,
              1560182580,
              1560182640,
              1560182700
            ],
            "Values": [
              0.004,
              0.003,
              0.003,
              0.003,
              0.003,
              0.003
            ]
          },
          {
            "Dimensions": [
              {
                "Name": "bandwidthPackageId",
                "Value": "bwp-1234567"
              }
            ],
            "Timestamps": [
              1560182400,
              1560182460,
              1560182520,
              1560182580,
              1560182640,
              1560182700
            ],
            "Values": [
              0.004,
              0.003,
              0.003,
              0.003,
              0.003,
              0.003
            ]
          }
        ],
        "RequestId": "922600e6-3fca-4b91-9ff1-dbb02a0ca017"
      }
    }

    Was this page helpful?

    Was this page helpful?

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