调用该接口获取应用列表。
限制说明
单阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QueryStudioAppList |
系统规定参数。取值:QueryStudioAppList。 |
ProjectId | String | 是 | a123******** |
项目ID。 1. 您可登录物联网应用开发控制台,在页面左上角选择对应实例后,在左侧导航栏单击项目管理。 2. 在普通项目列表中,找到目标项目,单击项目卡片,在地址栏中查看。 |
Types.N | RepeatList | 是 | ["webApp", "mobileApp"] |
应用类型列表。
|
PageNo | Integer | 否 | 1 |
指定从返回结果中的第几页开始显示。默认为1。 |
PageSize | Integer | 否 | 2 |
指定返回结果中每页显示的产品数量,最大值是200。 |
FuzzyName | String | 否 | test1 |
应用名称。
|
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 AppInfo |
应用列表。 |
|
AppInfo | |||
AppId | String | a123******** |
应用ID。 |
AppKey | String | 322****** |
应用AppKey。 |
AppSecret | String | a605******* |
应用密钥。 |
Description | String | This is a test. |
应用描述。 |
GmtCreate | String | 2020-12-25 16:20:53 |
应用的创建时间。 |
GmtModified | String | 2021-04-10 15:06:23 |
应用的修改时间。 |
GmtRelease | String | 2021-04-15 19:11:32 |
应用的发布时间。 |
Name | String | test1 |
应用名称。 |
ProjectId | String | a123******** |
应用所属项目ID。 |
Type | String | webApp |
应用类型。 |
PageNo | Integer | 1 |
指定从返回结果中的第几页开始显示。 |
PageSize | Integer | 20 |
每页显示的条数。 |
Total | Integer | 200 |
应用总数。 |
TotalPage | Integer | 10 |
分页总数。 |
ErrorMessage | String | 系统异常 |
调用失败时,返回的出错信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
表示是否调用成功。
|
示例
请求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryStudioAppList
&ProjectId=a123********
&Types.1=["webApp", "mobileApp"]
&<公共请求参数>
正常返回示例
XML
格式
<QueryStudioAppListResponse>
<RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
<Data>
<TotalPage>10</TotalPage>
<PageSize>20</PageSize>
<Total>200</Total>
<PageNo>1</PageNo>
<List>
<AppInfo>
<GmtCreate>2020-12-25 16:20:53</GmtCreate>
<Type>webApp</Type>
<Description>This is a test.</Description>
<AppId>a123********</AppId>
<AppKey>322******</AppKey>
<GmtModified>2021-04-10 15:06:23</GmtModified>
<ProjectId>a123********</ProjectId>
<GmtRelease>2021-04-15 19:11:32</GmtRelease>
<AppSecret>a605*******</AppSecret>
<Name>test1</Name>
</AppInfo>
</List>
</Data>
<Success>true</Success>
</QueryStudioAppListResponse>
JSON
格式
{
"RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
"Data": {
"TotalPage": 10,
"PageSize": 20,
"Total": 200,
"PageNo": 1,
"List": {
"AppInfo": [
{
"GmtCreate": "2020-12-25 16:20:53",
"Type": "webApp",
"Description": "This is a test.",
"AppId": "a123********",
"AppKey": "322******",
"GmtModified": "2021-04-10 15:06:23",
"ProjectId": "a123********",
"GmtRelease": "2021-04-15 19:11:32",
"AppSecret": "a605*******",
"Name": "test1"
}
]
}
},
"Success": true
}