获取指定条件下的所有热词库信息。
接口说明
请求说明
该接口用于查询用户创建的所有热词库的列表。
可以通过
Name参数进行模糊搜索,支持分页和时间范围筛选。默认按创建时间倒序排列,可以通过
SortBy参数调整排序方式。每次请求返回的最大记录条数为 100,默认值为 10。
使用
NextToken参数可以实现分页读取数据。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ice:ListHotwordLibraries |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| NextToken |
string |
否 |
当前开始读取的位置 |
****73f33c91-d59383e8280b**** |
| PageNo |
integer |
否 |
当前页码。默认值为 1。 |
1 |
| PageSize |
integer |
否 |
分页大小,每页显示条数。默认值为 10,最大值为 100。 |
10 |
| SortBy |
string |
否 |
排序参数,默认根据创建时间倒序 |
CreationTime:Desc |
| Name |
string |
否 |
热词库名称 |
热词库使用名称 |
| UsageScenario |
string |
否 |
词库的使用场景:
|
ASR |
| StartTime |
string |
否 |
筛选开始时间 |
2020-12-26T04:11:10Z |
| EndTime |
string |
否 |
筛选结束时间 |
2020-12-26T04:11:10Z |
| MaxResults |
integer |
否 |
本次请求所返回的最大记录条数。 最大值:100,默认值:10 |
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
****9262E3DA-07FA-4862-FCBB6BC61D08***** |
| NextToken |
string |
用来表示当前调用返回读取到的位置,空代表数据已经读取完毕。 |
CBB6BC61D08 |
| MaxResults |
integer |
返回热词库信息的最大数量 |
10 |
| TotalCount |
integer |
热词库总数 |
20 |
| HotwordLibraryList |
array<object> |
热词库列表 |
|
|
object |
|||
| Description |
string |
描述,长度上限 200 |
存放名人的词库 |
| UsageScenario |
string |
词库的使用场景:
|
ASR |
| ModifiedTime |
string |
修改时间 |
2017-01-11T12:00:00Z |
| CreationTime |
string |
创建时间 |
2017-01-11T12:00:00Z |
| HotwordLibraryId |
string |
词库 ID。 |
a93b91141c0f422fa114af203f8b**** |
| Name |
string |
词库名称。 |
my_hotwords |
示例
正常返回示例
JSON格式
{
"RequestId": "****9262E3DA-07FA-4862-FCBB6BC61D08*****",
"NextToken": "CBB6BC61D08",
"MaxResults": 10,
"TotalCount": 20,
"HotwordLibraryList": [
{
"Description": "存放名人的词库",
"UsageScenario": "ASR",
"ModifiedTime": "2017-01-11T12:00:00Z\n",
"CreationTime": "2017-01-11T12:00:00Z",
"HotwordLibraryId": "a93b91141c0f422fa114af203f8b****",
"Name": "my_hotwords"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。