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

查询云硬盘总数列表

功能介绍

查询云硬盘个数,总容量以及所有metadata信息。

请求版本号需要为3.12及以上。

URI

  • URI格式

    GET /v3/{project_id}/volumes/summary

  • 参数说明

    参数

    是否必选

    描述

    project_id

    项目ID。

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

请求消息

  • 请求样例:
    GET https://{endpoint}/v3/{project_id}/volumes/summary

响应消息

  • 响应参数

    参数

    参数类型

    描述

    volume-summary

    Object

    查询请求返回的云硬盘总数详情,请参见•volume-summary参数说明

  • volume-summary参数说明

    参数

    参数类型

    描述

    total_size

    Integer

    云硬盘总容量,单位为GB。

    total_count

    Integer

    云硬盘总个数。

    metadata

    Object

    云硬盘所有的metadata信息。请求版本号为3.36及以上支持该参数。

  • 响应样例
    {
        "volume-summary": {
            "total_size": 83, 
            "total_count": 8, 
            "metadata": {}
        }
    }
    { 
        "error": { 
            "message": "XXXX",  
            "code": "XXX" 
        } 
    }
    其中error是泛指的错误,有badRequest、itemNotFound等,如报错:
    {  
        "badRequest": {  
            "message": "XXXX",  
            "code": "XXX"  
        }  
    }

状态码

  • 正常

    200

错误码

请参考错误码