Update Message Rules¶
修改消息规则。
请求格式¶
POST https://{apigw-address}/app-portal-service/v2.2/message-service/rule/update
请求参数（Header）¶
名称 |
必需/可选 |
数据类型 |
描述 |
|---|---|---|---|
Authorization |
可选 |
String |
身份识别。 |
请求参数（URI）¶
名称 |
必需/可选 |
数据类型 |
描述 |
|---|---|---|---|
orgId |
必需 |
String |
组织 ID。 |
请求参数（Body）¶
名称 |
必需/可选 |
数据类型 |
描述 |
|---|---|---|---|
ruleId |
必需 |
String |
消息规则 ID。 |
ruleName |
可选 |
String |
消息规则名称。 |
isEnable |
可选 |
String |
是否启用规则。0为禁用，1为启用。 |
messageRule |
必需 |
Object |
消息规则。 |
relations |
可选 |
relationDTO 结构体 |
规则关联的用户或用户组。 |
relationDTO 结构体¶
名称 |
必需/可选 |
数据类型 |
描述 |
|---|---|---|---|
type |
可选 |
Integer |
类型。0为用户，1为用户组。 |
identifiers |
可选 |
List |
用户或用户组 ID。 |
响应参数¶
名称 |
数据类型 |
描述 |
|---|---|---|
data |
Boolean |
返回 true：更新成功；返回 false：更新失败。 |
错误码¶
代码 |
描述 |
|---|---|
31400 |
组织 ID 为空，类型参数或是否启用参数不合法等。 |
31404 |
组织、应用、用户、用户组或消息规则不存在，或应用未被组织获取。 |
31600 |
消息规则内容异常。 |
31601 |
用户消息规则数量超过阈值。 |
31602 |
规则中 mark 数量超过阈值。 |
31603 |
消息规则不匹配。 |
31604 |
消息规则 mark 为空。 |
31607 |
用户组织结构错误。 |
示例¶
请求示例¶
url: https://{apigw-address}/app-portal-service/v2.2/message-service/rule/update?orgId=your_org_id
method: POST
requestBody:
{
"ruleId": "your_rule_id",
"ruleName": "your_rule_name",
"isEnable": 0,
"messageRule": {
"mark1": ["siteA","siteB"],
"mark2": ["deviceA","deviceB"],
"mark3": ["fault"],
"mark4": [""],
"mark6": null
},
"relations": [
{
"type": 0,
"identifiers": ["your_user_id_1","your_user_id_2"]
},
{
"type": 1,
"identifiers": ["your_user_group_id"]
}
]
}
返回示例¶
{
"code": 0,
"message": "OK",
"data": true
}