查询空间下资源列表

更新时间:2024-09-10 01:49:16

本文介绍查询空间下资源列表的 API。

接口描述

查询空间下资源列表。若指定 only_subfalse,则查询当前空间及所有子空间下的资源列表,否则仅查询当前空间下的资源列表。

接口地址

GET: /v2.0/cloud/space/{space_id}/resource

请求参数

参数名类型参数位置是否必填说明
space_idLonguritrue空间 ID。
only_subBooleanqueryfalse是否仅查询直接子节点。
last_row_keyLongqueryfalse起始查询 ID。
page_sizeIntegerqueryfalse单页数据量。

返回参数

参数名类型说明
successBoolean请求是否成功。
  • true:请求成功。
  • false:请求失败。
error_codeString详见错误码。
error_msgString错误信息,成功时为空。
resultObject返回结果。

result 说明

参数名类型说明
dataList资源列表。
last_row_keyLong起始查询 ID。
page_sizeInteger单页数据量大小。

data 说明

参数名类型说明
res_idString资源 ID,由资源类型决定含义。例如,资源类型为 0 时代表设备,等价于 device_id
res_typeInteger资源类型。
  • 0:代表资源为设备。

请求示例

GET: /v2.0/cloud/space/15000***/resource?onlySub=true&lastRowKey=0&pageSize=100

返回示例

{
    "result": {
        "last_row_key": 0,
        "data": [
            {
                "resType": 0,
                "resId": "vdevo167102917612***"
            },
            {
                "resType": 0,
                "resId": "vdevo167102921401***"
            }
        ],
        "page_size": 200
    },
    "success": true
}

错误码

参考 错误码

调用频率限制

参考 调用频率限制