ListHotwordLibraries-Intelligent Media Services(IMS)-阿里云帮助中心

Retrieves the information of all hotword libraries based on specified conditions.

Operation description

This operation queries the list of all hotword libraries created by users.
You can use the Name parameter for fuzzy search. Pagination and time range filtering are supported.
By default, the results are sorted in descending order of creation time. You can use the SortBy parameter to adjust the sorting method.
The maximum number of records returned per request is 100. The default value is 10.
You can use the NextToken parameter to read data in pages.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:ListHotwordLibraries

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The position from which to start reading.	**73f33c91-d59383e8280b**
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10
SortBy	string	No	The sorting parameter. By default, the results are sorted in descending order of creation time.	CreationTime:Desc
Name	string	No	The name of the hotword library.	Hotword library name
UsageScenario	string	No	The scenarios of the hotword library. Valid values: ASR: ASR intelligent text recognition. StructuredMediaAssets: Structured media assets. VideoTranslation: Video translation. Once a hotword library is created, this field cannot be modified.	ASR
StartTime	string	No	The start time for filtering. The time is in ISO 8601 format and uses UTC time (ending with Z).	2020-12-26T04:11:10Z
EndTime	string	No	The end time for filtering. The time is in ISO 8601 format and uses UTC time (ending with Z).	2020-12-26T04:11:10Z
MaxResults	integer	No	The maximum number of records returned for the current request. Maximum value: 100. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	**9262E3DA-07FA-4862-FCBB6BC61D08***
NextToken	string	The position to which the current call has read. An empty value indicates that all data has been read.	CBB6BC61D08
MaxResults	integer	The maximum number of hotword library information records returned.	10
TotalCount	integer	The total number of hotword libraries.	20
HotwordLibraryList	array<object>	The list of hotword libraries.
	object
Description	string	The description. The maximum length is 200 characters.	Hotword library for celebrities
UsageScenario	string	The scenarios of the hotword library. Valid values: ASR: ASR intelligent text recognition. StructuredMediaAssets: Structured media assets. VideoTranslation: Video translation. Once a hotword library is created, this field cannot be modified.	ASR
ModifiedTime	string	The modification time. The time is in ISO 8601 format and uses UTC time (ending with Z).	2017-01-11T12:00:00Z
CreationTime	string	The creation time. The time is in ISO 8601 format and uses UTC time (ending with Z).	2017-01-11T12:00:00Z
HotwordLibraryId	string	The ID of the hotword library.	a93b91141c0f422fa114af203f8b****
Name	string	The name of the hotword library.	my_hotwords

Examples

Success response

JSON format

{
  "RequestId": "****9262E3DA-07FA-4862-FCBB6BC61D08*****",
  "NextToken": "CBB6BC61D08",
  "MaxResults": 10,
  "TotalCount": 20,
  "HotwordLibraryList": [
    {
      "Description": "Hotword library for celebrities",
      "UsageScenario": "ASR",
      "ModifiedTime": "2017-01-11T12:00:00Z\n",
      "CreationTime": "2017-01-11T12:00:00Z",
      "HotwordLibraryId": "a93b91141c0f422fa114af203f8b****",
      "Name": "my_hotwords"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.