获取
描述
integer/array regexp.get(object parameters)
该方法允许根据给定的参数检索全局正则表达式。
此方法仅适用于超级管理员。调用该方法的权限可以在用户角色设置中撤销。有关更多信息，请参阅用户角色。
参数
(object) 定义所需输出的参数。
该方法支持以下参数。
| 参数 | 类型 | 说明 |
|---|---|---|
| regexpids | ID/array | 仅返回具有给定 ID 的正则表达式。 |
| selectExpressions | query | 返回 expressions 属性。 |
| sortfield | string/array | 按给定属性对结果进行排序。 可能的值： regexpid、name。 |
| countOutput | boolean | 这些参数对于所有 get 方法都是通用的，在 参考注释 中有详细描述。 |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
返回值
(integer/array) 返回以下任一值：
- 对象数组；
- 如果已使用
countOutput参数，则返回检索到的对象的数量。
参考示例
检索全局正则表达式。
请求:
{
"jsonrpc": "2.0",
"method": "regexp.get",
"params": {
"output": ["regexpid", "name"],
"selectExpressions": ["expression", "expression_type"],
"regexpids": [1, 2],
"preservekeys": true
},
"id": 1
}响应:
{
"jsonrpc": "2.0",
"result": {
"1": {
"regexpid": "1",
"name": "File systems for discovery",
"expressions": [{
"expression": "^(btrfs|ext2|ext3|ext4|reiser|xfs|ffs|ufs|jfs|jfs2|vxfs|hfs|apfs|refs|ntfs|fat32|zfs)$",
"expression_type": "3"
}]
},
"2": {
"regexpid": "2",
"name": "Network interfaces for discovery",
"expressions": [{
"expression": "^Software Loopback Interface",
"expression_type": "4"
},
{
"expression": "^(In)?[Ll]oop[Bb]ack[0-9._]*$",
"expression_type": "4"
},
{
"expression": "^NULL[0-9.]*$",
"expression_type": "4"
},
{
"expression": "^[Ll]o[0-9.]*$",
"expression_type": "4"
},
{
"expression": "^[Ss]ystem$",
"expression_type": "4"
},
{
"expression": "^Nu[0-9.]*$",
"expression_type": "4"
}
]
}
},
"id": 1
}参考来源
CRegexp::get() in ui/include/classes/api/services/CRegexp.php.