dservice.get

Descrição

integer/array dservice.get(object parameters)

O método permite recuperar serviços descobertos 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.

Parâmetro Tipo Descrição
dserviceids ID/array Retorna apenas os serviços descobertos com os IDs fornecidos.
dhostids ID/array Retorna apenas os serviços descobertos que pertencem aos hosts descobertos fornecidos.
dcheckids ID/array Retorna apenas os serviços descobertos que foram detectados pelas verificações de descoberta fornecidas.
druleids ID/array Retorna apenas os serviços descobertos que foram detectados pelas regras de descoberta fornecidas.
selectDRules query Retorna uma propriedade drules com um array das regras de descoberta que detectaram o serviço.
selectDHosts query Retorna uma propriedade dhosts com um array dos hosts descobertos aos quais o serviço pertence.
selectHosts query Retorna uma propriedade hosts com os hosts com o mesmo endereço IP e proxy que o serviço.

Suporta count.
limitSelects integer Limita o número de registros retornados por subconsultas.

Aplica-se às seguintes subconsultas:
selectHosts - o resultado será ordenado por hostid.
sortfield string/array Ordena o resultado pelas propriedades fornecidas.

Valores possíveis: dserviceid, dhostid, ip.
countOutput boolean Esses parâmetros são descritos no comentário de referência.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valores de retorno

(integer/array) Retorna:

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

Exemplos

Recuperar serviços descobertos em um host

Recupera todos os serviços descobertos detectados no host descoberto "11".

Requisição:

{
    "jsonrpc": "2.0",
    "method": "dservice.get",
    "params": {
        "output": "extend",
        "dhostids": "11"
    },
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "dserviceid": "12",
            "dhostid": "11",
            "value": "",
            "port": "80",
            "status": "1",
            "lastup": "0",
            "lastdown": "1348650607",
            "dcheckid": "5",
            "ip": "192.168.1.134",
            "dns": "john.local"
        },
        {
            "dserviceid": "13",
            "dhostid": "11",
            "value": "",
            "port": "21",
            "status": "1",
            "lastup": "0",
            "lastdown": "1348650610",
            "dcheckid": "6",
            "ip": "192.168.1.134",
            "dns": "john.local"
        }
    ],
    "id": 1
}

Veja também

Fonte

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