调用该接口获取应用页面列表。

限制说明

  • 如果在企业版实例中调用该接口,请求参数IotInstanceId必须填写。否则,调用接口会失败。
  • 单阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。
    说明 RAM用户共享阿里云账号配额。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String QueryStudioAppPageListOpen

系统规定参数。取值:QueryStudioAppPageListOpen。

AppId String a12*******

应用ID。可调用QueryStudioAppList查询。

ProjectId String a12******

项目ID。

1.您可登录物联网应用开发控制台,在页面左上角选择对应实例后,在左侧导航栏单击项目管理。

2. 在普通项目列表中,找到目标项目,单击项目卡片,在地址栏中查看。

IotInstanceId String iot_instc_pu****_c*-v64********

实例ID。

  • 企业版实例:必须传入此参数。您可在物联网平台控制台的实例概览页面,查看您的企业版实例ID。
  • 公共实例:无需传入此参数。
IsRelease Boolean false

获取应用页面。

  • true:获取已发布的应用页面。
  • false(默认):获取未发布的应用页面。
PageNo Integer 1

指定从返回结果中的第几页开始显示。默认为1。

PageSize Integer 20

返回结果中每页显示的条数。最小值1,最大值50,默认值20。

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称 类型 示例值 描述
Code String iot.system.SystemException

调用失败时,返回的错误码。错误码详情,请参见错误码

Data Struct

应用页面列表信息。

List Array of PageInfo

应用页面列表。

PageInfo
GmtCreate String 2020-12-25T16:21Z

页面的创建时间。

GmtModified String 2021-05-08T17:18Z

页面的修改时间。

Id Integer 49739

标记每条记录的唯一标识。

IsHidden Integer 1

表示页面是否隐藏。

  • 0:否。
  • 1:是。
IsHome Integer 1

表示页面是否为主页。

  • 0:否。
  • 1:是。
IsLoginPage Integer 1

表示页面是否为登录页。

  • 0:否。
  • 1:是。
Name String test1

页面名称。

PageId String 44920

页面ID。

Path String /page/44920

页面路径。

PageNo Integer 1

指定从返回结果中的第几页开始显示。

PageSize Integer 10

每页显示的条数。

Total Integer 1

页面总数。

TotalPage Integer 1

分页总数。

ErrorMessage String 系统异常

调用失败时,返回的出错信息。

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

阿里云为该请求生成的唯一标识符。

Success Boolean true

表示是否调用成功。

  • true:调用成功。
  • false:调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryStudioAppPageListOpen
&AppId=a12*******
&ProjectId=a12******
&<公共请求参数>

正常返回示例

XML格式

<QueryStudioAppPageListOpenResponse>
      <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
      <Data>
            <TotalPage>1</TotalPage>
            <PageSize>10</PageSize>
            <Total>10</Total>
            <PageNo>1</PageNo>
            <List>
                  <PageInfo>
                        <Path>/page/44920</Path>
                        <PageId>44920</PageId>
                        <IsHome>1</IsHome>
                        <IsHidden>1</IsHidden>
                        <GmtCreate>2020-12-25T16:21Z</GmtCreate>
                        <IsLoginPage>1</IsLoginPage>
                        <GmtModified>2021-05-08T17:18Z</GmtModified>
                        <Id>49739</Id>
                        <Name>test1</Name>
                  </PageInfo>
            </List>
      </Data>
      <Success>true</Success>
</QueryStudioAppPageListOpenResponse>

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "TotalPage": 1,
        "PageSize": 10,
        "Total": 10,
        "PageNo": 1,
        "List": {
            "PageInfo": [
                {
                        "Path": "/page/44920",
                        "PageId": 44920,
                        "IsHome": 1,
                        "IsHidden": 1,
                        "GmtCreate": "2020-12-25T16:21Z",
                        "IsLoginPage": 1,
                        "GmtModified": "2021-05-08T17:18Z",
                        "Id": 49739,
                        "Name": "test1"
                }
            ]
        }
    },
    "Success": true
}