ListHotwordLibraries - 查询所有热词库列表

获取指定条件下的所有热词库信息。

接口说明

请求说明

  • 该接口用于查询用户创建的所有热词库的列表。
  • 可以通过 Name 参数进行模糊搜索,支持分页和时间范围筛选。
  • 默认按创建时间倒序排列,可以通过 SortBy 参数调整排序方式。
  • 每次请求返回的最大记录条数为 100,默认值为 10。
  • 使用 NextToken 参数可以实现分页读取数据。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:ListHotwordLibrarieslist
*全部资源
*

请求参数

名称类型必填描述示例值
NextTokenstring

当前开始读取的位置

****73f33c91-d59383e8280b****
PageNolong

当前页码。默认值为 1。

1
PageSizelong

分页大小,每页显示条数。默认值为 10,最大值为 100。

10
SortBystring

排序参数,默认根据创建时间倒序

CreationTime:Desc
Namestring

热词库名称

热词库使用名称
UsageScenariostring

词库的使用场景:

  • ASR 智能文本识别:ASR
  • 结构化媒资:StructuredMediaAssets
  • 视频翻译:VideoTranslation 词库一旦新增后,该字段不可修改
ASR
StartTimestring

筛选开始时间

2020-12-26T04:11:10Z
EndTimestring

筛选结束时间

2020-12-26T04:11:10Z
MaxResultsinteger

本次请求所返回的最大记录条数。

最大值:100,默认值:10

10

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

****9262E3DA-07FA-4862-FCBB6BC61D08*****
NextTokenstring

用来表示当前调用返回读取到的位置,空代表数据已经读取完毕。

CBB6BC61D08
MaxResultsinteger

返回热词库信息的最大数量

10
TotalCountinteger

热词库总数

20
HotwordLibraryListarray<object>

热词库列表

热词信息列表object
Descriptionstring

描述,长度上限 200

存放名人的词库
UsageScenariostring

词库的使用场景:

  • ASR 智能文本识别:ASR
  • 结构化媒资:StructuredMediaAssets
  • 视频翻译:VideoTranslation 词库一旦新增后,该字段不可修改
ASR
ModifiedTimestring

修改时间

2017-01-11T12:00:00Z
CreationTimestring

创建时间

2017-01-11T12:00:00Z
HotwordLibraryIdstring

词库 ID。

a93b91141c0f422fa114af203f8b****
Namestring

词库名称。

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"
    }
  ]
}

错误码

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