調用該接口刷新應用鑒權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
}