tencent cloud

1. API Description

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

This API is used to query the alarm records.

Note: If you query the alarm records as a sub-user, you can only query those of authorized projects or those of products which are not categorized by projects.

A maximum of 20 requests can be initiated per second for this API.

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.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

3. Output Parameters

4. Example

Example1 Querying alarm records

Monitoring type is a first-level concept, and policy type is a second-level concept. Therefore, the policy type is meaningful only after the monitoring type is specified in the Namespaces field.

To query the alarm records of “CVM - Basic Monitor”, the filter conditions should be: Monitoring type (Tencent Cloud service monitoring), policy type (CVM - Basic Monitor).

Enter ["MT_QCE"] for MonitorTypes, the first-level filter condition.

Enter [{"MonitorType": "MT_QCE", "Namespace": "cvm_device"}] for Namespaces, the second-level filter condition.

Input Example

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmHistories
<Common request parameters>
{
  "Module": "monitor",
  "PageNumber": 1,
  "PageSize": 10,
  "StartTime": 1598976507,
  "EndTime": 1599019707
}

Output Example

{
"Response": {
  "Histories": [
    {
      "AlarmId": "c36494f8-ae38-45cb-8089-e14006bcfc67",
      "MonitorType": "MT_QCE",
      "Namespace": "cvm_device",
      "AlarmObject": "10.104.126.8 (private) | CVM 01 | Classic network",
      "Content": "CPU utilization > 0%",
      "FirstOccurTime": 1603117860,
      "LastOccurTime": 1603162964,
      "AlarmStatus": "ALARM",
      "PolicyId": "policy-abc01",
      "PolicyName": "CVM alarm policy 1",
      "VPC": "0",
      "ProjectId": 0,
      "ProjectName": "Default project",
      "InstanceGroup": [
        {
          "Id": 430,
          "Name": "example-instance-group"
        }
      ],
      "ReceiverUids": [],
      "ReceiverGroups": [
        1544
      ],
      "NoticeWays": [
        "SMS",
        "EMAIL",
        "WECHAT"
      ],
      "EventId": 0,
      "AlarmType": "METRIC",
      "OriginId": "1278441",
      "Region": "gz",
      "PolicyExists": 1,
      "MetricsInfo": [
        {
          "QceNamespace": "qce/cvm",
          "MetricName": "CpuUsage",
          "Period": 60,
          "Value": "86.5",
          "Description": "CPU utilization"
        }
      ]
    },
    {
      "AlarmId": "779d129a-40a1-4acf-b226-d9c2ae26e63b",
      "MonitorType": "MT_QCE",
      "Namespace": "cvm_device",
      "AlarmObject": "10.104.126.9 (private) | CVM 02 | Classic network",
      "Content": "CPU utilization > 0%",
      "FirstOccurTime": 1603117860,
      "LastOccurTime": 1603162964,
      "AlarmStatus": "ALARM",
      "PolicyId": "policy-abc02",
      "PolicyName": "CVM alarm policy 2",
      "VPC": "0",
      "ProjectId": 0,
      "ProjectName": "Default project",
      "InstanceGroup": [
        {
          "Id": 430,
          "Name": "example-instance-group"
        }
      ],
      "ReceiverUids": [],
      "ReceiverGroups": [],
      "NoticeWays": [],
      "EventId": 0,
      "AlarmType": "METRIC",
      "OriginId": "1276973",
      "Region": "gz",
      "PolicyExists": 1,
      "MetricsInfo": null
    }
  ],
  "RequestId": "4bzogxhgsgs95hgmxne5ei6y9jjxvi1f",
  "TotalCount": 486
}
}

Example2 Querying the alarm records of “CVM - Basic Monitor”

Monitoring type is a first-level filter, and policy type is a second-level filter. Therefore, the policy type is meaningful only after the monitoring type is specified in the Namespaces field.

To query the alarm records of “CVM - Basic Monitor”, the filter conditions should be: Tencent Cloud service monitoring for Monitoring type and CVM - Basic Monitor for policy type.

Enter ["MT_QCE"] for MonitorTypes as the first-level filter condition.

Enter [{"MonitorType": "MT_QCE", "Namespace": "cvm_device"}] for Namespaces as the second-level filter condition.

Input Example

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmHistories
<Common request parameters>
{
  "Module": "monitor",
  "PageNumber": 1,
  "PageSize": 10,
  "StartTime": 1598976507,
  "EndTime": 1599019707,
  "MonitorTypes": [
      "MT_QCE"
  ],
  "Namespaces": [
      {
          "MonitorType": "MT_QCE",
          "Namespace": "cvm_device"
      }
  ]
}

Output Example

{
"Response": {
  "Histories": [
    {
      "AlarmId": "c36494f8-ae38-45cb-8089-e14006bcfc67",
      "MonitorType": "MT_QCE",
      "Namespace": "cvm_device",
      "AlarmObject": "10.104.126.8 (private) | CVM 01 | Classic network",
      "Content": "CPU utilization > 0%",
      "FirstOccurTime": 1603117860,
      "LastOccurTime": 1603162964,
      "AlarmStatus": "ALARM",
      "PolicyId": "policy-abc01",
      "PolicyName": "CVM alarm policy 1",
      "VPC": "0",
      "ProjectId": 0,
      "ProjectName": "Default project",
      "InstanceGroup": [
        {
          "Id": 430,
          "Name": "example-instance-group"
        }
      ],
      "ReceiverUids": [],
      "ReceiverGroups": [
        1544
      ],
      "NoticeWays": [
        "SMS",
        "EMAIL",
        "WECHAT"
      ],
      "EventId": 0,
      "AlarmType": "METRIC",
      "OriginId": "1278441",
      "Region": "gz",
      "PolicyExists": 1,
      "MetricsInfo": [
        {
          "QceNamespace": "qce/cvm",
          "MetricName": "CpuUsage",
          "Period": 60,
          "Value": "86.5",
          "Description": "CPU utilization"
        }
      ]
    },
    {
      "AlarmId": "779d129a-40a1-4acf-b226-d9c2ae26e63b",
      "MonitorType": "MT_QCE",
      "Namespace": "cvm_device",
      "AlarmObject": "10.104.126.9 (private) | CVM 02 | Classic network",
      "Content": "CPU utilization > 0%",
      "FirstOccurTime": 1603117860,
      "LastOccurTime": 1603162964,
      "AlarmStatus": "ALARM",
      "PolicyId": "policy-abc02",
      "PolicyName": "CVM alarm policy 2",
      "VPC": "0",
      "ProjectId": 0,
      "ProjectName": "Default project",
      "InstanceGroup": [
        {
          "Id": 430,
          "Name": "example-instance-group"
        }
      ],
      "ReceiverUids": [],
      "ReceiverGroups": [],
      "NoticeWays": [],
      "EventId": 0,
      "AlarmType": "METRIC",
      "OriginId": "1276973",
      "Region": "gz",
      "PolicyExists": 1,
      "MetricsInfo": null
    }
  ],
  "RequestId": "4bzogxhgsgs95hgmxne5ei6y9jjxvi1f",
  "TotalCount": 486
}
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

Command Line Interface

• Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.