文档

BindLicenseDevice

更新时间:

调用该接口为指定产品下设备授权License。

使用说明

本接口适用音视频通信服务和千里传音服务。调用本接口前,请确认完成以下操作:

重要

License绑定成功后,不支持解绑和退款该License。

QPS限制

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

说明

单个阿里云账号下的所有RAM用户共享该阿里云账号的配额。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String BindLicenseDevice

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

LicenseCode String 720P

License类型:

  • 音视频通信服务(音视频规格),可取值:480P720P
  • 千里传音服务(License类型),可取值:LINK_SPEECH_COMMON_LICENSE
ProductKey String a2YwD23***

待授权设备所属产品的ProductKey

您可以在物联网平台控制台或调用接口QueryProductList,查看当前实例下所有产品的信息。

IotInstanceId String iot-e3***

实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID

重要

  • 对于新版公共实例或企业版实例,实例有ID值,必须传入该ID值,否则调用会失败。
  • 对于旧版公共实例,实例无ID值,无需传入。

实例的更多信息,请参见实例概述

IotIdList.N RepeatList Q7uOhVRdZRRlDnTLv****00100

待授权License的设备列表,需传入设备对应的IotId

您可调用接口QueryDevice,查询指定产品下所有设备的IotId

DeviceNameList.N RepeatList testDevice

待授权License的设备列表,需传入设备对应的DeviceName

您可调用接口QueryDevice,查询指定产品下所有设备的DeviceName

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

返回数据

名称

类型

示例值

描述

Code String iot.system.SystemException

调用失败时,返回的错误码。更多信息,请参见本文下方_错误码_。

Data Struct

返回的授权结果。

CheckProgressId String 123***

查询批量授权设备进度的唯一ID。

FailSum Long 2

授权License失败的设备个数。

Progress Integer 100

为批量设备授权License的进度百分比,即取值范围为1~100。

ResultCsvFile String http://***

授权License完成后,授权失败设备文件的URL。

SuccessSum Long 10

授权License成功的设备个数。

ErrorMessage String 系统异常

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

RequestId String E4F94B97-1D64-4080-BFD2-67461667AA43

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

Success Boolean true

表示是否调用成功。

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

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=BindLicenseDevice
&IotIdList.1=Q7uOhVRdZRRlDnTLv****00100
&IotIdList.2=Q7uOhVRdZRRlDnTLv****00200
&IotIdList.3=Q7uOhVRdZRRlDnTLv****00300
&IotInstanceId=iot-e3***
&LicenseCode=720P
&ProductKey=a2YwD23***
&<公共请求参数>

正常返回示例

XML格式

<BindLicenseDeviceResponse>
  <RequestId>E4F94B97-1D64-4080-BFD2-67461667AA43</RequestId>
  <Data>
        <CheckProgressId>123***</CheckProgressId>
        <Progress>10</Progress>
        <ResultCsvFile>http://***</ResultCsvFile>
        <FailSum>2</FailSum>
        <SuccessSum>10</SuccessSum>
  </Data>
  <Success>true</Success>
</BindLicenseDeviceResponse>

JSON格式

{
    "RequestId": "E4F94B97-1D64-4080-BFD2-67461667AA43",
    "Data": {
        "CheckProgressId": "123***",
        "Progress": 10,
        "ResultCsvFile": "http://***",
        "FailSum": 2,
        "SuccessSum": 10
    },
    "Success": true
}
  • 本页导读 (1)