ListHotwordLibraries - Intelligent Media Services - Alibaba Cloud Documentation Center

Queries hotword libraries that meet specific search conditions.

Operation description

You can call this operation to get information about all hotword libraries that you created.
The API supports fuzzy search by Name, filtering by creation time range, and pagination.
By default, the results are sorted by creation time in descending order. You can set SortBy to change the sorting order.
The maximum number of entries returned for each request is 100. Default value: 10.
Use NextToken for pagination.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ice:ListHotwordLibraries	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results.	**73f33c91-d59383e8280b**
PageNo	long	No	The page number. Default value: 1.	1
PageSize	long	No	The number of entries per page. Default value: 10. Valid values: 1 to 100.	10
SortBy	string	No	The sorting order. By default, the query results are sorted by creation time in descending order.	CreationTime:Desc
Name	string	No	The name of the hotword library.
UsageScenario	string	No	The usage scenario of the hotword library. Valid values: ASR: Automatic Speech Recognition StructuredMediaAssets: structured media analysis VideoTranslation: Video translation. This field cannot be modified after the hotword library is created.	ASR
StartTime	string	No	The beginning of the time range to query.	2020-12-26T04:11:10Z
EndTime	string	No	The end of the time range to query.	2020-12-26T04:11:10Z
MaxResults	integer	No	The maximum number of entries to return. Default value: 10. Valid values: 1 to 100.	10

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	**9262E3DA-07FA-4862-FCBB6BC61D08***
NextToken	string	A pagination token that can be used in the next request to retrieve a new page of results. If it is empty, all results are returned.	CBB6BC61D08
MaxResults	integer	The maximum number of hotword libraries that can be returned.	10
TotalCount	integer	The total number of hotword libraries.	20
HotwordLibraryList	array<object>	The hotword libraries.
	object
Description	string	The description of the hotword library. It can be up to 200 characters in length.
UsageScenario	string	The usage scenario of the hotword library. Valid values: ASR: Automatic Speech Recognition StructuredMediaAssets: structured media analysis VideoTranslation: Video translation This field cannot be modified after the hotword library is created.	ASR
ModifiedTime	string	The time when the hotword library was last modified.	2017-01-11T12:00:00Z
CreationTime	string	The time when the hotword library was created.	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

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.