跳转至主要内容
CloudStudio

使用参数获取提醒列表

此 API 可以使用参数获取提醒列表。

请求

GET /api/v2/alerts?clientID={clientID}&facilityID={facilityID}&deviceID={deviceID}&endpointID={endpointID}&maxCount={maxCount} HTTP/1.1
Host: gear.cloud.studio
Authorization: Bearer {accessToken}

参数

名称说明
accessToken具有提醒信息读取权限的访问令牌。更多信息请参见此页面。访问令牌也可以通过查询字符串中的 "accessToken" 参数发送。
clientID可选标识符,表示只获取指定客户的提醒。
facilityID可选标识符,表示只获取指定设施的提醒。
deviceID可选标识符,表示只获取指定设备的提醒。
endpointID可选标识符,表示只获取指定端点的提醒。
maxCount可选参数,表示结果中包含的最大提醒数。
必须包含 "clientID"、"facilityID"、"deviceID" 或 "endpointID" 参数中的一个(且只能一个)。

响应

响应包含匹配的提醒列表,如下例所示:

[
	{
		"AlertID": 211,
		"VariableTypeID": 1,
		"EndpointID": 114092,
		"ConditionType": 3,
		"Threshold": 25,
		"ClientID": 4,
		"FacilityID": 184,
		"NormalConditionType": 6,
		"NormalThreshold": 24,
		"MinimumDurationSeconds": 300,
		"NotificationEmails": ["someone@somewhere.com"],
		"NotificationSMSNumbers": ["+1123456789"],
		"NotificationVoiceNumbers": ["+1123456789"],
		"Tags": ["default", "gateway-default"],
		"SequenceNumber": 45701485,
		"Enabled": true,
		"Schedules": [],
        "Timezone": {
            "CurrentOffsetMinutes": -180,
            "TimeZoneCode": "america/argentina/buenos_aires"
        }
	},
	{
		"AlertID": 212,
		"VariableTypeID": 1,
		"EndpointID": 114092,
		"ConditionType": 5,
		"Threshold": 20,
		"ClientID": 4,
		"FacilityID": 184,
		"NormalConditionType": 3,
		"NormalThreshold": 22,
		"MinimumDurationSeconds": 300,
		"NotificationEmails": ["someone@somewhere.com"],
		"NotificationSMSNumbers": ["+1123456789"],
		"NotificationVoiceNumbers": ["+1123456789"],
		"Tags": ["default", "gateway-default"],
		"SequenceNumber": 45701485,
		"Enabled": true,
		"Schedules": [
            {
                "Days": [
                    1,
                    2,
                    4,
                    5
                ],
                "StartTime": {
                    "Hour": 0,
                    "Millisecond": 0,
                    "Minute": 0,
                    "Second": 0
                },
                "EndTime": {
                    "Hour": 23,
                    "Millisecond": 999,
                    "Minute": 0,
                    "Second": 59
                }
            }
        ],
        "Timezone": {
            "CurrentOffsetMinutes": -180,
            "TimeZoneCode": "america/argentina/buenos_aires"
        }
	}
]

最后更新于

本页内容