Zabbix Documentation 4.0

2.23.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.43.23.4

User Tools

Site Tools

This translation is older than the original page and might be outdated. See what has changed.

Sidebar

zh:manual:api:reference:valuemap:get

valuemap.get

说明

integer/array valuemap.get(object parameters)

该方法允许根据给定的参数来检索值映射。

Description

integer/array valuemap.get(object parameters)

The method allows to retrieve value maps according to the given parameters.

参数

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

该方法支持以下参数。

属性 类型 说明
valuemapids string/array 只返回具有给定ID的值映射。
selectMappings query 在“映射”属性中返回当前值映射的值映射。
sortfield string/array 按照给定的属性对结果进行排序。

可能的值为:valuemapidname
countOutput flag这些参数对于所有的“get”方法是常见的,在参考评论中有详细描述.
editable boolean
excludeSearch flag
filter object
limit integer
output query
preservekeys flag
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch flag

Return values

(integer/array) Returns either:

  • an array of objects;
  • the count of retrieved objects, if the countOutput parameter has been used.

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

Parameter Type Description
valuemapids string/array Return only value maps with the given IDs.
selectMappings query Return the value mappings for current value map in the mappings property.
sortfield string/array Sort the result by the given properties.

Possible values are: valuemapid, name.
countOutput booleanThese 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

Return values

(integer/array) Returns either:

  • an array of objects;
  • the count of retrieved objects, if the countOutput parameter has been used.

示例

Examples

Retrieving value maps

Retrieve all configured value maps.

Request:

{
    "jsonrpc": "2.0",
    "method": "valuemap.get",
    "params": {
        "output": "extend"
    },
    "auth": "57562fd409b3b3b9a4d916d45207bbcb",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "valuemapid": "4",
            "name": "APC Battery Replacement Status"
        },
        {
            "valuemapid": "5",
            "name": "APC Battery Status"
        },
        {
            "valuemapid": "7",
            "name": "Dell Open Manage System Status"
        }
    ],
    "id": 1
}

Retrieve one value map with its mappings.

Request:

{
    "jsonrpc": "2.0",
    "method": "valuemap.get",
    "params": {
        "output": "extend",
        "selectMappings": "extend",
        "valuemapids": ["4"]
    },
    "auth": "57562fd409b3b3b9a4d916d45207bbcb",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "valuemapid": "4",
            "name": "APC Battery Replacement Status",
            "mappings": [
                {
                    "value": "1",
                    "newvalue": "unknown"
                },
                {
                    "value": "2",
                    "newvalue": "notInstalled"
                },
                {
                    "value": "3",
                    "newvalue": "ok"
                },
                {
                    "value": "4",
                    "newvalue": "failed"
                },
                {
                    "value": "5",
                    "newvalue": "highTemperature"
                },
                {
                    "value": "6",
                    "newvalue": "replaceImmediately"
                },
                {
                    "value": "7",
                    "newvalue": "lowCapacity"
                }
            ]
        }
    ],
    "id": 1
}

来源

Source

CValueMap::get() in frontends/php/include/classes/api/services/CValueMap.php.