调用该接口查询语料推送任务列表。

调试

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

请求参数

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

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

ProjectCode String 0Ykj************************Av0I

项目ID,是项目的唯一标识,您可以通过项目管理控制台获取项目ID。

StatusList.N RepeatList RUNNING

查询语料推送任务的状态列表,不传则查询所有状态。

  • RUNNING:运行中。
  • CANCEL:取消。
  • SUCCESS:成功。
  • TIMEOUT:超时。
IotInstanceId String iot-060*****

实例ID。

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

注意

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

PushMode String ALL

推送任务的模式,不传则查询所有模式。

  • SINGLE_DEVICE:单设备推送。
  • ALL:全量设备推送。
  • GROUP_DEVICE:分组设备推送。
JobCode String tBUm***********************QPGT

推送任务ID,调用PushSpeech成功后返回的Data字段为推送任务ID。

PageSize Integer 20

指定每页返回数据的最大条数,取值范围:1~50,默认值为20。

PageId Integer 1

当前页,从1开始,最大为10000。

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

返回数据

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

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

Data Struct

返回的语料推送任务状态列表。

List Array of Items

语料推送任务列表信息。

Items
Code String tBUm***********************QPGT

推送任务ID。

CreatedTime Long 1620634297000

推送任务的创建时间。

DeviceName String test

设备名称。

ExpiredTime Long 1620634297000

推送任务的到期时间。

FailDeviceNum Integer 1

推送失败的设备数。

GroupId String test_group

分组ID。

GroupName String 测试分组

分组名称。

IotId String 0iOf*****************n001

设备ID。

ProductKey String den0ZLt****

产品的唯一标识。

PushMode String ALL

推送模式。

  • SINGLE_DEVICE:单设备推送。
  • ALL:全量设备推送。
  • GROUP_DEVICE:分组设备推送。
RunningDeviceNum Integer 2

运行中的设备数。

SpeechNum Integer 1

语料数。

SpeechStatus Boolean true

推送语料是否完整。

  • true:完整。
  • false:不完整。
Status String RUNNING

语料推送任务状态。

  • RUNNING:运行中。
  • CANCEL:取消。
  • SUCCESS:成功。
  • TIMEOUT:超时。
SuccessDeviceNum Integer 1

语料推送成功的设备数。

TotalDeviceNum Integer 3

总设备数。

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=QuerySpeechPushJob
&ProjectCode=0Ykj************************Av0I
&<公共请求参数>

正常返回示例

XML格式

<QuerySpeechPushJobResponse>
  <RequestId>AF71BF1D-B552-47CD-B34B-352557627992</RequestId>
  <Data>
        <PageId>1</PageId>
        <PageSize>20</PageSize>
        <Total>200</Total>
        <List>
              <Items>
                    <GroupName>测试分组</GroupName>
                    <Status>RUNNING</Status>
                    <SpeechNum>1</SpeechNum>
                    <CreatedTime>1620634297000</CreatedTime>
                    <TotalDeviceNum>3</TotalDeviceNum>
                    <SuccessDeviceNum>1</SuccessDeviceNum>
                    <RunningDeviceNum>2</RunningDeviceNum>
                    <FailDeviceNum>1</FailDeviceNum>
                    <Code>tBUm***********************QPGT</Code>
                    <GroupId>test_group</GroupId>
                    <PushMode>ALL</PushMode>
                    <IotId>0iOf*****************n001</IotId>
                    <ExpiredTime>1620634297000</ExpiredTime>
                    <SpeechStatus>true</SpeechStatus>
                    <ProductKey>den0ZLt****</ProductKey>
                    <DeviceName>test</DeviceName>
              </Items>
        </List>
  </Data>
  <Success>true</Success>
</QuerySpeechPushJobResponse>

JSON格式

{
    "RequestId": "AF71BF1D-B552-47CD-B34B-352557627992",
    "Data": {
        "PageId": 1,
        "PageSize": 20,
        "Total": 200,
        "List": {
            "Items": {
                "GroupName": "测试分组",
                "Status": "RUNNING",
                "SpeechNum": 1,
                "CreatedTime": 1620634297000,
                "TotalDeviceNum": 3,
                "SuccessDeviceNum": 1,
                "RunningDeviceNum": 2,
                "FailDeviceNum": 1,
                "Code": "tBUm***********************QPGT",
                "GroupId": "test_group",
                "PushMode": "ALL",
                "IotId": "0iOf*****************n001",
                "ExpiredTime": 1620634297000,
                "SpeechStatus": true,
                "ProductKey": "den0ZLt****",
                "DeviceName": "test"
            }
        }
    },
    "Success": true
}