GetIndex - Simple Log Service: Central de Documentação do Alibaba Cloud

Consulta as informações de índice de um Logstore especificado.

Descrição da operação

O host na sintaxe da solicitação consiste no nome do projeto e no endpoint do Simple Log Service. Você deve especificar o projeto no host.

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

log:GetIndex

get

*LogStore

acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}

log:TLSVersion

Nenhuma

Sintaxe da solicitação

GET /logstores/{logstore}/index HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
logstore	string	Sim	O nome do Logstore.	test-logstore

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
project	string	Sim	O nome do projeto.	ali-test-project

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A estrutura da resposta.
index_mode	string	O tipo de índice.	v2
keys	object	A configuração do índice de campo. A chave é o nome do campo e o valor é a configuração do índice.
	IndexKey	A configuração de índice de um único campo.
lastModifyTime	integer	A hora da última atualização do índice. O valor é um carimbo de data/hora UNIX que representa o número de segundos decorridos desde 00:00:00 UTC em 1º de janeiro de 1970.	1524155379
line	object	A configuração do índice de texto completo.
caseSensitive	boolean	Especifica se o índice diferencia maiúsculas de minúsculas. Valores válidos: true: O índice diferencia maiúsculas de minúsculas. false: O índice não diferencia maiúsculas de minúsculas.	false
chn	boolean	Especifica se o índice contém caracteres chineses. Valores válidos: true: O índice contém caracteres chineses. false: O índice não contém caracteres chineses.	false
exclude_keys	array	A lista de campos excluídos.
	string	O campo excluído.	excludeField
include_keys	array	A lista de campos incluídos.
	string	O campo incluído.	includeField
token	array	A lista de delimitadores.
	string	O delimitador. Exemplos: ",", ".", "\r" e "\n".	,
log_reduce	boolean	Especifica se o LogReduce está ativado.	false
log_reduce_black_list	array	A lista negra para filtragem de campos do LogReduce. Este parâmetro entra em vigor apenas quando o LogReduce está ativado.
	string	O campo na lista negra.	b
log_reduce_white_list	array	A lista branca para filtragem de campos do LogReduce. Este parâmetro entra em vigor apenas quando o LogReduce está ativado.
	string	O campo na lista branca.	a
max_text_len	integer	Por padrão, o comprimento máximo de um valor de campo no Simple Log Service é de 2.048 bytes (2 KB). Para modificar o comprimento máximo de um valor de campo, você pode definir o comprimento máximo de um campo estatístico (texto). Valores válidos: 64 a 16384 bytes.	2048
storage	string	O tipo de armazenamento. O valor é fixo como pg.	pg
ttl	integer	O tempo de vida (TTL) do arquivo de índice. Valores válidos: 7, 30 e 90 dias.	30

Exemplos

Resposta de sucesso

JSON formato

{
  "index_mode": "v2",
  "keys": {
    "key": {
      "alias": "myAlias",
      "caseSensitive": true,
      "chn": true,
      "doc_value": true,
      "embedding": "sls-multilang-v3",
      "index_all": true,
      "json_keys": {
        "key": {
          "alias": "myAlias",
          "caseSensitive": true,
          "chn": true,
          "doc_value": true,
          "token": [
            "|"
          ],
          "type": "text"
        }
      },
      "max_depth": 10,
      "token": [
        "|"
      ],
      "type": "text",
      "vector_index": "high_recall"
    }
  },
  "lastModifyTime": 1524155379,
  "line": {
    "caseSensitive": false,
    "chn": false,
    "exclude_keys": [
      "excludeField"
    ],
    "include_keys": [
      "includeField"
    ],
    "token": [
      ","
    ]
  },
  "log_reduce": false,
  "log_reduce_black_list": [
    "b"
  ],
  "log_reduce_white_list": [
    "a"
  ],
  "max_text_len": 2048,
  "storage": "pg",
  "ttl": 30
}

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.