DescribeAdvancedQueryTemplate - ActionTrail - Alibaba Cloud Documentation Center

Queries advanced query templates.

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:DescribeAdvancedQueryTemplate

list

*AdvancedQueryTemplate

acs:actiontrail:{#regionId}:{#accountId}:advancedquerytemplate/*

None

Request parameters

Parameter	Type	Required	Description	Example
TemplateName	string	No	The name of the template. This operation performs a case-insensitive, fuzzy match. If you do not specify a name, all templates are returned. For example, if you specify `a`, templates named `a1` and `a2` are returned. If you leave this parameter empty, templates named `a1`, `a2`, `b1`, and `c1` are returned.	example-template
PageNumber	integer	No	The page number. The value starts from 1. Default value: 1.	1
PageSize	integer	No	The maximum number of results to return. Default value: 20.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	1EC1FDC7-6D01-559F-852C-30D86E9EEB3F
TemplatePage	object	The paginated list of templates.
PageNumber	string	The page number.	1
PageSize	string	The maximum number of results returned. Default value: 20.	20
TemplateList	array<object>	The list of template details.
	object
SimpleQuery	boolean	Indicates whether the simple query mode is enabled.	false
TemplateId	string	The template ID.	utpl-7OaxbyJATDaoLOgZRc****
TemplateName	string	The template name.	example-template
TemplateSql	string	The query statement.	event.userIdentity.type: root-account AND event.userIdentity.accessKeyId: *
Total	integer	The total number of records.	5

Examples

Success response

JSON format

{
  "RequestId": "1EC1FDC7-6D01-559F-852C-30D86E9EEB3F",
  "TemplatePage": {
    "PageNumber": "1",
    "PageSize": "20",
    "TemplateList": [
      {
        "SimpleQuery": false,
        "TemplateId": "utpl-7OaxbyJATDaoLOgZRc****",
        "TemplateName": "example-template",
        "TemplateSql": "event.userIdentity.type: root-account AND event.userIdentity.accessKeyId: *"
      }
    ],
    "Total": 5
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.