DescribeSearchTemplates - ActionTrail: Central de Documentação do Alibaba Cloud

Consulta os modelos do sistema de consulta avançada para um cenário especificado.

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

actiontrail:DescribeSearchTemplates

list

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
SceneId	string	Sim	O ID do cenário.	sc-lpYrjKouRfy3MK-wteJW_Q
PageNumber	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número máximo de resultados a serem retornados. Valor padrão: 20.	20

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageNumber	integer	O número da página atual.	1
PageSize	integer	O número máximo de resultados retornados.	20
RequestId	string	O ID da solicitação.	787DD24A-E322-5C0D-A730-057FE62B****
TemplateList	array<object>	A lista de detalhes dos modelos.
	object
Charts `deprecated`	string	[Descontinuado] A lista de dashboards. Este campo está descontinuado e não retorna mais dados válidos. O valor de retorno atual é sempre um array vazio `[]`. Pare de usar este campo e remova a dependência dele do seu código.	[]
Description	string	A descrição do modelo.	Eventos de logons no console usando conta em nuvem
Params	string	Os parâmetros de condição de consulta. Este campo é retornado como uma string de serialização JSON que contém uma lista estruturada de condições de consulta. Você pode usar a ferramenta padrão de desserialização JSON da linguagem de programação correspondente para analisá-lo em um array de objetos.	[{"key":"event.eventName","value":"ConsoleSignin","type":"system","display":true,"displayKey":"event.eventName","displayValue":"ConsoleSignin","displayValueEn":"ConsoleSignin"},{"oper":"AND","key":"event.userIdentity.type","value":"root-account","type":"system","display":true,"displayKey":"event.userIdentity.type","displayValueEn":"Alibaba Cloud Account"}]
SceneId	string	O ID do cenário.	sc-lpYrjKouRfy3MK-wteJW_Q
Sql	string	A instrução condicional de consulta.	select "event.userIdentity.accountId" as account_id, count(1) as cnt group by account_id limit 1000
TemplateId	string	O ID do modelo.	tpl-wCZAFWx3Spq6CO9Ymp****
TemplateName	string	O nome do modelo.	Eventos de logons no console usando conta em nuvem
Token	string	O identificador de categoria do modelo.	identity.rootLogin
Type	string	O tipo de modelo.	audit

Exemplos

Resposta de sucesso

JSON formato

{
  "PageNumber": 1,
  "PageSize": 20,
  "RequestId": "787DD24A-E322-5C0D-A730-057FE62B****",
  "TemplateList": [
    {
      "Charts": "[]",
      "Description": "Events of Console Logons by Using Cloud Account",
      "Params": "[{\"key\":\"event.eventName\",\"value\":\"ConsoleSignin\",\"type\":\"system\",\"display\":true,\"displayKey\":\"event.eventName\",\"displayValue\":\"ConsoleSignin\",\"displayValueEn\":\"ConsoleSignin\"},{\"oper\":\"AND\",\"key\":\"event.userIdentity.type\",\"value\":\"root-account\",\"type\":\"system\",\"display\":true,\"displayKey\":\"event.userIdentity.type\",\"displayValueEn\":\"Alibaba Cloud Account\"}]",
      "SceneId": "sc-lpYrjKouRfy3MK-wteJW_Q",
      "Sql": "select \"event.userIdentity.accountId\" as account_id, count(1) as cnt group by account_id limit 1000",
      "TemplateId": "tpl-wCZAFWx3Spq6CO9Ymp****",
      "TemplateName": "Events of Console Logons by Using Cloud Account",
      "Token": "identity.rootLogin",
      "Type": "audit"
    }
  ]
}

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.