调用该接口刷新应用鉴权Token。
限制说明
单阿里云账号调用该接口的每秒请求数(QPS)最大限制为5。
说明 RAM用户共享阿里云账号配额。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | RefreshStudioAppTokenOpen |
系统规定参数。取值:RefreshStudioAppTokenOpen。 |
AppId | String | 是 | a12****** |
应用ID。可调用QueryStudioAppList查询。 |
ProjectId | String | 是 | a123******* |
项目ID。 1. 您可登录物联网应用开发控制台,在页面左上角选择对应实例后,在左侧导航栏单击项目管理。 2. 在普通项目列表中,找到目标项目,单击项目卡片,在地址栏中查看。 |
IotInstanceId | String | 否 | iot_instc_pu****_c*-v64******** |
实例ID。 您可在物联网平台控制台的实例概览页面,查看当前实例的ID。若有ID值,必须传入该ID值,否则调用会失败。 说明 如果公共实例没有ID值,请参见如何获取实例ID。
|
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | iot.system.SystemException |
调用失败时,返回的错误码。错误码详情,请参见错误码。 |
Data | Struct |
Token数据。 |
|
BizId | String | a12******* |
应用ID。 |
BizType | String | webApp |
应用类型。 |
IsEnable | String | YES |
是否启用Token。
|
Token | String | cf245ddebd****** |
Token值。 |
Type | String | custom |
Token类型。 |
ErrorMessage | String | 系统异常 |
调用失败时,返回的出错信息。 |
RequestId | String | E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565 |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
表示是否调用成功。
|
示例
请求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=RefreshStudioAppTokenOpen
&AppId=a12******
&ProjectId=a123*******
&<公共请求参数>
正常返回示例
XML
格式
<RefreshStudioAppTokenOpenResponse>
<RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
<Data>
<IsEnable>YES</IsEnable>
<Type>custom</Type>
<Token>cf245ddebd******</Token>
<BizType>webApp</BizType>
<BizId>a12*******</BizId>
</Data>
<Success>true</Success>
</RefreshStudioAppTokenOpenResponse>
JSON
格式
{
"RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
"Data": {
"IsEnable": "YES",
"Type": "custom",
"Token": "cf245ddebd******",
"BizType": "webApp",
"BizId": "a12*******"
},
"Success": true
}