QuerySpeechDevice调用该接口查询播报设备列表_物联网平台(IoT)-阿里云帮助中心

QPS限制

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

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

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	QuerySpeechDevice	系统规定参数。取值：QuerySpeechDevice。
ProjectCode	String	是	4de2c367**8c585e5992	项目ID，是项目的唯一标识，您可以通过项目管理控制台获取项目ID。
IotInstanceId	String	否	iot_instc_pu***_c-v64********	实例ID。必须传入实例ID，否则调用会失败。您可在物联网平台控制台的实例概览页面，查看您的实例ID。注意如果公共实例没有ID，请参见如何获取实例ID。
AvailableSpace	String	否	500	设备的可用空间，单位KB，取值为任意正数。说明 AvailableSpaceScope字段必须同时传入才会生效。
AvailableSpaceScope	String	否	smaller	设备可用空间的查询条件。 greater：大于。 smaller：小于。 equal：等于。示例：AvailableSpace设置为500，AvailableSpaceScope设置为smaller，则返回可用空间小于500KB的设备列表。
PageSize	Integer	否	20	指定每页返回数据的最大条数，取值范围：1~50，默认值为20。
PageId	Integer	否	1	当前页，从1开始，最大为10000。
DeviceName	String	否	test	设备名称查询条件，最左前缀匹配。

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

返回数据


名称	类型	示例值	描述
Code	String	iot.system.SystemException	调用失败时，返回的错误码。更多信息，请参见错误码。
Data	Struct		查询结果。
List	Array of Items		返回的设备列表。
Items
AvailableSpace	Float	200	设备的实际可用空间，单位KB。
DeviceName	String	test	设备名称。
IotId	String	Q7uOhVRdZRRlDnTLv****00100	物联网平台为设备颁发的ID，是设备的唯一标识符。
ProductKey	String	a1BwAGV****	设备所隶属产品的ProductKey。
PageId	Integer	1	当前页。
PageSize	Integer	20	每页返回的数据条数。
Total	Integer	200	返回数据的总条数。
ErrorMessage	String	speech solution has not been signed	调用失败时，返回的错误信息。
RequestId	String	AF71BF1D-B552-47CD-B34B-352557627992	阿里云为该请求生成的唯一标识符。
Success	Boolean	true	是否调用成功。 true：调用成功。 false：调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QuerySpeechDevice
&ProjectCode=4de2c367****8c585e5992**
&<公共请求参数>

正常返回示例

XML格式

<QuerySpeechDeviceResponse>
  <RequestId>AF71BF1D-B552-47CD-B34B-352557627992</RequestId>
  <Data>
        <PageId>1</PageId>
        <PageSize>20</PageSize>
        <Total>200</Total>
        <List>
              <Items>
                    <IotId>Q7uOhVRdZRRlDnTLv****00100</IotId>
                    <AvailableSpace>200</AvailableSpace>
                    <ProductKey>a1BwAGV****</ProductKey>
                    <DeviceName>test</DeviceName>
              </Items>
        </List>
  </Data>
  <Success>true</Success>
</QuerySpeechDeviceResponse>

JSON格式

{
    "RequestId": "AF71BF1D-B552-47CD-B34B-352557627992",
    "Data": {
        "PageId": 1,
        "PageSize": 20,
        "Total": 200,
        "List": {
            "Items": {
                "IotId": "Q7uOhVRdZRRlDnTLv****00100",
                "AvailableSpace": 200,
                "ProductKey": "a1BwAGV****",
                "DeviceName": "test"
            }
        }
    },
    "Success": true
}