正则表达式.获取

说明

integer/array regexp.get(object parameters)

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

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

参数

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

该方法支持以下参数。

参数	类型	描述
regexpids	string/array	返回只有给定ID的正则表达式。
selectExpressions	query	返回一个表达式属性。
sortfield	string/array	根据给定的属性对结果进行排序。可能的值有：`regexpid` 和 `name`。
countOutput	boolean	这些参数对于所有 `获取` 方法都是通用的，详细描述在参考说明中。
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
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "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.

Documentation

正则表达式.获取

说明

参数

返回数值

参考示例

检索全局正则表达式。

参考来源