DescribeSearchTemplates - ActionTrail - Centro de documentación de Alibaba Cloud

Consulta las plantillas del sistema de consultas avanzadas para un escenario especificado.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

actiontrail:DescribeSearchTemplates

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
SceneId	string	Sí	El ID del escenario.	sc-lpYrjKouRfy3MK-wteJW_Q
PageNumber	integer	No	El número de página. Valor predeterminado: 1.	1
PageSize	integer	No	El número máximo de resultados a devolver. Valor predeterminado: 20.	20

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
PageNumber	integer	El número de página actual.	1
PageSize	integer	El número máximo de resultados devueltos.	20
RequestId	string	El ID de la solicitud.	787DD24A-E322-5C0D-A730-057FE62B****
TemplateList	array<object>	La lista de detalles de las plantillas.
	object
Charts `deprecated`	string	[Obsoleto] La lista de paneles. Este campo está obsoleto y ya no devuelve datos válidos. El valor de retorno actual siempre es una matriz vacía `[]`. Deje de usar este campo y elimine la dependencia del mismo en su código.	[]
Description	string	La descripción de la plantilla.	Eventos de inicios de sesión en la consola mediante cuenta en la nube
Params	string	Los parámetros de condiciones de consulta. Este campo se devuelve como una cadena serializada en JSON que contiene una lista estructurada de condiciones de consulta. Puede utilizar la herramienta estándar de deserialización JSON del lenguaje de programación correspondiente para analizarla en una matriz 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	El ID del escenario.	sc-lpYrjKouRfy3MK-wteJW_Q
Sql	string	La instrucción condicional de la consulta.	select "event.userIdentity.accountId" as account_id, count(1) as cnt group by account_id limit 1000
TemplateId	string	El ID de la plantilla.	tpl-wCZAFWx3Spq6CO9Ymp****
TemplateName	string	El nombre de la plantilla.	Eventos de inicios de sesión en la consola mediante cuenta en la nube
Token	string	El identificador de categoría de la plantilla.	identity.rootLogin
Type	string	El tipo de plantilla.	audit

Ejemplos

Respuesta exitosa

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 error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.