Search Message Rules¶

查询消息规则。

请求格式¶

POST https://{apigw-address}/app-portal-service/v2.2/message-service/rule/search

请求参数（URI）¶

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	OU ID。如何获取 orgId 信息 >>

请求参数（Body）¶

名称	必需/可选	数据类型	描述
appId	可选	String	应用的 Access Key。如不指定，默认返回 OU 内所有应用关联的消息规则。如何获取 Access Key >>
identifier	可选	String	用户或用户组 ID。如不指定，默认返回 OU 内所有对象关联的消息规则。
identifierType	可选	Integer	关联的对象类型。支持以下赋值： `0`：用户。 `1`：用户组。如不指定，默认返回所有类型的消息规则。
ruleIds	必需	List	消息规则 ID 列表。
createdBy	可选	String	消息规则的创建人。如不指定，默认返回 OU 内所有用户创建的消息规则。

响应参数¶

名称	数据类型	描述
messageRuleList	MessageRuleDTO 结构体	消息规则列表。MessageRuleDTO 结构体 >>

MessageRuleDTO 结构体¶

名称	数据类型	描述
appId	String	应用的 Access Key。
ruleId	String	消息规则 ID。
ruleName	String	消息规则名称。
relations	relationDTO 结构体	消息规则关联的用户或用户组。relationDTO 结构体 >>
messageRule	Object	消息规则的特定条件或标记，例如消息关联的资产、用户、事件类型等。键可自定义，规则内不可重复。值是字符串列表或 `null`。格式如 `"mark1": ["siteA","siteB"]`，表示当事件与 siteA 和 siteB 相关时，消息规则生效，应用门户将向关联的用户或用户组推送消息。
isEnable	Integer	规则是否启用。`true` 表示启用，`false` 表示禁用。
createdBy	String	创建人。
createdAt	String	创建时间。
updatedBy	String	更新人。
updatedAt	String	更新时间。

relationDTO 结构体¶

名称	数据类型	描述
type	Integer	对象的类型。`0` 表示用户，`1` 表示用户组。
identifiers	List	用户或用户组 ID。

错误码¶

代码	描述
31400	OU ID 为空。
31404	OU、应用或消息规则不存在，或 OU 未获取应用。
31600	消息规则内容异常。
31602	消息规则中的标记数量超过阈值。
31603	消息规则不匹配。
31604	消息规则中的标记为空。
31607	用户组织结构错误。

示例¶

请求示例¶

url: https://{apigw-address}/app-portal-service/v2.2/message-service/rule/search?orgId=your_org_id

method: POST

requestBody:
{
    "appId": "your_access_key",
    "ruleIds": ["your_rule_id_1","your_rule_id_2"],
    "identifier": "your_user_id",
    "identifierType": 0,
    "createdBy": "your_user_id"
}

返回示例¶

{
    "code": 0,
    "message": "OK",
    "data": {
        "messageRuleList": [
            {
                "appId": "",
                "ruleId": "",
                "ruleName": "",
                "relations": [
                    {
                        "type": 0,
                        "identifiers": ["your_user_id_1","your_user_id_2"]
                    },
                    {
                        "type": 1,
                        "identifiers": ["your_user_group_id"]
                    }
                ],
                "messageRule": {
                    "mark1": ["siteA","siteB"],
                    "mark2": ["deviceA","deviceB"],
                    "mark3": ["fault"],
                    "mark4": [""],
                    "mark6": null
                },
                "isEnable": 1,
                "createdBy": "your_user_id",
                "createdAt": "2021-01-01 00:00:00",
                "updatedBy": "your_user_id",
                "updatedAt": "2021-01-01 00:00:00"
            }
        ]
    }
}