更新时间:2024-05-29 GMT+08:00

查询资源空间列表

功能介绍

资源空间对应的是物联网平台原有的应用,在物联网平台的含义与应用一致,只是变更了名称。应用服务器可以调用此接口查询资源空间列表。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v5/iot/{project_id}/apps

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数说明:项目ID

最小长度:0

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

default_app

Boolean

参数说明:默认资源空间标识,不携带则查询所有资源空间。 取值范围

  • true:查询默认资源空间。

  • false:查询非默认资源空间。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数说明:用户Token。通过调用IAM服务获取。

最小长度:0

最大长度:1024000

Instance-Id

String

参数说明:实例ID。物理多租下各实例的唯一标识,建议携带该参数,在使用专业版时必须携带该参数。您可以在IoTDA管理控制台界面,选择左侧导航栏“总览”页签查看当前实例的ID,具体获取方式请参考 查看实例详情

最小长度:0

最大长度:36

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

applications

Array of ApplicationDTO objects

资源空间信息列表。

数组长度:0 - 500

表5 ApplicationDTO

参数

参数类型

描述

app_id

String

资源空间ID,唯一标识一个资源空间,由物联网平台在创建资源空间时分配。资源空间对应的是物联网平台原有的应用,在物联网平台的含义与应用一致,只是变更了名称。

最小长度:1

最大长度:64

app_name

String

资源空间名称。

最小长度:1

最大长度:64

create_time

String

资源空间创建时间,格式:yyyyMMdd'T'HHmmss'Z',如20151212T121212Z。

最小长度:1

最大长度:64

default_app

Boolean

是否为默认资源空间

请求示例

列表查询资源。

GET https://{endpoint}/v5/iot/{project_id}/apps

响应示例

状态码: 200

Successful response

{
  "applications" : [ {
    "app_id" : "0ab87ceecbfc49acbcc8d5acdef3c68c",
    "app_name" : "testApp",
    "create_time" : "20151212T121212Z",
    "default_app" : true
  } ]
}

状态码

状态码

描述

200

Successful response

400

Bad Request

401

Unauthorized

403

FORBIDDEN

500

Internal Server Error

错误码

请参见错误码