[comment]: # ({0d3af930-0d3af930})
# maintenance.get

[comment]: # ({/0d3af930-0d3af930})

[comment]: # ({a04dd4c9-a04dd4c9})
### 描述

`integer/array maintenance.get(object parameters)`

该方法允许根据给定参数检索维护周期。

::: noteclassic
此方法可供任何类型的用户使用。调用该方法的权限可在用户角色设置中撤销。更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)。

:::

[comment]: # ({/a04dd4c9-a04dd4c9})

[comment]: # ({a046a1c4-9ca798d7})
### 参数

`(object)` 定义所需输出的参数。

该方法支持以下参数。

| 参数 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| groupids | string/array | 仅返回分配给指定主机组的维护。 |
| hostids | string/array | 仅返回分配给指定主机的维护。 |
| maintenanceids | string/array | 仅返回具有指定ID的维护。 |
| selectGroups | query | 返回一个[groups](/manual/api/reference/hostgroup/object)属性，包含分配给维护的主机组。 |
| selectHosts | query | 返回一个[hosts](/manual/api/reference/host/object)属性，包含分配给维护的主机。 |
| selectTags | query | 返回一个[问题标签](/manual/api/reference/maintenance/object#问题标签)属性，包含维护的问题标签。 |
| selectTimeperiods | query | 返回一个[时间段](/manual/api/reference/maintenance/object#时间段)属性，包含维护的时间段。 |
| sortfield | string/array | 按给定属性对结果进行排序。<br><br>可能的值包括：`maintenanceid`、`name`和`maintenance_type`。 |
| countOutput | boolean | 这些参数在[通用get方法参数](/manual/api/reference_commentary#通用get方法参数)中有描述。 |
| editable | boolean | ^           |
| excludeSearch | boolean | ^           |
| filter | object | ^           |
| limit | integer | ^           |
| output | query | ^           |
| preservekeys | boolean | ^           |
| search | object | ^           |
| searchByAny | boolean | ^           |
| searchWildcardsEnabled | boolean | ^           |
| sortorder | string/array | ^           |
| startSearch | boolean | ^           |

[comment]: # ({/a046a1c4-9ca798d7})

[comment]: # ({7223bab1-7223bab1})
### 返回值

`(integer/array)` 返回以下两种情况之一:

-   一个由array组成的objects数组
-   检索到的objects数量（当使用了`countOutput`参数时）

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### 示例

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({f6631496-0b1cb387})
#### 检索维护周期

获取所有已配置的维护任务，以及相关分配的
主机 组、定义的时间段和问题标签数据。

请求:

```json
{
    "jsonrpc": "2.0",
    "method": "maintenance.get",
    "params": {
        "output": "extend",
        "selectGroups": "extend",
        "selectTimeperiods": "extend",
        "selectTags": "extend"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```
响应:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "maintenanceid": "3",
            "name": "Sunday maintenance",
            "maintenance_type": "0",
            "description": "",
            "active_since": "1358844540",
            "active_till": "1390466940",
            "tags_evaltype": "0",
            "groups": [
                {
                    "groupid": "4",
                    "name": "Zabbix servers",
                    "internal": "0"
                }
            ],
            "timeperiods": [
                {
                    "timeperiod_type": "3",
                    "every": "1",
                    "month": "0",
                    "dayofweek": "1",
                    "day": "0",
                    "start_time": "64800",
                    "period": "3600",
                    "start_date": "2147483647"
                }
            ],
            "tags": [
                {
                    "tag": "service",
                    "operator": "0",
                    "value": "mysqld",
                },
                {
                    "tag": "error",
                    "operator": "2",
                    "value": ""
                }
            ]
        }
    ],
    "id": 1
}
```

[comment]: # ({/f6631496-0b1cb387})

[comment]: # ({dbcf678a-dbcf678a})
### 另请参阅

-   [主机](/manual/api/reference/host/object#主机)
-   [主机组](/manual/api/reference/hostgroup/object#主机组)
-   [时间段](object#时间段)

[comment]: # ({/dbcf678a-dbcf678a})

[comment]: # ({50ed5be3-50ed5be3})
### 来源

CMaintenance::get() 位于
*ui/include/classes/api/services/CMaintenance.php* 文件中.

[comment]: # ({/50ed5be3-50ed5be3})