image.update

描述

object image.update(object/array images)

此方法允许更新现有图像。

::: noteclassic 此方法仅适用于超级管理员用户类型。 调用该方法的权限可在用户角色设置中撤销。详情参见 User roles ::

参数

(object/array) 需要更新的图片属性

每个图片必须定义imageid属性,其他属性均为可选。仅传递的属性会被更新,其余属性将保持不变。

除了图像外,该方法还接受以下参数:

参数 数据类型 描述
image string Base64编码的图片。编码后图片的最大尺寸为1 MB。可通过修改ZBX_MAX_IMAGE_SIZE常量值调整最大尺寸。
支持的图片格式包括:PNG、JPEG、GIF。

返回值

(object) 返回一个包含更新图片ID的object,存储在imageids属性下。

示例

重命名图像

将图片重命名为"云图标"。

请求:

{
           "jsonrpc": "2.0",
           "method": "image.update",
           "params": {
               "imageid": "2",
               "name": "Cloud icon"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应:

{
           "jsonrpc": "2.0",
           "result": {
               "imageids": [
                   "2"
               ]
           },
           "id": 1
       }

ui/include/classes/api/services/CImage.php 中的 CImage::update() 方法