调用该接口获取项目列表。

限制说明

单阿里云账号调用该接口的每秒请求数（QPS）最大限制为5。

说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

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

系统规定参数。取值：QueryStudioProjectList。
Name String 否 test1

项目名称。

  • 支持中文、英文字母、数字、下划线（_）、短划线（-）、英文圆括号（()）。
  • 必须以中文、英文字母或数字开头。
  • 长度不超过30个字符（一个中文算一个字符）。
PageNo Integer 否 1

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

返回结果中每页显示的条数。最小值1，最大值50，默认值20。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

实例ID。

您可在物联网平台控制台的实例概览页面，查看当前实例的ID。若有ID值，必须传入该ID值，否则调用会失败。

说明 如果公共实例没有ID值，请参见如何获取实例ID。

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

返回数据

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

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

Data Struct

项目列表详情。
List Array of ProjectInfo

项目列表。
ProjectInfo
Description String This is a test project.

项目描述。
GmtCreate Long 1611819839000

项目的创建时间。毫秒值时间戳。
GmtModified Long 1611819860000

项目的修改时间。毫秒值时间戳。
Name String test1

项目名称。
ProjectId String a123********

项目ID。
PageNo Integer 1

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

每页显示的条数。
Total Integer 200

项目总数。
TotalPage Integer 10

分页总数。
ErrorMessage String 系统异常

调用失败时，返回的出错信息。
RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

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

表示是否调用成功。

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

示例

请求示例

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

正常返回示例

XML格式 

<QueryStudioProjectListResponse>
      <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
      <Data>
            <TotalPage>10</TotalPage>
            <PageSize>20</PageSize>
            <Total>200</Total>
            <PageNo>1</PageNo>
            <List>
                  <ProjectInfo>
                        <GmtCreate>1611819839000</GmtCreate>
                        <Description>This is a test project.</Description>
                        <ProjectId>a123********</ProjectId>
                        <GmtModified>1611819860000</GmtModified>
                        <Name>test1</Name>
                  </ProjectInfo>
            </List>
      </Data>
      <Success>true</Success>
</QueryStudioProjectListResponse>

JSON格式 

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "TotalPage": 10,
        "PageSize": 20,
        "Total": 200,
        "PageNo": 1,
        "List": {
            "ProjectInfo": [
                {
                        "GmtCreate": 1611819839000,
                        "Description": "This is a test project.",
                        "ProjectId": "a123********",
                        "GmtModified": 1611819860000,
                        "Name": "test1"
                }
            ]
        }
    },
    "Success": true
}