regexp.get

描述

integer/array regexp.get(object parameters)

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

此方法仅对超级管理员可用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参见User roles。

参数

(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) 返回以下之一：

array 的 objects；
如果使用了 countOutput 参数，则为检索到的 objects 的数量。

示例

检索全局正则表达式

执行请求:

{
           "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() 在 ui/include/classes/api/services/CRegexp.php 中。

Documentation

regexp.get

描述

参数

返回值

示例

检索全局正则表达式

来源