调用该接口查询播报设备的详情,包括设备的状态、设备的可用空间等。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetSpeechDeviceDetail

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

IotId String 4de2c367****8c585e5992**

物联网平台为设备颁发的ID,是设备的唯一标识符。调用QuerySpeechDevice可以获取该参数。

IotInstanceId String iot_instc_pu****_c*-v64********

实例ID。

必须传入实例ID,否则调用会失败。您可在物联网平台控制台的实例概览页面,查看您的实例ID。

注意

如果公共实例没有ID,请参见如何获取实例ID

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

返回数据

名称 类型 示例值 描述
Code String iot.speechsolution.NotSigned

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

Data Struct

查询结果。

AvailableSpace Float 200

设备的可用空间,单位KB。

DeviceName String test

设备名称。

IotId String 4de2c367****8c585e5992**

物联网平台为设备颁发的ID,是设备的唯一标识符。

ProductKey String a1BwAGV****

产品的唯一标识。

SpeechListUpdateTime Long 1620624606000

设备中语料列表的更新时间。

Status String ONLINE

设备的状态。

  • ONLINE:在线。
  • OFFLINE:离线。
  • UNACTIVE:未激活。
  • DISABLE:禁用。
TotalSpace Float 2000

设备的总空间,单位KB。

ErrorMessage String speech solution has not been signed

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

RequestId String 66FF51D3-***-49F1-B1A2-***

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

Success Boolean true

是否调用成功。

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

示例

请求示例

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

正常返回示例

XML格式

<GetSpeechDeviceDetailResponse>
  <RequestId>66FF51D3-***-49F1-B1A2-***</RequestId>
  <Data>
        <Status>ONLINE</Status>
        <IotId>4de2c367****8c585e5992**</IotId>
        <SpeechListUpdateTime>1620624606000</SpeechListUpdateTime>
        <AvailableSpace>200</AvailableSpace>
        <TotalSpace>2000</TotalSpace>
        <ProductKey>a1BwAGV****</ProductKey>
        <DeviceName>test</DeviceName>
  </Data>
  <Success>true</Success>
</GetSpeechDeviceDetailResponse>

JSON格式

{
    "RequestId": "66FF51D3-***-49F1-B1A2-***",
    "Data": {
        "Status": "ONLINE",
        "IotId": "4de2c367****8c585e5992**",
        "SpeechListUpdateTime": 1620624606000,
        "AvailableSpace": 200,
        "TotalSpace": 2000,
        "ProductKey": "a1BwAGV****",
        "DeviceName": "test"
    },
    "Success": true
}