调用该接口设置应用鉴权模式。

限制说明

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

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

调试

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

请求参数

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

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

AppId String a12*****

应用ID。可调用QueryStudioAppList查询。

AuthMode Integer 1

鉴权模式。取值:

  • 0:不鉴权。
  • 1:Token。
  • 2:账号。
ProjectId String a123********

项目ID。

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

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

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

实例ID。

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

注意

如果公共实例没有ID,请参见如何获取实例ID

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

返回数据

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

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

Data Struct

应用数据。

AuthMode Integer 1

鉴权模式。

TokenInfo Struct

Token信息。

BizId String a12********

应用ID。

BizType String webApp

应用类型。

IsEnable String YES

是否启用Token。

  • YES:是。
  • NO:否。
Token String 25bf576a6c6f**********

Token值。

Type String custom

Token类型。

ErrorMessage String 系统异常

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

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

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

Success Boolean true

表示是否调用成功。

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

示例

请求示例

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

正常返回示例

XML格式

<SetupStudioAppAuthModeOpenResponse>   
      <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
      <Data>
            <AuthMode>1</AuthMode>
            <TokenInfo>
                  <IsEnable>YES</IsEnable>
                  <Type>custom</Type>
                  <Token>25bf576a6c6f**********</Token>
                  <BizType>webApp</BizType>
                  <BizId>a12********</BizId>
            </TokenInfo>
      </Data>
      <Success>true</Success>
</SetupStudioAppAuthModeOpenResponse>

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "AuthMode": 1,
        "TokenInfo": {
            "IsEnable": "YES",
            "Type": "custom",
            "Token": "25bf576a6c6f**********",
            "BizType": "webApp",
            "BizId": "a12********"
        }
    },
    "Success": true
}