更新时间:2022-01-22 GMT+08:00
分享

查询云硬盘快照详细信息列表

功能介绍

查询云硬盘快照详细列表信息。

URI

  • URI格式

    GET /v3/{project_id}/snapshots/detail

  • 参数说明

    参数

    是否必选

    描述

    project_id

    项目ID。

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

  • request filter参数说明

    参数

    参数类型

    是否必选

    描述

    marker

    String

    分页查询的起始资源id,取值为上一页最后一条查询记录的资源id。

    offset

    Integer

    偏移量。

    说明:

    分页查询快照时使用,与limit配合使用。假如共有30个快照,设置offset为11,limit为10,即为从第12个快照开始查询,一次最多可读取10个快照。

    limit

    Integer

    返回结果个数限制。

    最小值1,最大值1000,默认为1000。返回的结果中记录数不超过limit值。

    当租户所有的快照数量大于50个时,为了提升您的查询效率,建议查询的时候使用limit参数,并且参数值最大设置为50。查询示例:

    GET /v3/xxx/snapshots/detail?limit=50,表示查询第1~50个快照。GET /v3/xxx/snapshots/detail?offset=50&limit=50,表示查询第51~100个快照。

    name

    String

    云硬盘快照名称。最大支持255个字节。

    sort_dir

    String

    返回结果按照降序或升序排列,默认为“desc”。
    • 降序:desc
    • 升序:asc

    status

    String

    云硬盘快照状态,具体请参见云硬盘快照状态

    volume_id

    String

    云硬盘快照对应的云硬盘ID。

请求消息

以查询状态为available的云硬盘快照为例。

  • 请求样例
    GET https://{endpoint}/v3/{project_id}/snapshots/detail?status=available

响应消息

  • 响应参数

    参数

    参数类型

    描述

    snapshots

    Object

    快照信息,请参见•snapshots参数说明

    snapshots_links

    list<map<String,String>>

    云硬盘快照列表查询位置标记。当查询时指定limit时会返回该字段,返回该字段表示本次查询只查出了部分云硬盘快照信息。

    count

    Object

    查询返回结果的数量。

    error

    Object

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

  • snapshots参数说明

    参数

    参数类型

    描述

    id

    String

    云硬盘快照ID。

    status

    String

    云硬盘快照的状态,具体请参见云硬盘快照状态

    name

    String

    云硬盘快照名称。

    description

    String

    云硬盘快照描述信息。

    created_at

    String

    云硬盘快照创建时间。

    时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

    updated_at

    String

    云硬盘快照更新时间。

    时间格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX

    metadata

    Object

    云硬盘快照的元数据信息。

    如果元数据中包含__system__enableActive字段,则表示该快照为云服务器创建备份时自动生成的快照。

    volume_id

    String

    快照所属的云硬盘ID。

    size

    Integer

    云硬盘快照大小,单位为GB。

    os-extended-snapshot-attributes:project_id

    String

    租户ID。租户ID就是项目ID。

    os-extended-snapshot-attributes:progress

    String

    预留属性。

    user_id

    String

    预留属性。

  • error参数说明

    参数

    参数类型

    描述

    message

    String

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

    code

    String

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

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

  • 响应样例
    {
        
        "snapshots": [
            {
                "status": "available", 
                "os-extended-snapshot-attributes:progress": "100%", 
                "description": null, 
                "created_at": "2013-06-19T07:15:29.000000", 
                "metadata": { }, 
                "volume_id": "ae11e59c-bd56-434a-a00c-04757e1c066d", 
                "os-extended-snapshot-attributes:project_id": "d6c277ba8820452e83df36f33c9fa561", 
                "size": 5, 
                "id": "6cd26877-3ca3-4f4e-ae2a-38cc3d6183fa", 
                "name": "name_xx2-snap", 
                "updated_at": null, 
                "user_id": "48d70679b8644035846b2cb53633c256"
            }, 
            {
                "status": "available", 
                "os-extended-snapshot-attributes:progress": "100%", 
                "description": null, 
                "created_at": "2013-06-19T09:08:08.000000", 
                "metadata": { }, 
                "volume_id": "ae11e59c-bd56-434a-a00c-04757e1c066d", 
                "os-extended-snapshot-attributes:project_id": "d6c277ba8820452e83df36f33c9fa561", 
                "size": 5, 
                "id": "b3253e26-5c37-48dd-8bf2-8795dd1e848f", 
                "name": "name_xx2-snap", 
                "updated_at": null, 
                "user_id": "48d70679b8644035846b2cb53633c256"
            }
        ]
    }

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

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

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

状态码

  • 正常

    200

错误码

请参考错误码

分享:

    相关文档

    相关产品

关闭导读