ListHotwordLibraries - Intelligent Media Services: Central de Documentação do Alibaba Cloud

Consulta bibliotecas de palavras-chave que atendem a condições de pesquisa específicas.

Descrição da operação

Obtém informações sobre todas as bibliotecas de palavras-chave que você criou.
A API oferece suporte a pesquisa fuzzy por Name, filtragem por intervalo de tempo de criação e paginação.
Por padrão, os resultados são classificados por tempo de criação em ordem decrescente. Você pode definir SortBy para alterar a ordem de classificação.
O número máximo de entradas retornadas para cada solicitação é 100. Valor padrão: 10.
Use NextToken para paginação.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ice:ListHotwordLibraries

list

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
NextToken	string	Não	O token de paginação que é usado na próxima solicitação para recuperar uma nova página de resultados.	**73f33c91-d59383e8280b**
PageNo	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10. Valores válidos: 1 a 100.	10
SortBy	string	Não	A ordem de classificação. Por padrão, os resultados da consulta são classificados por tempo de criação em ordem decrescente.	CreationTime:Desc
Name	string	Não	O nome da biblioteca de palavras-chave.	Hotword library name
UsageScenario	string	Não	O cenário de uso da biblioteca de palavras-chave. Valores válidos: ASR: Reconhecimento Automático de Fala StructuredMediaAssets: Análise de mídia estruturada VideoTranslation: Tradução de vídeo. Este campo não pode ser modificado após a criação da biblioteca de palavras-chave.	ASR
StartTime	string	Não	O início do intervalo de tempo a ser consultado.	2020-12-26T04:11:10Z
EndTime	string	Não	O fim do intervalo de tempo a ser consultado.	2020-12-26T04:11:10Z
MaxResults	integer	Não	O número máximo de entradas a serem retornadas. Valor padrão: 10. Valores válidos: 1 a 100.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da Resposta.
RequestId	string	O ID da solicitação.	**9262E3DA-07FA-4862-FCBB6BC61D08***
NextToken	string	Um token de paginação que pode ser usado na próxima solicitação para recuperar uma nova página de resultados. Se estiver vazio, todos os resultados serão retornados.	CBB6BC61D08
MaxResults	integer	O número máximo de bibliotecas de palavras-chave que podem ser retornadas.	10
TotalCount	integer	O número total de bibliotecas de palavras-chave.	20
HotwordLibraryList	array<object>	As bibliotecas de palavras-chave.
	object
Description	string	A descrição da biblioteca de palavras-chave. Pode ter até 200 caracteres de comprimento.	Lexicon containing celebrity names
UsageScenario	string	O cenário de uso da biblioteca de palavras-chave. Valores válidos: ASR: Reconhecimento Automático de Fala StructuredMediaAssets: Análise de mídia estruturada VideoTranslation: Tradução de vídeo. Este campo não pode ser modificado após a criação da biblioteca de palavras-chave.	ASR
ModifiedTime	string	A hora em que a biblioteca de palavras-chave foi modificada pela última vez.	2017-01-11T12:00:00Z
CreationTime	string	A hora em que a biblioteca de palavras-chave foi criada.	2017-01-11T12:00:00Z
HotwordLibraryId	string	O ID da biblioteca de palavras-chave.	a93b91141c0f422fa114af203f8b****
Name	string	O nome da biblioteca de palavras-chave.	my_hotwords

Exemplos

Resposta de sucesso

JSON formato

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

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.