All Products
Search

This Product

    ActionTrail:DescribeSearchTemplates

    Document Center

    ActionTrail:DescribeSearchTemplates

    Last Updated:Mar 26, 2026

    Queries advanced query templates for a specified scenario.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    actiontrail:DescribeSearchTemplates

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    SceneId

    string

    Yes

    The scenario ID.

    sc-lpYrjKouRfy3MK-wteJW_Q
    PageNumber

    integer

    No

    The page number. Default value: 1.

    1
    PageSize

    integer

    No

    The maximum number of entries to return. Default value: 20.

    20

    Response elements

    Element

    Type

    Description

    Example

    object

    PageNumber

    integer

    The page number.

    1
    PageSize

    integer

    The maximum number of results returned.

    Default value: 20.

    20
    RequestId

    string

    The request ID.

    787DD24A-E322-5C0D-A730-057FE62B****
    TemplateList

    array<object>

    The list of template details.

    object

    Charts

    string

    The list of dashboards. This parameter is deprecated.

    Note

    This parameter is deprecated and no longer returns valid data. The returned value is always an empty array []. Stop using this parameter and remove its dependency from your code.

    []
    Description

    string

    The template description.

    Events of Console Logons by Using Cloud Account
    Params

    string

    The filter conditions.
    This parameter is returned as a JSON-serialized string that contains a structured list of filter conditions. Use a standard JSON deserialization tool for your programming language to parse the string into an array of objects.

    [{"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

    The scenario ID.

    sc-lpYrjKouRfy3MK-wteJW_Q
    Sql

    string

    The query statement.

    select "event.userIdentity.accountId" as account_id, count(1) as cnt group by account_id limit 1000
    TemplateId

    string

    The template ID.

    tpl-wCZAFWx3Spq6CO9Ymp****
    TemplateName

    string

    The template name.

    Events of Console Logons by Using Cloud Account
    Token

    string

    The identifier for the template category.

    identity.rootLogin
    Type

    string

    The template type.

    audit

    Examples

    Success response

    JSON format

    {
  "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"
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.