Table of Contents
附录1.参考
注释
数据类型
Zabbix API支持以下数据类型：
| Type | Description |
|---|---|
| bool | 布尔值，接受true或false。 |
| flag | 如果它被传递而不等于 null 和 false，该值被认为是 true 。 |
| integer | 一个整数。 |
| float | 浮点数。 |
| string | 文本字符串。 |
| text | 较长的文本字符串。 |
| timestamp | Unix时间戳。 |
| array | 有序的值序列，即数组。 |
| object | 关联数组。 |
| query | 用于定义应返回哪些数据的值。 可以定义为一个属性名称数组，仅返回特定属性，或者作为预定义值之一： extend - 返回所有对象属性;count - 返回检索的记录数，仅由某些子选择器支持。 |
属性标签
一些对象属性用短标签标记以描述它们的行为。使用以下标签：
- readonly - 一些对象属性用短标签标记以描述它们的行为。使用以下标签：
- constant - 属性的值可以在创建对象时设置，但不能在之后更改。
常用的“get”方法参数
所有get方法都支持以下参数：
| Parameter | Type | Description |
|---|---|---|
| countOutput | flag | 返回结果中的记录数，而不是实际数据。 |
| editable | boolean | 如果设置为 true 仅返回用户有写权限的对象。默认值： false. |
| excludeSearch | flag | 返回与参数中给定的条件不匹配的结果 search 。 |
| filter | object | 仅返回与给定过滤器完全匹配的结果。 接受数组，其中键是属性名，值可以是单个值或要匹配的值的数组。 不适用于 text 。 |
| limit | integer | 限制返回的记录数。 |
| output | query | 要返回的对象属性。 默认值： extend. |
| preservekeys | flag | 在结果数组中使用ID作为键。 |
| search | object | 返回与给定通配符搜索匹配的结果。 接受数组，其中键是属性名，值是要搜索的字符串。如果没有给出额外的选项，这将执行 LIKE "%…%" 搜索。仅适用于 string 和 text 。 |
| searchByAny | boolean | 如果设置为true 返回与 filter 或search 参数中给定的任何条件匹配的结果，"search"而不是所有条件默认值： false. |
| searchWildcardsEnabled | boolean | 如果设置为 true 启用在参数中使用 "*" 作为通配符 search 。默认值： false。 |
| sortfield | string/array | 按给定属性对结果排序。 请参阅特定的API get方法说明，以获取可用于排序的属性列表。宏在排序之前不会展开。 |
| sortorder | string/array | 排序顺序。如果传递数组，每个值都将匹配参数中给定的相应 sortfield 属性。可能的值为： ASC - 升序;DESC - 降序。 |
| startSearch | flag | search 参数将比较字段的开始，即执行 LIKE "…%" 搜索。 |