Documentation

graphprototype.get

Descrição

integer/array graphprototype.get(object parameters)

O método permite recuperar protótipos de grafos de acordo com as parâmetros.

Parâmetros

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

O método oferece suporte aos seguintes parâmetros.

|Parâmetro|Tipo|Descrição| |---------|----------------------------------- ------------|-----------| |discoveryids|string/array|Retorna apenas protótipos de gráfico que pertencem às regras de descoberta fornecidas.| |graphids|string/array|Retorna apenas protótipos de gráfico com os IDs fornecidos.| |groupids|string/array|Retorna apenas protótipos de gráfico que pertencem a hosts nos grupos de hosts fornecidos.| |hostids|string/array|Retorna apenas protótipos de gráfico que pertencem aos hosts fornecidos.| |inherited|boolean|Se definido como true, retornará apenas protótipos de gráfico herdados de um modelo.| |itemids|string/array|Retorna apenas protótipos de gráfico que contenham os protótipos de itens fornecidos.| |templated|boolean|Se definido como true, retornará apenas protótipos de gráficos que pertencem a templates.| |templateids|string/array|Retorna apenas protótipos de gráfico que pertencem aos modelos fornecidos.| |selectDiscoveryRule|query|Retorne uma propriedade discoveryRule com a regra LLD à qual o protótipo do gráfico pertence.| |selectGraphItems|query|Retorne uma propriedade gitems com os itens do gráfico usados no protótipo do gráfico.| |selectGroups|query|Retorne uma propriedade groups com os grupos de hosts aos quais o protótipo gráfico pertence.| |selectHosts|query|Retorne uma propriedade hosts com os hosts aos quais o protótipo gráfico pertence.| |selectItems|query|Retorne uma propriedade items com os items e item prototypes usados no protótipo do gráfico .| |selectTemplates|query|Retorne uma propriedade templates com os templates aos quais o protótipo gráfico pertence.| |filter|object|Retorna apenas os resultados que correspondem exatamente ao filtro fornecido.

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

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

Os valores possíveis são: graphid, name e graphtype.| |countOutput|boolean|Esses parâmetros sendo comuns para todos os métodos get são descritos em detalhes no comentário de referência.| |editável|booleano|^| |excludePesquisa|boolean|^| |limite|inteiro|^| |saída|consulta|^| |preservekeys|boolean|^| |pesquisar|objeto|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |ordem de classificação|cadeia/matriz|^| |startSearch|boolean|^|

Valores de retorno

(integer/array) Retorna:

• uma matriz 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 LLD

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

Solicitação:

{
           "jsonrpc": "2.0",
           "method": "graphprototype.get",
           "parâmetros": {
               "saída": "estender",
               "discoveryids": "27426"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Resposta:

{
           "jsonrpc": "2.0",
           "resultado": [
               {
                   "grafid": "1017",
                   "parent_itemid": "27426",
                   "name": "Uso de espaço em disco {#FSNAME}",
                   "largura": "600",
                   "altura": "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",
                   "descobrir": "0"
               }
           ],
           "id": 1
       }

Veja também

• Descoberta regra
• Item de gráfico
• Item
• Host
• Grupo de hosts
• Modelo

Fonte

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