DescribeAdvancedQueryTemplate
Queries advanced query templates.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
actiontrail:DescribeAdvancedQueryTemplate |
list |
*AdvancedQueryTemplate
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| TemplateName |
string |
No |
The template name. You can enter a partial template name to retrieve all matching templates. If the input matches partial characters of multiple template names, a list of all these templates is returned. If no input is provided, all available templates in the system are returned by default. Input: a Output: [a1, a2] Input: `` (no input) Output: [a1, a2, b1, c1] |
example-template |
| PageNumber |
integer |
No |
The page number of the template list. Starting value: 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 template paging query list. |
|
| PageNumber |
string |
The page number of the template list. |
1 |
| PageSize |
string |
The maximum number of results to return. 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.