graph.get

Descrição

integer/array graph.get(object parameters)

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

Este método está disponível para usuários de qualquer tipo. Permissões para chamar o método pode ser revogado nas configurações de função do usuário. Veja Usuário funções Para maiores informações.

Parâmetros

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

O método oferece suporte aos parâmetros a seguir.

Parâmetro Tipo Descrição
graphids string/array Retorna apenas gráficos com os IDs fornecidos.
groupids string/array Retorna apenas gráficos que pertencem a hosts nos grupos de hosts especificados.
templateids string/array Retorna apenas o gráfico que pertence aos modelos fornecidos.
hostids string/array Retorna apenas os gráficos que pertencem aos hosts fornecidos.
itemids string/array Retorna apenas os gráficos que contêm os itens fornecidos.
templated boolean Se definido como true, retornará apenas os gráficos que pertencem aos modelos.
inherited boolean Se definido como true, retornará apenas os gráficos herdados de um modelo.
expandName flag Expandir macros no nome do gráfico.
selectGroups query Retorne uma propriedade groups com os grupos de hosts aos quais o gráfico pertence.
selectTemplates query Retorne uma propriedade templates com os templates aos quais o gráfico pertence.
selectHosts query Retorne uma propriedade hosts com os hosts aos quais o gráfico pertence.
selectItems query Retorne uma propriedade items com os itens usados no gráfico.
selectGraphDiscovery query Retorne uma propriedade graphDiscovery com o objeto de descoberta de gráfico. Os objetos de descoberta de gráfico vinculam o gráfico a um protótipo de gráfico a partir do qual ele foi criado.

Ele tem as seguintes propriedades:
graphid - (string) ID do gráfico;
parent_graphid - (string) ID do protótipo do gráfico a partir do qual o gráfico foi criado.
selectGraphItems query Retorne uma propriedade gitems com os itens usados no gráfico.
selectDiscoveryRule query Retorne uma propriedade discoveryRule com a regra de descoberta de baixo nível que criou o gráfico.
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 gráfico pertence;
hostid - ID do host ao qual o 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 na página 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 gráficos de hosts

Recupere todos os gráficos do host "10107" e classifique-os por nome.

Solicitação:

{
    "jsonrpc": "2.0",
    "método": "graf.get",
    "parâmetros": {
        "saída": "estender",
        "hostids": 10107,
        "sortfield": "nome"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "resultado": [
        {
            "grafid": "612",
            "name": "CPU salta",
            "largura": "900",
            "altura": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "modeloid": "439",
            "show_work_period": "1",
            "show_triggers": "1",
            "tipo de gráfico": "0",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "bandeiras": "0"
        },
        {
            "grafid": "613",
            "name": "Carga da CPU",
            "largura": "900",
            "altura": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "433",
            "show_work_period": "1",
            "show_triggers": "1",
            "tipo de gráfico": "0",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "1",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "bandeiras": "0"
        },
        {
            "grafid": "614",
            "name": "Utilização da CPU",
            "largura": "900",
            "altura": "200",
            "yaxismin": "0",
            "yaxismax": "100",
            "templateid": "387",
            "show_work_period": "1",
            "show_triggers": "0",
            "graphtype": "1",
            "show_legend": "1",
            "show_3d": "0",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "1",
            "ymax_type": "1",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "bandeiras": "0"
        },
        {
            "grafid": "645",
            "name": "Uso do espaço em disco /",
            "largura": "600",
            "altura": "340",
            "yaxismin": "0",
            "yaxismax": "0",
            "templateid": "0",
            "show_work_period": "0",
            "show_triggers": "0",
            "graphtype": "2",
            "show_legend": "1",
            "show_3d": "1",
            "percent_left": "0",
            "percent_right": "0",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "bandeiras": "4"
        }
    ],
    "id": 1
}

Veja também

Fonte

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