graphprototype.get

Descrição

integer/array graphprototype.get(object parameters)

O método permite recuperar protótipos de gráficos de acordo com os parâmetros fornecidos.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

Parameter Type Description
discoveryids ID/array Retorna apenas protótipos de gráfico que pertencem às regras de descoberta informadas.
graphids ID/array Retorna apenas protótipos de gráfico com os IDs informados.
groupids ID/array Retorna apenas protótipos de gráfico que pertencem a hosts ou templates nos grupos de hosts ou grupos de templates informados.
hostids ID/array Retorna apenas protótipos de gráfico que pertencem aos hosts informados.
inherited boolean Se definido como true, retorna apenas protótipos de gráfico herdados de um template.
itemids ID/array Retorna apenas protótipos de gráfico que contêm os protótipos de item informados.
templated boolean Se definido como true, retorna apenas protótipos de gráfico que pertencem a templates.
templateids ID/array Retorna apenas protótipos de gráfico que pertencem aos templates informados.
selectDiscoveryRule query Retorna uma propriedade discoveryRule com a regra LLD à qual o protótipo de gráfico pertence.
selectGraphItems query Retorna uma propriedade gitems com os itens de gráfico usados no protótipo de gráfico.
selectHostGroups query Retorna uma propriedade hostgroups com os grupos de hosts aos quais o protótipo de gráfico pertence.
selectHosts query Retorna uma propriedade hosts com os hosts aos quais o protótipo de gráfico pertence.
selectItems query Retorna uma propriedade items com os items e protótipos de item usados no protótipo de gráfico.
selectTemplateGroups query Retorna uma propriedade templategroups com os grupos de templates aos quais o protótipo de gráfico pertence.
selectTemplates query Retorna uma propriedade templates com os templates aos quais o protótipo de gráfico pertence.
filter object Retorna apenas os resultados que correspondem exatamente ao filtro informado.

Aceita um objeto, em que as chaves são nomes de propriedades e os valores são um único valor ou uma matriz de valores para comparação.

Não suporta propriedades do tipo de dados text.

Suporta propriedades adicionais:
host - nome técnico do host ao qual o protótipo de gráfico pertence;
hostid - ID do host ao qual o protótipo de gráfico pertence.
sortfield string/array Classifica o resultado pelas propriedades informadas.

Valores possíveis: graphid, name, graphtype, discovered.
countOutput boolean Esses parâmetros são descritos no comentário de referência.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(deprecated)		 query Este parâmetro está obsoleto; use selectHostGroups ou selectTemplateGroups em seu lugar.
Retorna uma propriedade groups com os grupos de hosts e grupos de templates aos quais o protótipo de gráfico pertence.

Valores de retorno

(integer/array) Retorna:

  • um array de objetos;
  • a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Recuperando protótipos de gráfico de uma regra de LLD

Recupere todos os protótipos de gráfico de uma regra de LLD.

Request:

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

Response:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "graphid": "1017",
            "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
}

Veja também

Fonte

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