功能描述
DescribeSpeechQueues 接口用于查询语音识别队列。
请求
请求示例
GET /asrqueue HTTP/1.1Host: <BucketName-APPID>.ci.<Region>.myqcloud.comDate: <GMT Date>Authorization: <Auth String>Content-Length: <length>Content-Type: application/xml
请求参数
名称 | 描述 | 类型 | 是否必选 |
queueIds | 队列 ID,以“,”符号分割字符串 | string | 否 |
state | 1. Active 表示队列内的作业会被语音识别服务调度执行 2. Paused 表示队列暂停,作业不再会被语音识别服务调度执行,队列内的所有作业状态维持在暂停状态,已经处于识别中的任务将继续执行,不受影响 | string | 否 |
pageNumber | 第几页 | Int | 否 |
pageSize | 每页个数 | Int | 否 |
请求头
请求体
该请求的请求体为空。
响应
响应头
响应体
该响应体返回为 application/xml 数据,当指定 pageNumber 和 pageSize 时包含完整节点数据的内容展示如下:
<Response><RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId><TotalCount>1</TotalCount><PageNumber>1</PageNumber><PageSize>10</PageSize><QueueList><QueueId>A</QueueId><Name></Name><State>Active</State><MaxSize>10000</MaxSize><MaxConcurrent>10</MaxConcurrent><UpdateTime></UpdateTime><CreateTime></CreateTime><NotifyConfig><Url></Url><Type></Type><State></State><Event></Event></NotifyConfig></QueueList></Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
RequestId | Response | 请求的唯一 ID | String |
TotalCount | Response | 队列总数 | Int |
PageNumber | Response | 当前页数,同请求中的 pageNumber | Int |
PageSize | Response | 每页个数,同请求中的 pageSize | Int |
QueueList | Response | 队列数组 | Container |
Container 节点 QueueList 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
QueueId | Response.QueueList | 队列 ID | String |
Name | Response.QueueList | 队列名字 | String |
State | Response.QueueList | 当前状态,Active 或者 Paused | String |
NotifyConfig | Response.QueueList | 回调配置 | Container |
MaxSize | Response.QueueList | 队列最大长度 | Int |
MaxConcurrent | Response.QueueList | 当前队列最大并行执行的任务数 | Int |
UpdateTime | Response.QueueList | 更新时间 | String |
CreateTime | Response.QueueList | 创建时间 | String |
Container 节点 NotifyConfig 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Url | Response.QueueList.NotifyConfig | 回调地址 | String |
State | Response.QueueList.NotifyConfig | 开关状态,On 或者 Off | String |
Type | Response.QueueList.NotifyConfig | 回调类型,Url | String |
Event | Response.QueueList.NotifyConfig | 触发回调的事件 | String |
该响应体返回为 application/xml 数据,当指定 queueIds 时包含完整节点数据的内容展示如下:
<Response><RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId><QueueList><QueueId>A</QueueId><Name></Name><State>Active</State><NotifyConfig><Url></Url></NotifyConfig></QueueList><NonExistPIDs><QueueID>B</QueueID><QueueID>C</QueueID></NonExistPIDs></Response>
具体的数据内容如下:
节点名称(关键字) | 父节点 | 描述 | 类型 |
Response | 无 | 保存结果的容器 | Container |
Container 节点 Response 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
RequestId | Response | 请求的唯一 ID | String |
QueueList | Response | 队列数组,同上面解释的 QueueList | Container |
NonExistPIDs | Response | 不存在的队列 ID 列表 | Container |
Container 节点 NonExistPIDs 的内容:
节点名称(关键字) | 父节点 | 描述 | 类型 |
QueueID | Response.NonExistPIDs | 队列 ID | String |
错误码
实际案例
请求:查询语音识别队列
GET /asrqueue?pageNumber=1&pageSize=5 HTTP/1.1Connection: keep-aliveAccept-Encoding: gzip, deflateAccept: */*User-Agent: cos-python-sdk-v5.3.2Host: examplebucket-1250000000.ci.ap-chongqing.myqcloud.comContent-Type: application/xmlAuthorization: q-sign-algorithm=sha1&q-ak=AKIDnOr9IDiIUNYWGrrWb2IJ4YmywDXc****&q-sign-time=1597917121;1597927181&q-key-time=1597917121;1597927181&q-header-list=content-type;host&q-url-param-list=&q-signature=96322cc56f78ca161aaa6908f3d8af9105d2****
响应
HTTP/1.1 200 OKDate: Thu, 20 Aug 2020 09:53:02 GMTContent-Type: application/xmlContent-Length: 674Connection: keep-aliveServer: tencent-cix-ci-request-id: NWYzZTQ3ZmRfOTBmYTUwNjRfMjJh****<?xml version="1.0" encoding="utf-8"?><Response><TotalCount>1</TotalCount><RequestId>NWYzZTQ3ZmRfOTBmYTUwNjRfMjJh****</RequestId><PageNumber>1</PageNumber><PageSize>5</PageSize><QueueList><QueueId>pd0a7e02988c24db88b61551cf540444c</QueueId><Name>queue-speech-1</Name><State>Active</State><NotifyConfig><Url/><Event/><Type/><State>Off</State></NotifyConfig><MaxSize>10000</MaxSize><MaxConcurrent>10</MaxConcurrent><CreateTime>2020-08-20T17:52:33+0800</CreateTime><UpdateTime>2020-08-20T17:52:33+0800</UpdateTime><BucketId>examplebucket-1250000000</BucketId><Category>Speeching</Category></QueueList></Response>