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

Obtém informações sobre uma biblioteca de pesquisa.

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:QuerySearchLib

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SearchLibName	string	Sim	O nome da biblioteca de pesquisa.	test1

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
RequestId	string	O ID da solicitação.	****11-DB8D-4A9A-875B-275798****
Success	string	Indica se a chamada foi bem-sucedida. true: A chamada foi bem-sucedida. false: A chamada falhou.	true
Code	string	O código de status.	200
SearchLibName	string	O nome da biblioteca de pesquisa.	test1
Status	string	O status da biblioteca de pesquisa. Valores válidos: normal : A biblioteca de pesquisa está no estado normal. deleting : A biblioteca de pesquisa está sendo excluída. deleteFail : Falha ao excluir a biblioteca de pesquisa.	normal
IndexInfo	array<object>	As informações do índice.
	object
IndexType	string	O tipo de índice. Valores válidos: mm: Modelo de linguagem grande (LLM). face: Reconhecimento facial. aiLabel: Marcação inteligente.	face
IndexStatus	string	O status do índice. Valores válidos: Active: O índice está ativo. Deactive: O índice está inativo.	Active
IndexReadiness	string	O status de prontidão do índice. Valores válidos: Initializing: O índice está sendo inicializado. Normal: O índice está pronto. Fail: Falha ao criar o índice.	Normal
SearchLibConfig	string	A configuração da biblioteca de pesquisa.	{"faceGroupIds":"xxx1,xxx2,xx3"}

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Success": "true",
  "Code": "200",
  "SearchLibName": "test1",
  "Status": "normal",
  "IndexInfo": [
    {
      "IndexType": "face",
      "IndexStatus": "Active",
      "IndexReadiness": "Normal"
    }
  ],
  "SearchLibConfig": "{\"faceGroupIds\":\"xxx1,xxx2,xx3\"}"
}

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.