获取

描述

integer/array regexp.get(object parameters)

该方法允许根据给定的参数检索全局正则表达式。

此方法仅适用于超级管理员。调用该方法的权限可以在用户角色设置中撤销。有关更多信息,请参阅用户角色

参数

(object) 定义所需输出的参数。

该方法支持以下参数。

参数类型说明
regexpidsID/array仅返回具有给定 ID 的正则表达式。
selectExpressionsquery返回 expressions 属性。
sortfieldstring/array按给定属性对结果进行排序。

可能的值:regexpidname
countOutputboolean这些参数对于所有 get 方法都是通用的,在 参考注释 中有详细描述。
editableboolean
excludeSearchboolean
filterobject
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

返回值

(integer/array) 返回以下任一值:

  • 对象数组;
  • 如果已使用 countOutput 参数,则返回检索到的对象的数量。

参考示例

检索全局正则表达式。

请求:

  1. {
  2. "jsonrpc": "2.0",
  3. "method": "regexp.get",
  4. "params": {
  5. "output": ["regexpid", "name"],
  6. "selectExpressions": ["expression", "expression_type"],
  7. "regexpids": [1, 2],
  8. "preservekeys": true
  9. },
  10. "id": 1
  11. }

响应:

  1. {
  2. "jsonrpc": "2.0",
  3. "result": {
  4. "1": {
  5. "regexpid": "1",
  6. "name": "File systems for discovery",
  7. "expressions": [{
  8. "expression": "^(btrfs|ext2|ext3|ext4|reiser|xfs|ffs|ufs|jfs|jfs2|vxfs|hfs|apfs|refs|ntfs|fat32|zfs)$",
  9. "expression_type": "3"
  10. }]
  11. },
  12. "2": {
  13. "regexpid": "2",
  14. "name": "Network interfaces for discovery",
  15. "expressions": [{
  16. "expression": "^Software Loopback Interface",
  17. "expression_type": "4"
  18. },
  19. {
  20. "expression": "^(In)?[Ll]oop[Bb]ack[0-9._]*$",
  21. "expression_type": "4"
  22. },
  23. {
  24. "expression": "^NULL[0-9.]*$",
  25. "expression_type": "4"
  26. },
  27. {
  28. "expression": "^[Ll]o[0-9.]*$",
  29. "expression_type": "4"
  30. },
  31. {
  32. "expression": "^[Ss]ystem$",
  33. "expression_type": "4"
  34. },
  35. {
  36. "expression": "^Nu[0-9.]*$",
  37. "expression_type": "4"
  38. }
  39. ]
  40. }
  41. },
  42. "id": 1
  43. }

参考来源

CRegexp::get() in ui/include/classes/api/services/CRegexp.php.