GAAP Connection Load Monitoring API

Last updated: 2020-05-26 14:32:39

    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 metrics.

    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 across a period of time.

    To query the load monitoring data of a Global Application Acceleration Platform (GAAP) connection, use the following input parameters:
    &Namespace=QCE/QAAP
    &Instances.N.Dimensions.0.Name=channelId
    &Instances.N.Dimensions.0.Value=Connection ID

    2. Input Parameters

    The list below contains only the API request parameters and certain common parameters. Common request parameters are required 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 This parameter is not required for this API
    Namespace Yes String Namespace. Each Tencent Cloud service has a namespace, such as QCE/QAAP for GAAP connection load 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. Dimension parameters

    Parameter Name Dimension Name Dimension Description Format
    Instances.N.Dimensions.0.Name channelId Acceleration connection ID Enter a string-type dimension name, such as channelId
    Instances.N.Dimensions.0.Value channelId Acceleration connection ID Enter a specific connection ID, such as link-abcd1234

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

    Metric Name Description Unit
    Connum Concurrent connections -
    Inbandwidth Inbound bandwidth Mbps
    Outbandwidth Outbound bandwidth Mbps
    InPackets Inbound packets Packages/sec
    OutPackets Outbound packets Packages/sec
    PacketLoss Packet loss rate %
    Latency Latency ms

    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 the request. Each request returns a unique ID. RequestId is required to troubleshoot issues

    4. Error Codes

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

    5. Samples

    Sample 1. Getting the monitoring data for the number of concurrent connections of one GAAP connection

    This example shows you how to get the monitoring data for the number of concurrent connections of one GAAP connection using a statistical period of 60 seconds for a specified length of time.

    Sample input code

    https://monitor.tencentcloudapi.com/?Action=GetMonitorData
    &Namespace=QCE/QAAP  
    &MetricName=Connum
    &Period=60
    &StartTime=2019-05-08T16:40:00+08:00
    &EndTime=2019-05-08T16:45:00+08:00
    &Instances.0.Dimensions.0.Name=channelId
    &Instances.0.Dimensions.0.Value=link-abcd1234
    &[<Common Request Parameters>](https://intl.cloud.tencent.com/document/product/248/4478)

    Sample output code

    {
        "Response": {
        "StartTime": "2019-05-08 16:40:00",
        "EndTime": "2019-05-08 16:45:00",
        "Period": 60,
        "MetricName": "Connum",
        "DataPoints": [
          {
            "Dimensions": [
              {
                "Name": "channelId",
                "Value": "link-abcd1234"
              }
            ],
            "Timestamps": [
              1557304800,
              1557304860,
              1557304920,
              1557304980,
              1557305040,
              1557305100
            ],
            "Values": [
              0.105,
              0.1,
              0.071,
              0.295,
              0.096,
              0.098
            ],
             "RequestId": "0ea9aeee-3bf8-46a0-b594-c2b9e1b7f0bf"
          }
    }

    Example 2. Getting the monitoring data for the number of concurrent connections of multiple GAAP connections

    This example shows you how to get the monitoring data for the number of concurrent connections of multiple GAAP connections using a statistical period of 60 seconds for a specified length of time.

    Sample input code

    https://monitor.tencentcloudapi.com/?Action=GetMonitorData
    &Namespace=QCE/QAAP
    &MetricName=Connum
    &Period=60
    &StartTime=2019-05-08T16:40:00+08:00
    &EndTime=2019-05-08T16:45:00+08:00
    &Instances.0.Dimensions.0.Name=diskId
    &Instances.0.Dimensions.0.Value=disk-test1
    &Instances.1.Dimensions.0.Name=diskId
    &Instances.1.Dimensions.0.Value=disk-test2
    &<Common request parameters>

    Sample output code

    {
      "Response": {
        "StartTime": "2019-05-08 16:40:00",
        "EndTime": "2019-05-08 16:45:00",
        "Period": 60,
        "MetricName": "Connum",
        "DataPoints": [
          {
            "Dimensions": [
              {
                "Name": "diskId",
                "Value": "disk-test1"
              }
            ],
            "Timestamps": [
              1557304800,
              1557304860,
              1557304920,
              1557304980,
              1557305040,
              1557305100
            ],
            "Values": [
              0.105,
              0.1,
              0.071,
              0.295,
              0.096,
              0.098
            ]
          },
          {
            "Dimensions": [
              {
                "Name": "diskId",
                "Value": "disk-test2"
              }
            ],
            "Timestamps": [
              1557304800,
              1557304860,
              1557304920,
              1557304980,
              1557305040,
              1557305100
            ],
            "Values": [
              0.105,
              0.1,
              0.071,
              0.295,
              0.096,
              0.098
            ]
          }
        ],
        "RequestId": "0ea9aeee-3bf8-46a0-b594-c2b9e1b7f0bf"
      }
    }

    Was this page helpful?

    Was this page helpful?

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