DescribeSearchTemplates - 查询高级查询系统模板_操作审计(ActionTrail)-阿里云帮助中心

本接口用于查询指定场景下的高级查询系统模版。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

actiontrail:DescribeSearchTemplates

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
SceneId	string	是	场景 ID。	sc-lpYrjKouRfy3MK-wteJW_Q
PageNumber	integer	否	页码。默认值：1。	1
PageSize	integer	否	允许返回的最大结果数目。默认值：20。	20

返回参数

名称	类型	描述	示例值
	object
PageNumber	integer	当前页码。	1
PageSize	integer	允许返回的最大结果数目。	20
RequestId	string	请求 ID。	787DD24A-E322-5C0D-A730-057FE62B****
TemplateList	array<object>	模板详情列表。
	object
Charts	string	仪表盘列表（已废弃）。说明该字段已废弃，不再返回有效数据，当前返回值恒为空数组`[]`。建议您停止使用并从代码中移除对该字段的依赖。	[]
Description	string	模板描述。	Events of Console Logons by Using Cloud Account
Params	string	查询条件参数。该字段以 JSON 序列化字符串的形式返回，内容为结构化的查询条件列表。您可使用对应编程语言的标准 JSON 反序列化工具将其解析为对象数组。	[{"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	场景 ID。	sc-lpYrjKouRfy3MK-wteJW_Q
Sql	string	查询条件语句。	select "event.userIdentity.accountId" as account_id, count(1) as cnt group by account_id limit 1000
TemplateId	string	模板 ID。	tpl-wCZAFWx3Spq6CO9Ymp****
TemplateName	string	模板名称。	Events of Console Logons by Using Cloud Account
Token	string	模板分类标识。	identity.rootLogin
Type	string	模板类型。	audit

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。