更新时间:2024-03-25 GMT+08:00

更新云硬盘的元数据

功能介绍

更新云硬盘的元数据。

URI

  • URI格式

    PUT /v2/{project_id}/volumes/{volume_id}/metadata

  • 参数说明

    参数

    是否必选

    描述

    project_id

    项目ID。

    获取方法请参见获取项目ID

    volume_id

    云硬盘ID。

请求消息

  • 请求参数

    参数

    参数类型

    是否必选

    描述

    metadata

    Map<String,String>

    需要更新的元数据信息,请参见•metadata参数说明

    metadata中的key和value长度不大于255个字节。

  • metadata参数说明

    参数

    参数类型

    是否必选

    描述

    key_val

    String

    一个或多个键值对形式的元数据信息。

  • 请求样例
    {
        "metadata": {
            "key1": "value1", 
            "key2": "value2"
        }
    }

响应消息

  • 响应参数

    参数

    参数类型

    描述

    metadata

    Object

    键值对,云硬盘的元数据信息。

    error

    Object

    出现错误时,返回的错误信息,具体请参见•error参数说明

  • error参数说明

    参数

    参数类型

    描述

    message

    String

    出现错误时,返回的错误消息。

    code

    String

    出现错误时,返回的错误码。

    错误码和其对应的含义请参考错误码

  • 响应样例
    {
        "metadata": {
            "key1": "value1", 
            "key2": "value2"
        }
    }

    {
        "error": {
            "message": "XXXX", 
            "code": "XXX"
        }
    }

    其中error是泛指的错误,有badrequest、itemNotFound等,如报错为:

    {
        "badrequest": {
            "message": "XXXX", 
            "code": "XXX"
        }
    }

状态码

  • 正常

    200

错误码

请参考错误码