获取指定条件下的所有热词库信息。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ice:ListHotwordLibraries | list | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
NextToken | string | 否 | 当前开始读取的位置 | ****73f33c91-d59383e8280b**** |
PageNo | long | 否 | 当前页码。默认值为 1。 | 1 |
PageSize | long | 否 | 分页大小,每页显示条数。默认值为 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 |
返回参数
示例
正常返回示例
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"
}
]
}
错误码
访问错误中心查看更多错误码。