调用CreateLocalJoinPermission创建专用入网凭证。当前阿里云账号将成为该凭证的拥有者。

限制说明

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

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

调试

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

请求参数

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

系统规定参数。取值：CreateLocalJoinPermission。

ClassMode String 是 A

专用入网凭证采用的LoRaWAN Class模式。取值：A、B、C。
FreqBandPlanGroupId Long 是 101

专用入网凭证采用的频段ID，可调用ListFreqBandPlanGroups接口查询获取。

JoinPermissionName String 是 test

自定义专用入网凭证名称。支持中文、英文字母、数字和下划线（_），长度限制为4~30个字符，一个中文占2个字符。
UseDefaultJoinEui Boolean 是 true

专用入网凭证是否使用阿里云统一JoinEUI。取值：

  • true：使用阿里云统一JoinEUI。
  • false：使用用户自定义JoinEUI。
IotInstanceId String 否 iot_instc_pu****_c*-v64********

实例ID。

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

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

Class A的接收窗口延时时间，取值范围：1s~15s。
DataRate Long 否 4

数据速率，取值范围0~5。
JoinEui String 否 Ede4tde8erth****

用户自定义凭证使用的JoinEUI，当UseDefaultJoinEui设置为true时，此参数无需填入。

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

返回数据

名称 类型 示例值 描述
Data String 123

创建的专用入网凭证的ID。
RequestId String 89EF6CAA-958F-F32C-BE45-FE003C6DE097

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

是否调用成功。返回值：

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

示例

请求示例

http(s)://linkwan.cn-shanghai.aliyuncs.com/?Action=CreateLocalJoinPermission
&ClassMode=A
&FreqBandPlanGroupId=101
&JoinPermissionName=test
&UseDefaultJoinEui=true
&<公共请求参数>

正常返回示例

XML格式 

<CreateLocalJoinPermissionResponse>
        <Data>123</Data>
        <RequestId>89EF6CAA-958F-F32C-BE45-FE003C6DE097</RequestId>
        <Success>true</Success>
</CreateLocalJoinPermissionResponse>

JSON格式 

{
	"Data":"123",
	"RequestId":"89EF6CAA-958F-F32C-BE45-FE003C6DE097",
	"Success":true
}

错误码

HttpCode 错误码 错误信息 描述
400 ForbiddenByRam User not authorized to operate on the specified resource, or this API does not support RAM. 用户没有执行该操作所需要的RAM权限。
400 ForbiddenByRiskControl This operation cannot be performed because of security risks. 存在安全风险，无法执行该操作
400 ExceedLocalJoinPermissionLimit The maximum number of local join permissions that you can create is exceeded. 超出本地凭证已购买额度
400 InternalError The request processing has failed due to some unknown error, exception or failure. 内部错误。
400 JoinPermissionNameDuplicated The specified join permission name already exists. 入网凭证名称重复
400 InvalidName The specified name is invalid. 名称不合法
400 InvalidFreqBandPlan The frequency band plan is invalid. 频段计划不可用

访问错误中心查看更多错误码。