graphprototype.get

Опис

integer/array graphprototype.get(object parameters)

Метода омогућава преузимање прототипова графова према датим параметрима.

Ова метода је доступна корисницима било ког типа. Дозволе за позивање методе могу се опозвати у подешавањима улоге корисника. Погледајте Userroles за више информација.

Параметри

(object) Параметри који дефинишу жељени излаз.

Метод подржава следеће параметре.

Parameter Type Опис
discoveryids ID/array Врати само прототипове графикона који припадају датим правилима откривања.
graphids ID/array
groupids ID/array Врати само прототипове графикона који припадају домаћинима или шаблонима у датим групама домаћина или групама шаблона.
hostids ID/array Врати само прототипове графикона који припадају датим домаћинима.
inherited boolean Ако је подешено на true враћа само наслеђене прототипове графикона из шаблона.
itemids ID/array Врати само прототипове графикона који садрже дате прототипове ставки.
templated boolean Ако је подешено на true враћа само прототипове графикона који припадају шаблонима.
templateids ID/array Врати само прототипове графикона који припадају датим шаблонима.
selectDiscoveryRule query Врати својство discoveryRule са LLD правилом којем припада прототип графа то.
selectGraphItems query Врати својство gitems](/manual/api/reference/graphitem/object) са ставкама графикона које се користе у прототипу графикона.| |selectHostGroups|query|Врати [hostgroups](/manual/api/reference/hostgroup/object) својство са групама домаћина којима припада прототип графа.| |selectHosts|query|Врати [hosts](/manual/api/reference/host/object) својства са домаћинима којима припада прототип графикона.| |selectItems|query|Врати својствоitemsса [items](/manual/api/reference/item/object) и [item prototypes](/manual/api/reference/itemprototype/object) који се користи у прототипу графа.| |selectTemplateGroups|query|Врати својство [``templategroups са групама шаблона којима припада прототип графа.
selectTemplates query Врати својство `templates са шаблонима којима припада прототип графикона.
filter object
sortfield string/array Сортирај резултат према датим својствима.<бр><бр>Могуће вредности: graphid, name, graphtype.
countOutput boolean Ови параметри који су заједнички за све методе get су детаљно описани у reference commentary.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

COPY LINKNEXTPREVIOUS ### Parameters(object) Parameters defining the desired output.The method supports the following parameters.|Parameter|Type|Description||--|--|------||discoveryids|ID/array|Return only graph prototypes that belong to the given discovery rules.||graphids|ID/array|Return only graph prototypes with the given IDs.||groupids|ID/array|Return only graph prototypes that belong to hosts or templates in the given host groups or template groups.||hostids|ID/array|Return only graph prototypes that belong to the given hosts.||inherited|boolean|If set to true return only graph prototypes inherited from a template.||itemids|ID/array|Return only graph prototypes that contain the given item prototypes.||templated|boolean|If set to true return only graph prototypes that belong to templates.||templateids|ID/array|Return only graph prototypes that belong to the given templates.||selectDiscoveryRule|query|Return a discoveryRule property with the LLD rule that the graph prototype belongs to.||selectGraphItems|query|Return a gitems property with the graph items used in the graph prototype.||selectHostGroups|query|Return a hostgroups property with the host groups that the graph prototype belongs to.||selectHosts|query|Return a hosts property with the hosts that the graph prototype belongs to.||selectItems|query|Return an items property with the items and item prototypes used in the graph prototype.||selectTemplateGroups|query|Return a templategroups property with the template groups that the graph prototype belongs to.||selectTemplates|query|Return a templates property with the templates that the graph prototype belongs to.||filter|object|Return only those results that exactly match the given filter.

Accepts an object, where the keys are property names, and the values are either a single value or an array of values to match against.

Does not support properties of text data type.

Supports additional properties:
host - technical name of the host that the graph prototype belongs to;
hostid - ID of the host that the graph prototype belongs to.||sortfield|string/array|Sort the result by the given properties.

Possible values: graphid, name, graphtype.||countOutput|boolean|These parameters being common for all get methods are described in detail in the reference commentary.||editable|boolean|||excludeSearch|boolean|||limit|integer|||output|query|||preservekeys|boolean|||search|object|||searchByAny|boolean|||searchWildcardsEnabled|boolean|||sortorder|string/array|||startSearch|boolean|||selectGroups
(deprecated)|query|Овај параметар је застарео, користите selectHostGroups или selectTemplateGroups уместо тога.<бр>Вратите својство groups са групе домаћина и групе шаблона којима припада прототип графа.|

Повратне вредности

(integer/array) Враћа било:

  • низ објеката;
  • број преузетих објеката, ако је параметар countOutput коришћен.

Примери

Преузимање прототипова графикона из LLD правила

Преузми све прототипове графикона из LLD правила.

Request:

{
            "jsonrpc": "2.0",
            "method": "graphprototype.get",
            "params": {
            "output": "extend",
            "discoveryids": "27426"
            },
            "id": 1
       }

Одговор:

{
            "jsonrpc": "2.0",
            "result": [
            {
            "graphid": "1017",
            "parent_itemid": "27426",
            "name": "Disk space usage {#FSNAME}",
            "width": "600",
            "height": "340",
            "yaxismin": "0.0000",
            "yaxismax": "0.0000",
            "templateid": "442",
            "show_work_period": "0",
            "show_triggers": "0",
            "graphtype": "2",
            "show_legend": "1",
            "show_3d": "1",
            "percent_left": "0.0000",
            "percent_right": "0.0000",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "discover": "0"
            }
            ],
            "id": 1
       }

Погледајте такође

Извор

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