image.update

描述

object image.update(object/array images)

此方法允许update现有镜像.

此方法仅适用于超级管理员用户类型. 调用该方法的权限可在用户角色设置中撤销. 详见 User roles 获取更多信息.

参数

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

imageid 属性必须为每个图像定义，所有其他属性都是可选的。 只有传递的属性会被更新，其他所有属性将保持不变。

该方法接受具有图像的图像。

返回值

(object) 返回一个包含更新图像ID的object， 这些ID位于imageids属性下。

示例

重命名图像

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

执行请求:

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

响应:

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

来源

CImage::update() 位于 ui/include/classes/api/services/CImage.php 文件中。