调用该接口查询授权License的设备列表。
QPS限制
单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QueryLicenseDeviceList |
系统规定参数。取值:QueryLicenseDeviceList。 |
IotInstanceId | String | 否 | iot-ws4*** |
实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID。 注意
实例的更多信息,请参见实例概述。 |
PageSize | Integer | 否 | 50 |
指定每页返回的记录数量,取值范围:1~100,默认值为20。 |
LicenseCode | String | 否 | 720P |
License类型(音视频规格),可取值:480P、720P。 |
ProductKey | String | 否 | es**** |
设备所属产品的ProductKey。 您可以在物联网平台控制台或调用接口QueryProductList,查看当前实例下所有产品的信息。 |
PageId | Integer | 否 | 1 |
指定分页查询的页码。 |
IotId | String | 否 | Q7uOhVRdZRRlDnTLv****00100 |
要查询设备的设备ID。 您可调用接口QueryDevice,查询指定产品下所有设备的IotId。 |
StartTime | Long | 否 | 1620634297000 |
设备授权License的开始时间,取值为毫秒值时间戳。 |
EndTime | Long | 否 | 1620934297000 |
设备授权License的结束时间,取值为毫秒值时间戳。 |
调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | iot.system.SystemException |
调用失败时,返回的错误码。更多信息,请参见本文下方错误码。 |
Data | Struct |
返回的结果信息。 |
|
DeviceList | Array of item |
设备列表信息。 |
|
item | |||
DeviceName | String | device1 |
设备名称。 |
ExpiryTime | Long | 1690934297000 |
设备授权License的失效时间。 |
GmtCreate | Long | 1620634297000 |
设备授权License的时间。 |
IotId | String | Q7uOhVRdZRRlDnTLv****00100 |
设备ID。 |
LicenseCode | String | 720P |
License类型(音视频规格),可取值:480P、720P。 |
ProductKey | String | es**** |
设备所属产品的ProductKey。 |
ProductName | String | 测试产品 |
产品名称。 |
PageId | Integer | 1 |
分页查询的当前页码。 |
PageSize | Integer | 2 |
每页显示的记录数。 |
Total | Integer | 10 |
总记录数。 |
ErrorMessage | String | 系统异常 |
调用失败时,返回的出错信息。 |
RequestId | String | 291438BA-6E10-4C4C-B761-243B9A0D324F |
阿里云为该请求生成的唯一标识符。 |
Success | Boolean | true |
表示是否调用成功。
|
示例
请求示例
http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryLicenseDeviceList
&<公共请求参数>
正常返回示例
XML
格式
<QueryLicenseDeviceListResponse>
<RequestId>739536F1-9EB3-511E-960A-524C473EE87A</RequestId>
<Data>
<PageId>1</PageId>
<PageSize>20</PageSize>
<Total>2</Total>
<DeviceList>
<item>
<IotId>QTGl****000000</IotId>
<LicenseCode>480P</LicenseCode>
<GmtCreate>1653996767000</GmtCreate>
<ProductName>xinde</ProductName>
<ExpiryTime>1748604768000</ExpiryTime>
<ProductKey>a1****ls</ProductKey>
<DeviceName>device001</DeviceName>
</item>
<item>
<IotId>eJt****000000</IotId>
<LicenseCode>480P</LicenseCode>
<GmtCreate>1653996767000</GmtCreate>
<ProductName>xinde</ProductName>
<ExpiryTime>1748604768000</ExpiryTime>
<ProductKey>a1****ls</ProductKey>
<DeviceName>fefe</DeviceName>
</item>
</DeviceList>
</Data>
<Success>true</Success>
</QueryLicenseDeviceListResponse>
JSON
格式
{
"RequestId": "739536F1-9EB3-511E-960A-524C473EE87A",
"Data": {
"PageId": 1,
"PageSize": 20,
"Total": 2,
"DeviceList": {
"item": [
{
"IotId": "QTGl****000000",
"LicenseCode": "480P",
"GmtCreate": 1653996767000,
"ProductName": "xinde",
"ExpiryTime": 1748604768000,
"ProductKey": "a1****ls",
"DeviceName": "device001"
},
{
"IotId": "eJt****000000",
"LicenseCode": "480P",
"GmtCreate": 1653996767000,
"ProductName": "xinde",
"ExpiryTime": 1748604768000,
"ProductKey": "a1****ls",
"DeviceName": "fefe"
}
]
}
},
"Success": true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | iot.rtc.service.notSigned | The RTC service is not activated. | 音视频通信服务未开通 |
400 | iot.rtc.invalid.license.code | invalid license code | 无效的license编码 |
400 | iot.rtc.invalid.product.key | invalid product key | 无效的产品KEY |
访问错误中心查看更多错误码。