文档首页 > > API参考> 应用侧PHP SDK API参考> 数据采集> 查询设备服务能力

查询设备服务能力

分享
更新时间: 2019/11/12 GMT+08:00

典型场景

第三方应用若需要了解设备可上报哪些服务属性数据,以及设备支持下发哪些命令,可调用此接口在物联网平台查询设备的Profile文件中定义的设备服务能力信息。

接口功能

支持第三方应用在物联网平台查询设备的服务属性、设备命令等服务能力信息。

接口描述

1
public function queryDeviceCapabilities($qdcInDTO, $accessToken)

参数说明

参数

必选/可选

位置

描述

$qdcInDTO

必选

query

见下表QueryDeviceCapabilitiesInDTO的描述。

$accessToken

必选

header

填写3.1.1-鉴权接口获取的accessToken。

QueryDeviceCapabilitiesInDTO

参数

是否必须

位置

描述

$gatewayId

可选

query

网关ID,用于标识一个网关设备。

$appId

必选

query

如果是本应用的设备,此参数值可以填写null,否则填写授权应用的appId。

$deviceId

可选

query

设备ID,用于唯一标识一个设备。

响应参数

QueryDeviceCapabilitiesOutDTO

参数

描述

$deviceCapabilities

查询结果列表,具体参见DeviceCapabilityDTO结构体。

DeviceCapabilityDTO结构体说明:

参数

描述

$deviceId

设备ID,用于唯一标识一个设备。

$serviceCapabilities

设备的服务能力列表,具体参见ServiceCapabilityDTO结构体。

ServiceCapabilityDTO结构体说明:

参数

描述

$serviceId

设备的服务标识。

$serviceType

设备的服务类型。

$option

服务选项。

$description

设备服务描述信息。

$commands

支持的命令名称列表,具体参见ServiceCommand结构体。

$properties

支持的属性名称列表,具体参见ServiceProperty结构体。

ServiceCommand结构体说明:

参数

描述

$commandName

命令名称。

$paras

属性列表,具体参见ServiceCommandPara结构体。

$responses

响应列表,具体参见ServiceCommandResponse结构体。

ServiceCommandPara结构体说明:

参数

描述

$paraName

参数名称。

$dataType

数据类型。

$required

是否必选。

$min

属性最小值。

$max

属性最大值。

$step

步长。

$maxLength

最大长度。

$unit

单位(符号)。

$enumList

枚举类型列表。

ServiceCommandResponse结构体说明:

参数

描述

$responseName

响应名称。

$paras

属性列表,具体参见ServiceCommandPara结构体。

ServiceProperty结构体说明:

参数

描述

$propertyName

属性名称。

$dataType

数据类型。

$required

是否必选。

$min

属性最小值。

$max

属性最大值。

$step

步长。

$maxLength

最大长度。

$method

访问方法。

  • “R”:可读
  • “W”:可写
  • “E”:可观察

$unit

单位(符号)。

$enumList

枚举类型列表。

错误码

Http状态码

错误码

错误描述

说明

400

100022

The input is invalid.

输入参数无效。

处理建议:请检查接口调用请求中携带参数的合法性。

403

100203

The application is not existed.

应用不存在。

处理建议:

  • 请检查HTTP请求头域中携带的appId是否有误。
  • 请检查请求路径(url)中传入的appId是否有误。

403

100217

The application hasn't been authorized.

应用未被授权。

处理建议:若非应用授权场景,请确认请求参数中的appId为空。

403

1010009

app throttle exceed.

应用调用接口过于频繁,超过流控值(默认值是100次/60s)。

处理建议:联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。

403

1010005

Invalid access token or appId.

错误的token信息。

处理建议:请检查接口请求中所携带的accessToken是否有误。

500

100203

The application is not existed.

应用不存在。

处理建议:

  • 请检查HTTP请求头域中携带的appId是否有误。
  • 请检查请求路径(url)中传入的appId是否有误。

500

50252

Internal server error.

服务器运行内部错误。

处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区