dservice.get

Descrição

integer/array dservice.get(object parameters)

O método permite recuperar serviços descobertos de acordo com o parâmetros.

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 seguintes parâmetros.

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

Suporta count.
limitSelects integer Limite o número de registros retornados por subseleções.

Aplica-se às seguintes subseleções:
selectHosts - o resultado será classificado por hostid.
sortfield string/array Ordenar o resultado pelas propriedades fornecidas.

Os valores possíveis são: dserviceid, dhostid e ip.
countOutput boolean Estes 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
filtro objeto
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

Recuperar serviços descobertos em um host

Recuperar todos os serviços descobertos detectados no host descoberto "11". Requisição:

{
    "jsonrpc": "2.0",
    "method": "dservice.get",
    "params": {
        "output": "extend",
        "dhostids": "11"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "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.