참조 해설

표기법

데이터 유형

Zabbix API는 입력으로 다음 데이터 유형을 지원합니다.

속성 동작

일부 객체 속성은 그 동작을 설명하는 짧은 라벨로 표시됩니다. 다음 라벨이 사용됩니다.

• read-only - 속성 값이 자동으로 설정되며, 특정 조건에서도(예: 상속된 객체나 검색된 객체에 대해 read-only) 사용자가 정의하거나 변경할 수 없습니다;
• write-only - 속성 값을 설정할 수는 있지만, 이후에는 접근할 수 없습니다;
• constant - 속성 값을 객체 생성 시 설정할 수 있지만, 이후에는 변경할 수 없습니다;
• supported - 속성 값을 반드시 설정할 필요는 없지만, 특정 조건에서는 설정이 허용됩니다(예: type이 "Simple check", "External check", "SSH agent", "TELNET agent", 또는 "HTTP agent"로 설정된 경우 supported). 단, supported 속성은 조건과 관계없이 기본값으로 설정될 수 있습니다;
• required - 속성 값이 모든 작업(get 작업 제외)에 대해 또는 특정 조건에서(예: create 작업에 대해 required; operationtype이 "global script"로 설정되고 opcommand_hst가 설정되지 않은 경우 required) 반드시 설정되어야 합니다.

라벨이 표시되지 않은 속성은 선택 사항입니다.

매개변수 동작

일부 작업 매개변수는 해당 작업에 대한 동작을 설명하는 짧은 라벨로 표시됩니다. 다음 라벨이 사용됩니다.

• read-only - 매개변수 값이 자동으로 설정되며, 특정 조건에서도(예: 상속된 객체나 검색된 객체에 대해 read-only) 사용자가 정의하거나 변경할 수 없습니다;
• write-only - 매개변수 값을 설정할 수는 있지만, 이후에는 접근할 수 없습니다;
• supported - 매개변수 값을 반드시 설정할 필요는 없지만, 특정 조건에서는 설정이 허용됩니다(예: Proxy 객체의 operating_mode가 "passive proxy"로 설정된 경우 supported). 단, supported 매개변수는 조건과 관계없이 기본값으로 설정될 수 있습니다;
• required - 매개변수 값이 반드시 설정되어야 합니다.

라벨이 표시되지 않은 매개변수는 선택 사항입니다.

예약된 ID 값 "0"

예약된 ID 값 "0"은 요소를 필터링하고 참조된 객체를 제거하는 데 사용할 수 있습니다. 예를 들어, 호스트에서 참조된 프록시를 제거하려면 proxyid를 0으로 설정해야 하고("proxyid": "0"), 서버 옵션에 의해 모니터링되는 호스트를 필터링하려면 proxyids를 0으로 설정해야 합니다 ("proxyids": "0").

공통 "get" 메서드 매개변수

다음 매개변수는 모든 get 메서드에서 지원됩니다.

엔터티 출처 플래그

get 메서드는 로우레벨 디스커버리와 관련된 엔터티(LLD 규칙/LLD 규칙 프로토타입, 아이템/아이템 프로토타입 등)에 대해 flags 속성을 반환합니다. 이 속성은 검색된 엔터티에 대한 편집이 제한되므로 해당 엔터티가 검색되었는지 여부를 나타내는 데 유용합니다.

flags 속성은 다음 값들의 조합("+" 연산)을 기반으로 한 결과를 반환합니다.

flags 속성이 반환하는 조합된 값은 다음과 같습니다.

예시

사용자 권한 확인

사용자가 이름이 "MySQL" 또는 "Linux"로 시작하는 호스트에 쓰기 권한을 가지고 있습니까?

요청:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "countOutput": true,
        "search": {
            "host": ["MySQL", "Linux"]
        },
        "editable": true,
        "startSearch": true,
        "searchByAny": true
    },
    "id": 1
}

응답:

{
    "jsonrpc": "2.0",
    "result": "0",
    "id": 1
}

불일치 개수 세기

이름에 "ubuntu" 문자열이 포함되지 않은 호스트 수를 셉니다.

요청:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "countOutput": true,
        "search": {
            "host": "ubuntu"
        },
        "excludeSearch": true
    },
    "id": 1
}

응답:

{
    "jsonrpc": "2.0",
    "result": "44",
    "id": 1
}

와일드카드를 사용한 호스트 검색

이름에 "server" 단어가 포함되고 인터페이스 포트가 "10050" 또는 "10071"인 호스트를 찾습니다. 결과를 호스트 이름으로 내림차순 정렬하고 5개 호스트로 제한합니다.

요청:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["hostid", "host"],
        "selectInterfaces": ["port"],
        "filter": {
            "port": ["10050", "10071"]
        },
        "search": {
            "host": "*server*"
        },
        "searchWildcardsEnabled": true,
        "searchByAny": true,
        "sortfield": "host",
        "sortorder": "DESC",
        "limit": 5
    },
    "id": 1
}

응답:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostid": "50003",
            "host": "WebServer-Tomcat02",
            "interfaces": [
                {
                    "port": "10071"
                }
            ]
        },
        {
            "hostid": "50005",
            "host": "WebServer-Tomcat01",
            "interfaces": [
                {
                    "port": "10071"
                }
            ]
        },
        {
            "hostid": "50004",
            "host": "WebServer-Nginx",
            "interfaces": [
                {
                    "port": "10071"
                }
            ]
        },
        {
            "hostid": "99032",
            "host": "MySQL server 01",
            "interfaces": [
                {
                    "port": "10050"
                }
            ]
        },
        {
            "hostid": "99061",
            "host": "Linux server 01",
            "interfaces": [
                {
                    "port": "10050"
                }
            ]
        }
    ],
    "id": 1
}

"preservekeys"를 사용한 와일드카드 호스트 검색

이전 요청에 "preservekeys" 매개변수를 추가하면, 결과는 연관 배열로 반환되며, 키는 해당 객체의 id입니다.

요청:

{
    "jsonrpc": "2.0",
    "method": "host.get",
    "params": {
        "output": ["hostid", "host"],
        "selectInterfaces": ["port"],
        "filter": {
            "port": ["10050", "10071"]
        },
        "search": {
            "host": "*server*"
        },
        "searchWildcardsEnabled": true,
        "searchByAny": true,
        "sortfield": "host",
        "sortorder": "DESC",
        "limit": 5,
        "preservekeys": true
    },
    "id": 1
}

응답:

{
    "jsonrpc": "2.0",
    "result": {
        "50003": {
            "hostid": "50003",
            "host": "WebServer-Tomcat02",
            "interfaces": [
                {
                    "port": "10071"
                }
            ]
        },
        "50005": {
            "hostid": "50005",
            "host": "WebServer-Tomcat01",
            "interfaces": [
                {
                    "port": "10071"
                }
            ]
        },
        "50004": {
            "hostid": "50004",
            "host": "WebServer-Nginx",
            "interfaces": [
                {
                    "port": "10071"
                }
            ]
        },
        "99032": {
            "hostid": "99032",
            "host": "MySQL server 01",
            "interfaces": [
                {
                    "port": "10050"
                }
            ]
        },
        "99061": {
            "hostid": "99061",
            "host": "Linux server 01",
            "interfaces": [
                {
                    "port": "10050"
                }
            ]
        }
    },
    "id": 1
}