[
        {
            "description": "OperatingSystemCPUSystemUtilization",
            "driver": "PrometheusDatabaseDriver",
            "labelNames": [
                "BaremetalVMUuid",
                "CPUNum"
            ],
            "name": "OperatingSystemCPUSystemUtilization",
            "namespace": "ZStack/BaremetalVM"
        },
        {
            "description": "OperatingSystemCPUUserUtilization",
            "driver": "PrometheusDatabaseDriver",
            "labelNames": [
                "BaremetalVMUuid",
                "CPUNum"
            ],
            "name": "OperatingSystemCPUUserUtilization",
            "namespace": "ZStack/BaremetalVM"
        }
]

• namespace : metric所属的名字空间，用于将相同类型的metric归类
• name : metric名称
• labelNames : 标签名。标签用于过滤metric数据，例如metric DataVolumeCount表示主存储上的云盘数量，如果想知道某个主存储上的云盘数量，则可以指定PrimaryStorageUuid标签进行过滤

{
    "labels": [
        {
            "CPUNum": "0",
            "HostUuid": "a133cbcfdc1d462c9b51d7bce6ac6b11"
        },
        {
            "CPUNum": "1",
            "HostUuid": "a133cbcfdc1d462c9b51d7bce6ac6b11"
        },
        {
            "CPUNum": "2",
            "HostUuid": "a133cbcfdc1d462c9b51d7bce6ac6b11"
        },
        {
            "CPUNum": "3",
            "HostUuid": "a133cbcfdc1d462c9b51d7bce6ac6b11"
        },
        {
            "CPUNum": "4",
            "HostUuid": "a133cbcfdc1d462c9b51d7bce6ac6b11"
        },
        {
            "CPUNum": "5",
            "HostUuid": "a133cbcfdc1d462c9b51d7bce6ac6b11"
        },
        {
            "CPUNum": "6",
            "HostUuid": "a133cbcfdc1d462c9b51d7bce6ac6b11"
        },
        {
            "CPUNum": "7",
            "HostUuid": "a133cbcfdc1d462c9b51d7bce6ac6b11"
        }
    ],
    "success": true
}

{
    "data": [
        {
            "labels": {
                "HostUuid": "a133cbcfdc1d462c9b51d7bce6ac6b11"
            },
            "time": 1516363957,
            "value": 1678.9
        },
        {
            "labels": {
                "HostUuid": "a133cbcfdc1d462c9b51d7bce6ac6b11"
            },
            "time": 1516364017,
            "value": 1920.1000000000001
        }
    ],
    "success": true
}

• 其中value为double型的数据值，time是epoch time（单位秒），labels为标签组，可以用于过滤返回值。例如只获取UUID为a133cbcfdc1d462c9b51d7bce6ac6b11物理机的数据：

  GetMetricData namespace=ZStack/Host metricName=NetworkAllOutByte labels=HostUuid=a133cbcfdc1d462c9b51d7bce6ac6b11

• 标签支持=（等于）和=~正则两种匹配方式，可以用正则匹配多个标签值。例如返回UUID为a133cbcfdc1d462c9b51d7bce6ac6b11和506bd3b46a6543718488b5ba5850aaaa两个物理机的metric值，可以用：

  GetMetricData namespace=ZStack/Host metricName=NetworkAllOutByte labels=HostUuid=~a133cbcfdc1d462c9b51d7bce6ac6b11|506bd3b46a6543718488b5ba5850aaaa

• 可以传入多个标签作为过滤条件，例如：

  GetMetricData namespace=ZStack/PrimaryStorage metricName=SnapshotCount labels=PrimaryStorageUuid=b632652cc16044cdb6b4f516ed93a118,PrimaryStorageType=Ceph

• 可以通过startTime和endTime指定查询的时间范围：

  GetMetricData namespace=ZStack/PrimaryStorage metricName=SnapshotCount labels=PrimaryStorageUuid=b632652cc16044cdb6b4f516ed93a118,PrimaryStorageType=Ceph startTime=1516364017 endTime=1516365000

  Note: startTime/endTime均为epoch time。若都省略，默认返回最近1分钟内的数据。若endTime省略，则其值默认为当前时间。
