调用该接口查询指定排程的声码标签批次列表。

QPS限制

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

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

调试

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

请求参数

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

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

ScheduleCode String Md3ZiTL888K9llXDy7890***********

排程唯一标识。

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

实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID

注意
  • 若有ID值,必须传入该ID值,否则调用会失败。
  • 若无ID值,则无需传入。

实例的更多信息,请参见如何获取实例ID

PageSize Integer 20

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

PageId Integer 1

指定显示返回结果中的第几页。取值范围1~10,000,默认值为1。

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

返回数据

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

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

Data Struct

返回数据。

List Array of Items

批次列表。

Items
BatchCode String Md3ZiTL888K9llXDy7890***********

批次唯一标识。

Description String test

批次描述。

GmtCreate Long 1620634297000

批次创建时间。

Status String RUNNING

批次状态。

  • RUNNING:运行中。
  • SUCCESS:成功。
  • PARTIAL_FAILED:部分成功。
  • INTERRUPT:中断。
SuccessNum Integer 1

成功创建数量。

Total Integer 20

批量创建总数。

PageId Integer 1

当前页号。

PageSize Integer 20

每页返回的时间段条数。

Total Integer 200

查询返回的时间段总条数。

ErrorMessage String sound code service has not been signed

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

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

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

Success Boolean true

是否调用成功。

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

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QuerySoundCodeLabelBatchList
&ScheduleCode=Md3ZiTL888K9llXDy7890***********
&<公共请求参数>

正常返回示例

XML格式

<QuerySoundCodeLabelBatchListResponse>
  <RequestId>66FF51D3-***-49F1-B1A2-***</RequestId>
  <Data>
        <PageId>1</PageId>
        <PageSize>20</PageSize>
        <Total>200</Total>
        <List>
              <Items>
                    <Status>RUNNING</Status>
                    <GmtCreate>1620634297000</GmtCreate>
                    <Description>test</Description>
                    <SuccessNum>1</SuccessNum>
                    <BatchCode>Md3ZiTL888K9llXDy7890***********</BatchCode>
                    <Total>20</Total>
              </Items>
        </List>
  </Data>
  <Success>true</Success>
</QuerySoundCodeLabelBatchListResponse>

JSON格式

{
    "RequestId": "66FF51D3-***-49F1-B1A2-***",
    "Data": {
        "PageId": "1",
        "PageSize": "20",
        "Total": "200",
        "List": {
            "Items": [
                {
                    "Status": "RUNNING",
                    "GmtCreate": "1620634297000",
                    "Description": "test",
                    "SuccessNum": "1",
                    "BatchCode": "Md3ZiTL888K9llXDy7890***********",
                    "Total": "20"
                }
            ]
        }
    },
    "Success": "true"
}

错误码

HttpCode 错误码 错误信息 描述
403 iot.soundcodeservice.NotSigned sound code service has not been signed 声码服务未开通
400 iot.soundcode.InvalidIotInstanceId invalid iot instance id 无效的实例ID
400 iot.soundcode.InvalidParam invalid param 无效的参数

访问错误中心查看更多错误码。