This is a translation of the original English documentation page. Help us make it better.

Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

dcheck.get

説明

integer/array dcheck.get(object parameters)

このメソッドは、指定されたパラメータに従って、ディスカバリーチェックを取得することができます。

このメソッドは、どのタイプのユーザーでも利用可能です。このメソッドを呼び出す許可は、ユーザーロール設定で
取り消すことができます。詳しくは User roles をご覧ください。

パラメータ

(object) 希望する出力を定義するパラメータ

このメソッドは、以下のパラメータをサポートしています。

パラメータ Type 説明
dcheckids string/array Return only discovery checks with the given IDs.
druleids string/array Return only discovery checks that belong to the given discovery rules.
dserviceids string/array Return only discovery checks that have detected the given discovered services.
sortfield string/array Sort the result by the given properties.

Possible values are: dcheckid and druleid.
countOutput boolean These parameters being common for all get methods are described in detail in the reference commentary.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

戻り値

(integer/array) のどちらかを返します。:

  • オブジェクトの配列
  • もし countOutput パラメータが使用されている場合は、取得したオブジェクトの数

ディスカバリールールのディスカバリーチェックを取得する

ディスカバリールール "6" で使用されるすべてのディスカバリーチェックを取得する。

Request:

{
           "jsonrpc": "2.0",
           "method": "dcheck.get",
           "params": {
               "output": "extend",
               "dcheckids": "6"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "dcheckid": "6",
                   "druleid": "4",
                   "type": "3",
                   "key_": "",
                   "snmp_community": "",
                   "ports": "21",
                   "snmpv3_securityname": "",
                   "snmpv3_securitylevel": "0",
                   "snmpv3_authpassphrase": "",
                   "snmpv3_privpassphrase": "",
                   "uniq": "0",
                   "snmpv3_authprotocol": "0",
                   "snmpv3_privprotocol": "0",
                   "host_source": "1",
                   "name_source": "0"            
               }
           ],
           "id": 1
       }

ソース

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