• period用于指定返回数据的时间精度
• 可以通过functions传入一组函数对数据进行后处理，例如：

  GetMetricData namespace=ZStack/PrimaryStorage metricName=SnapshotCount labels=PrimaryStorageUuid=b632652cc16044cdb6b4f516ed93a118,PrimaryStorageType=Ceph startTime=1516364017 endTime=1516365000 functions=sort(by=\"value\"\\,direction=\"desc\")

• 这里使用sort函数对返回结果的value进行降序排序。传入多个函数时按顺序执行，例如：

  GetMetricData namespace=ZStack/PrimaryStorage metricName=SnapshotCount labels=PrimaryStorageUuid=b632652cc16044cdb6b4f516ed93a118,PrimaryStorageType=Ceph startTime=1516364017 endTime=1516365000 functions=sort(by=\"value\"\\,direction=\"desc\"),limit(limit=1)

  Note: 在CLI中需要对函数中的"用\转译，用于分隔函数参数的,需要用\\转译
• 先对数据排序，然后返回第一个数据。
  Note: 函数具体支持列表见附录

[{
    "metricName": "MySQLMaxConnections",
    "value": 1000,
    "labels": {
        "ip": "10.0.0.10"
    }
}]

• metricName: metric名称
• value: 整数或浮点数的数据值
• labels：自定义标签

[{
    "metricName": "MySQLMaxConnections",
    "value": 1000,
    "labels": {
        "ip": "10.0.0.10"
    }
}, {
    "metricName": "MySQLMemory",
    "value": 1999999999999,
    "labels": {
        "ip": "10.0.0.10"
    }
}]

{
    "events": [{
           "description": "VMStateChangedOnHost",
            "labelNames": [
                "OldState",
                "NewState",
                "SourceHostUuid",
                "DestinationHostUuid"
            ],
            "name": "VMStateChangedOnHost",
            "namespace": "ZStack/VM"
        },
        {
           "description": "VRouterDisconnected",
            "labelNames": [
                "Error"
            ],
            "name": "VRouterDisconnected",
            "namespace": "ZStack/VRouter"
        }
    ],
    "success": true
}

• namespace: 事件所在的namespace
• name: 事件名
• labelNames: 事件的标签名

{
    "events": [
        {
            "emergencyLevel": "Normal",
            "labels": {
                "NewStatus": "Connecting",
                "OldStatus": "Connected"
            },
            "name": "HostStatusChanged",
            "namespace": "ZStack/Host",
            "resourceId": "184eae9058f9477a91975f549b54f59f",
            "resourceName": "Host-1",
            "time": 1510984704006
        },
        {
            "emergencyLevel": "Normal",
            "labels": {
                "NewStatus": "Disconnected",
                "OldStatus": "Connecting"
            },
            "name": "HostStatusChanged",
            "namespace": "ZStack/Host",
            "resourceId": "184eae9058f9477a91975f549b54f59f",
            "resourceName": "Host-1",
            "time": 1510984704633
        }
    ],
    "success": true
}

• emergencyLevel：紧急程度，包含Major、Info和Emergent三种
• name：事件名称
• namespace：事件所在namespace
• resourceId：事件所发生资源的ID，如果为ZStack Cloud资源该ID为资源的UUID
• resourceName：事件所发生资源的名称
• time：事件发生的时间

{
  "inventory": {
    "uuid": "a6bed2b7c5154371a384f0f90dcd227e",
    "name": "VM CPU Alarm",
    "comparisonOperator": "LessThanOrEqualTo",
    "period": 60.0,
    "namespace": "ZStack/VM",
    "metricName": "org.zstack.zwatch.datatype.Metric@22c0dd63",
    "threshold": 30.0,
    "repeatInterval": 1800.0,
    "repeatCount": -1.0,
    "status": "Alarm",
    "state": "Enabled",
    "createDate": "Jan 8, 2019 4:08:43 PM",
    "lastOpDate": "Jan 8, 2019 4:08:43 PM",
    "labels": [
      {
        "uuid": "c74cb057092243ea8f838a1b4caec128",
        "key": "VMUuid",
        "operator": "\u003d",
        "value": "b5defee7d82f44c692d31e9a9d9e8e7f"
      }
    ],
    "actions": [
      {
        "alarmUuid": "433a94c9da494565a28dc4736e159297",
        "actionType": "sns",
        "actionUuid": "6d5583e8210445e3963c3784d550b8c2"
      }
    ]
  }
}

• namespace: metric所在namespace
• metricName：metric名称
• comparisonOperator：阈值比较符号，包括GreaterThanOrEqualTo(大于等于)，GreaterThan(大于)，LessThan(小于)，LessThanOrEqualTo(小于等于)四种。
• period：持续时间，单位秒
• repeatInterval：不重复报警时间，单位秒。用于在一段时间内重复报警。例如报警条件是1分钟内CPU利用率超过90%报警，但该虚拟机CPU利用率超过90%持续了10分钟，则用户会连续收到10条报警。若将repeatInterval设置成10分钟，则只会收到一条报警，设置成5分钟则收到两条报警。以此来避免alarm flooding。如该字段未设置，则默认为30分钟。用户可以通过设置zwatch.alarm.repeatInterval全局设置来调整该默认值。
• threshold：阈值，浮点数
• actions：报警动作。报警发生时系统执行的动作。目前只支持向SNS主题发送报警消息。报警动作结构为：

  {
  "actionUuid": "2447db65cb46495e87b53d9afbad6936",
  "actionType": "sns"
  }
  

  actionUuid为SNS主题的UUID，actionType为固定值sns。可以指定多个报警动作。

• labels：metric过滤标签。通过标签匹配特定的metric，例如对指定虚拟机报警需要设置VMUuid标签：

  {
      "key": "VMUuid",
      "operator": "Equal",
      "value": "1a1d7395cf74474ca52deb80c41214a1"
  }

  key为标签名；operator为标签比较符，支持Equal（等于）和Regex（正则）两种；value为标签值。可以指定多个标签。用户可以通过GetAllMetricMetadata获得每个metric支持的标签。

• OK：正常状态，metric数据没有触发报警
• Alarm：报警状态，metric数据已触发报警器
• InsufficientData：数据不足状态，metric还未采集到足够数据

{
    "inventories": [
        {
            "actions": [
                {
                    "actionType": "sns",
                    "actionUuid": "e7d6f5e23bb74e99a2777126078b551c",
                    "alarmUuid": "b632652cc16044cdb6b4f516ed93a118"
                }
            ],
            "comparisonOperator": "GreaterThanOrEqualTo",
            "createDate": "Jun 20, 2018 10:45:45 AM",
            "labels": [
                {
                    "key": "DirPath",
                    "operator": "Equal",
                    "uuid": "dfed592b822f46439195d7ce7728cdeb",
                    "value": "/var/lib/cloud/"
                }
            ],
            "lastOpDate": "Jun 20, 2018 10:45:45 AM",
            "metricName": "ManagementServerDirUsedCapacityInPercent",
            "name": "Cloud Data Directory Capacity Alarm",
            "namespace": "ZStack/System",
            "period": 60,
            "repeatInterval": 1800,
            "state": "Enabled",
            "status": "OK",
            "threshold": 70.0,
            "uuid": "b632652cc16044cdb6b4f516ed93a118"
        }
    ],
    "success": true
}

ChangeEventSubscriptionState uuid=f8906dd1ce5d4534b4c6b58900e795ef state=Disabled

• 报警器变量
  • ALARM_NAME：报警器名称
  • ALARM_UUID：报警器UUID
  • ALARMCOMPARISONOPERATOR： 报警器操作符
  • ALARM_METRIC：报警器metric名称
  • ALARM_NAMESPACE：报警器namespace名称
  • ALARM_THRESHOLD：报警器阈值
  • ALARMLABELS：报警器标签数组，用户可以使用*${ALARMLABELS.join(",")}*将标签组成一个以逗号分隔的字符串
  • ALARM_DURATION：metric值超过阈值持续时间
  • ALARMPREVIOUSSTATUS：报警器触发前的报警状态
  • ALARMCURRENTSTATUS： 报警器当前状态
  • ALARMCURRENTVALUE：报警器触发时的metric值
• 订阅事件变量
  • EVENT_NAMESPACE：事件namespace名称
  • EVENT_NAME：事件名称
  • EVENTLABELS：事件标签数组，用户可以使用*${EVENTLABELS.join(",")}*将标签组成一个以逗号分隔的字符串
  • EVENTEMERGENCYLEVEL：事件紧急程度
  • EVENTRESOURCEID：发生事件的资源ID
  • EVENTRESOURCENAME：发生事件的资源的名称
  • EVENT_ERROR：如果事件跟一个错误相关，例如引发物理机失联事件的错误（如网络错误），该字段包含错误的字符串表述。如果没有错误，该字段为“”空字符串
  • EVENT_TIME：事件发生的时间，字符串
  • PARAMEVENTSUBSCRIPTION_UUID：订阅事件的UUID