1. 接口描述
接口请求域名: weilingwith.tencentcloudapi.com 。
设备列表查询/单个查询(支持通过筛选条件查询,设备类型、标签、PID、空间)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDeviceList。 |
Version | 是 | String | 公共参数,本接口取值:2023-04-27。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
WorkspaceId | 是 | Integer | 工作空间id 示例值:1016 |
PageNumber | 是 | Integer | 分页查询,第几页,必传,大于0 示例值:1 |
PageSize | 是 | Integer | 每页条数,必传大于0 示例值:1 |
ApplicationToken | 是 | String | 应用token 示例值:xxx |
DeviceTypeSet.N | 否 | Array of String | 设备类型,非必填 示例值:w0202 |
ProductIdSet.N | 否 | Array of Integer | 产品 pid,非必填 示例值:29 |
TagIdSet.N | 否 | Array of Integer | 设备标签,非必填 示例值:0 |
SpaceCodeSet.N | 否 | Array of String | 空间层级 示例值:100100 |
DeviceTagSet.N | 否 | Array of String | 设备标签名,非必填 示例值:中文标签测试 |
WIDSet.N | 否 | Array of String | 设备wid,非必填 示例值:1c902558-d360-4a93-9b6f-1b49970534f7 |
Field | 否 | CustomField | 自定义字段 示例值:{"Id": 67,"Val": "1"} |
GroupIdSet.N | 否 | Array of Integer | 分组id列表,非必填 示例值:[1,2,3] |
IsActive | 否 | String | 是否激活,默认全部,"1"激活,"0"未激活 示例值:"1" |
IsCamera | 否 | String | 是否为摄像头,默认全部,"true"摄像头,"false"非摄像头 示例值:"false" |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | DescribeDeviceListRes | 查询设备列表结果 示例值:{"DeviceDataSet": [{"ActiveTime": "2023-04-13T09:41:38+08:00","DeviceName": "1c902558-d360-4a93-9b6f-1b49970534f7","DeviceTagSet": ["中文标签测试"],"DeviceTypeCode": "1c902558-d360-4a93-9b6f-1b49970534f7","DeviceTypeName": "1c902558-d360-4a93-9b6f-1b49970534f7","FieldList": [{"Id": 1,"Key": "color","Name": "颜色","Val": ""}],"IsActive": 1,"IsLive": false,"Location": {"X": -197697.515625,"Y": 22156.90234375,"Z": 0},"ModelId": "","ModelName": "","OtaVersion": "v1","ParentWID": "","ParentWIDName": "","ProductAbility": 1,"ProductId": 2000053,"ProductName": "其它网关","SN": "tony001","SpaceInfoSet": [{"Code": "001234","Id": "7e0eba7e-aa9b-43bd-8a68-2ea7153828de","Level": 6,"Name": "验证专用"}],"WID": "1c902558-d360-4a93-9b6f-1b49970534f7"}],"PageNumber": 1,"PageSize": 1,"TotalPage": 8790,"TotalRow": 8790}} |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 设备列表
成功响应
输入示例
POST / HTTP/1.1
Host: weilingwith.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDeviceList
<公共请求参数>
{
"WorkspaceId": 1016,
"DeviceTypeSet": [
"w0701005"
],
"PageNumber": 1,
"PageSize": 1,
"ApplicationToken": "wA9bELuI4oulQCBK876UDBxe00dNcxQW"
}
输出示例
{
"Response": {
"RequestId": "dd0b4025-2db7-4da3-998a-dda6cfc19441",
"Result": {
"DeviceDataSet": [
{
"ActiveTime": "2023-04-13T14:11:24+08:00",
"DeviceName": "5f089c7e-0530-44c9-9435-c6aaf92f6a29",
"DeviceTagSet": [
"西安",
"真实"
],
"DeviceTypeCode": "5f089c7e-0530-44c9-9435-c6aaf92f6a29",
"DeviceTypeName": "5f089c7e-0530-44c9-9435-c6aaf92f6a29",
"FieldList": [
{
"Id": 1,
"Key": "color",
"Name": "颜色",
"Val": ""
},
{
"Id": 3,
"Key": "height",
"Name": "高度",
"Val": ""
},
{
"Id": 64,
"Key": "size",
"Name": "尺寸",
"Val": ""
},
{
"Id": 65,
"Key": "weight",
"Name": "重量",
"Val": ""
},
{
"Id": 66,
"Key": "width",
"Name": "宽度",
"Val": ""
},
{
"Id": 67,
"Key": "long",
"Name": "长度",
"Val": ""
},
{
"Id": 68,
"Key": "volume",
"Name": "体积",
"Val": ""
}
],
"IsActive": 1,
"IsLive": false,
"Location": {
"X": 30769.744140625,
"Y": 10080.6162109375,
"Z": 24750
},
"ModelId": "2000056",
"ModelName": "边缘摄像头",
"ParentWID": "",
"ParentWIDName": "",
"ProductAbility": 3,
"ProductId": 2000056,
"ProductName": "边缘摄像头",
"SN": "DS-2DE7530IW-A20190315AACHD00715442W",
"SpaceInfoSet": [
{
"Code": "000137",
"Id": "85dc534a-4f69-4553-aad0-368cda0f1e92",
"Level": 6,
"Name": "滨海大厦"
},
{
"Code": "000137048",
"Id": "bf0fb1b4-493c-458f-bf8c-7279963b4928",
"Level": 7,
"Name": "7F"
},
{
"Code": "00013704800003110",
"Id": "472ee223-5caf-46c1-beca-d7238a937733",
"Level": 9,
"Name": ""
}
],
"WID": "5f089c7e-0530-44c9-9435-c6aaf92f6a29"
}
],
"PageNumber": 1,
"PageSize": 1,
"TotalPage": 16,
"TotalRow": 16
}
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.ApiAuthorizationNotFound | 未找到此应用该api授权信息 |
AuthFailure.TokenNotFound | 未找到该token信息 |
FailedOperation.ApiRuleConfigError | Api规则配置信息错误 |
InternalError.ApiGatewayInternalError | API网关内部错误 |
InternalError.BusinessLogicError | 业务逻辑错误 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.InvalidWorkspaceId | 错误的工作空间Id |
ResourceNotFound.EmptyDeviceList | 空设备列表 |
UnauthorizedOperation.UnauthorizedApi | 应用api的数据授权未配置,请先配置权限 |