正则表达式.获取

说明

integer/array regexp.get(object parameters)

使用该方式允许用户根据提供的参数检索选定的全局正则表达式。

该方式仅对超级管理员类型的用户生效。 用户可以在用户角色设置中对该方式的使用权限进行设定修改。请参考 用户角色以获取更多信息。

参数

(object) 参数定义了用户想要获取的输出结果。

该方式支持下列所有参数配置。

参数类型说明
regexpids字符串/数组只返回带有固定ID的正则表达式。
selectExpressions搜索请求返回单个公式 属性。
sortfield字符串/数组以设定的属性对结果进行分类整理。
返回的可能数值为：regexpid 和name。
countOutput布尔值该类型参数普遍通过get的方式获取并详细描述在引用评论中。
editable布尔值
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.            "auth": "038e1d7b1735c6a5436ee9eae095879e",
  11.            "id": 1
  12.        }

响应：

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

参考来源

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