查询存储设备列表

查询存储设备列表。

请求 URL

GET {base_url}/{api_path}/storage/list?access_token={access_token}

请求参数

无请求参数。直接发送请求 URL 查询存储设备列表。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。
total_number Integer 存储设备总数。
storage_list Array<Storage_Info> 存储设备的信息。
Storage_Info
参数 类型 说明
id Integer 存储设备的唯一 ID。
name String 存储设备的名称。
type String 存储设备的类型。
status String 存储设备的连接状态。
total String 存储设备的总容量。
available String 存储设备的可用容量。

示例

请求示例

GET /openapi/v1.0/storage/list?access_token=0PeFmQIk5q0NtsD5RyjTPPWOAZ7oeom1 HTTP/1.1 

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 2,
    "storage_list": [
        {
            "id": 1,
            "name": "LOCAL",
            "type": "local",
            "status": "connected",
            "total": "6.14G",
            "available": "5.47G"
        },
        {
            "id": 10,
            "name": "network drive",
            "type": "netdisk",
            "status": "connected",
            "total": "343.23G",
            "available": "100.05G"
        }
    ]
}