告警配置分页
接口地址:/api/yt/alarm/profile{?name,orderFiled,orderType,organizationId,page,pageSize,status}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
参数名称 | 参数说明 | 是否必须 | 数据类型 |
page | page | true | int |
pageSize | pageSize | true | int |
status | status | false | integer(int32) |
name | name | false | string |
organizationId | organizationId | false | string |
orderFiled | orderFiled | false | string |
orderType | orderType,可用值:ASC,DESC | false | string |
响应参数:
参数名称 | 参数说明 | 类型 |
items | array | |
alarmContactId | 告警联系人 通知多人“,”号分隔 | string |
createTime | 创建时间 | string(date-time) |
creator | 创建用户 | string |
defaultConfig | 租户默认配置 | string |
description | 租户描述 | string |
enabled | 租户状态:启用/禁用 | boolean |
icon | 租户图标 | string |
id | ID | string |
messageMode | 消息通知方式:多种方式“,”号分隔 MessageTypeEnum | string |
name | 告警配置名称 | string |
organizationId | 组织ID | string |
organizationName | 组织名称 | string |
remark | 告警配置备注 | string |
roleIds | 租户角色列表 | array |
status | 状态:0禁用 1启用 | integer(int32) |
tenantExpireTime | 租户到期时间 | string(date-time) |
tenantId | 租户ID | string |
tenantProfileId | 租户配置 | string |
tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
updateTime | 更新时间 | string(date-time) |
updater | 更新用户 | string |
total | integer(int32) |
响应示例:
{
"items": [
{
"alarmContactId": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"enabled": false,
"icon": "",
"id": "",
"messageMode": "",
"name": "",
"organizationId": "",
"organizationName": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
],
"total": 0
}
新增和编辑告警配置
接口地址:/api/yt/alarm/profile
请求方式:POST
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
请求示例:
{
"alarmContactId": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"enabled": false,
"icon": "",
"id": "",
"messageMode": "",
"name": "",
"organizationId": "",
"organizationName": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
alarmProfileDTO | AlarmProfileDTO | body | true | AlarmProfileDTO |
alarmContactId | 告警联系人 通知多人“,”号分隔 | true | string | |
createTime | 创建时间 | false | string(date-time) | |
creator | 创建用户 | false | string | |
defaultConfig | 租户默认配置 | false | string | |
description | 租户描述 | false | string | |
enabled | 租户状态:启用/禁用 | false | boolean | |
icon | 租户图标 | false | string | |
id | ID | false | string | |
messageMode | 消息通知方式:多种方式“,”号分隔 MessageTypeEnum | true | string | |
name | 告警配置名称 | true | string | |
organizationId | 组织ID | true | string | |
organizationName | 组织名称 | false | string | |
remark | 告警配置备注 | false | string | |
roleIds | 租户角色列表 | false | array | |
status | 状态:0禁用 1启用 | false | integer(int32) | |
tenantExpireTime | 租户到期时间 | false | string(date-time) | |
tenantId | 租户ID | false | string | |
tenantProfileId | 租户配置 | false | string | |
tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | false | string | |
updateTime | 更新时间 | false | string(date-time) | |
updater | 更新用户 | false | string |
响应参数:
参数名称 | 参数说明 | 类型 |
alarmContactId | 告警联系人 通知多人“,”号分隔 | string |
createTime | 创建时间 | string(date-time) |
creator | 创建用户 | string |
defaultConfig | 租户默认配置 | string |
description | 租户描述 | string |
enabled | 租户状态:启用/禁用 | boolean |
icon | 租户图标 | string |
id | ID | string |
messageMode | 消息通知方式:多种方式“,”号分隔 MessageTypeEnum | string |
name | 告警配置名称 | string |
organizationId | 组织ID | string |
organizationName | 组织名称 | string |
remark | 告警配置备注 | string |
roleIds | 租户角色列表 | array |
status | 状态:0禁用 1启用 | integer(int32) |
tenantExpireTime | 租户到期时间 | string(date-time) |
tenantId | 租户ID | string |
tenantProfileId | 租户配置 | string |
tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
updateTime | 更新时间 | string(date-time) |
updater | 更新用户 | string |
响应示例:
{
"alarmContactId": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"enabled": false,
"icon": "",
"id": "",
"messageMode": "",
"name": "",
"organizationId": "",
"organizationName": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
删除告警配置(待翻译)
接口地址:/api/yt/alarm/profile
请求方式:DELETE
请求数据类型:application/x-www-form-urlencoded,application/json
响应数据类型:*/*
请求示例:
{
"ids": [],
"tenantId": ""
}
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
deleteDTO | DeleteDTO | body | true | DeleteDTO |
ids | 删除ID列表 | true | array | |
tenantId | 租户ID | false | string |
响应参数:
参数名称 | 参数说明 | 类型 |
errorCode | Platform error code:\n2 – General error (HTTP: 500 – Internal Server Error)\n\n10 – Authentication failed (HTTP: 401 – Unauthorized)\n\n11 – JWT token expired (HTTP: 401 – Unauthorized)\n\n15 – Credentials expired (HTTP: 401 – Unauthorized)\n\n20 – Permission denied (HTTP: 403 – Forbidden)\n\n30 – Invalid arguments (HTTP: 400 – Bad Request)\n\n31 – Bad request params (HTTP: 400 – Bad Request)\n\n32 – Item not found (HTTP: 404 – Not Found)\n\n33 – Too many requests (HTTP: 429 – Too Many Requests)\n\n34 – Too many updates (Too many updates over Websocket session)\n\n* 40 – Subscription violation (HTTP: 403 – Forbidden) | object |
message | Error message | string |
status | HTTP Response Status Code | integer(int32) |
timestamp | Timestamp | string(date-time) |
更新告警配置状态
接口地址:/api/yt/alarm/profile/{alarmProfileId}/{status}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
alarmProfileId | alarmProfileId | path | true | string |
status | status | path | true | integer(int32) |
响应参数:
参数名称 | 参数说明 | 类型 |
alarmContactId | 告警联系人 通知多人“,”号分隔 | string |
createTime | 创建时间 | string(date-time) |
creator | 创建用户 | string |
defaultConfig | 租户默认配置 | string |
description | 租户描述 | string |
enabled | 租户状态:启用/禁用 | boolean |
icon | 租户图标 | string |
id | ID | string |
messageMode | 消息通知方式:多种方式“,”号分隔 MessageTypeEnum | string |
name | 告警配置名称 | string |
organizationId | 组织ID | string |
organizationName | 组织名称 | string |
remark | 告警配置备注 | string |
roleIds | 租户角色列表 | array |
status | 状态:0禁用 1启用 | integer(int32) |
tenantExpireTime | 租户到期时间 | string(date-time) |
tenantId | 租户ID | string |
tenantProfileId | 租户配置 | string |
tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
updateTime | 更新时间 | string(date-time) |
updater | 更新用户 | string |
响应示例:
{
"alarmContactId": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"enabled": false,
"icon": "",
"id": "",
"messageMode": "",
"name": "",
"organizationId": "",
"organizationName": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
获取组织下的告警配置
接口地址:/api/yt/alarm/profile/{organizationId}
请求方式:GET
请求数据类型:application/x-www-form-urlencoded
响应数据类型:*/*
请求参数:
参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
organizationId | organizationId | path | true | string |
响应参数:
参数名称 | 参数说明 | 类型 |
alarmContactId | 告警联系人 通知多人“,”号分隔 | string |
createTime | 创建时间 | string(date-time) |
creator | 创建用户 | string |
defaultConfig | 租户默认配置 | string |
description | 租户描述 | string |
enabled | 租户状态:启用/禁用 | boolean |
icon | 租户图标 | string |
id | ID | string |
messageMode | 消息通知方式:多种方式“,”号分隔 MessageTypeEnum | string |
name | 告警配置名称 | string |
organizationId | 组织ID | string |
organizationName | 组织名称 | string |
remark | 告警配置备注 | string |
roleIds | 租户角色列表 | array |
status | 状态:0禁用 1启用 | integer(int32) |
tenantExpireTime | 租户到期时间 | string(date-time) |
tenantId | 租户ID | string |
tenantProfileId | 租户配置 | string |
tenantStatus | 可用值:DISABLED,EXPIRED,NORMAL | string |
updateTime | 更新时间 | string(date-time) |
updater | 更新用户 | string |
响应示例:
[
{
"alarmContactId": "",
"createTime": "",
"creator": "",
"defaultConfig": "",
"description": "",
"enabled": false,
"icon": "",
"id": "",
"messageMode": "",
"name": "",
"organizationId": "",
"organizationName": "",
"remark": "",
"roleIds": [],
"status": 0,
"tenantExpireTime": "",
"tenantId": "",
"tenantProfileId": "",
"tenantStatus": "",
"updateTime": "",
"updater": ""
}
]