module.get

Apraksts

integer/array module.get(object parameters)

Metode ļauj izgūt moduļus atbilstoši norādītajiem parametriem.

Šī metode ir pieejama tikai lietotāja tipam Super admin. Atļaujas izsaukt šo metodi var atsaukt lietotāja lomas iestatījumos. Plašāku informāciju skatiet Lietotāju lomas.
Ja $ZBX_FEATURE_FLAGS['modules_config_enabled'] ir iestatīts uz false lietotāja saskarnes konfigurācijas failā (zabbix.conf.php), lietotājam nebūs atļauts izsaukt šo metodi.

Parametri

(object) Parametri, kas nosaka vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parametrs Tips Apraksts
moduleids ID/array Atgriezt tikai moduļus ar norādītajiem ID.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: moduleid, relative_path.
countOutput boolean Šie parametri ir aprakstīti Atsauces komentārā.
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Atgrieztās vērtības

(integer/array) Atgriež vienu no šīm vērtībām:

  • objektu masīvu;
  • izgūto objektu skaitu, ja ir izmantots parametrs countOutput.

Piemēri

Moduļa izgūšana pēc ID

Izgūstiet visus datus par moduļiem "1", "2" un "25".

Pieprasījums:

{
    "jsonrpc": "2.0",
    "method": "module.get",
    "params": {
        "output": "extend",
        "moduleids": [
            "1",
            "2",
            "25"
        ]
    },
    "id": 1
}

Atbilde:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "moduleid": "1",
            "id": "actionlog",
            "relative_path": "widgets/actionlog",
            "status": "1",
            "config": []
        },
        {
            "moduleid": "2",
            "id": "clock",
            "relative_path": "widgets/clock",
            "status": "1",
            "config": []
        },
        {
            "moduleid": "25",
            "id": "example",
            "relative_path": "modules/example_module",
            "status": "1",
            "config": []
        }
    ],
    "id": 1
}

Skatiet arī

Avots

CModule::get() failā ui/include/classes/api/services/CModule.php.