ListStatisticLogs - OpenSearch - Alibaba Cloud Documentation Center

Queries log statistics, such as application error logs, hotword rankings, and slow query logs.

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

opensearch:ListStatisticLogs

*AppGroup

acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}

None

Request syntax

GET /v4/openapi/app-groups/{appGroupIdentity}/statistic-logs/{moduleName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The application name.	app_group_name
moduleName	string	Yes	The module name. This is an enumeration. hot: hotword rankings error: application error logs slow-log: slow query logs Currently, only hot is supported.	hot

Request parameters

Parameter	Type	Required	Description	Example
startTime	integer	No	The start of the time range to query. The value must be a UNIX timestamp. The default value is the UNIX timestamp for 00:00:00 on the current day.	1582214400
stopTime	integer	No	The end of the time range to query. The value must be a UNIX timestamp. The default value is the UNIX timestamp for 24:00:00 on the current day.	1682222400
pageNumber	integer	No	The page number. The default value is 1.	1
pageSize	integer	No	The number of entries to return on each page. The default value is 10.	10
query	string	No	The content of the query clause.	"default:'OpenSearch'"
sortBy	string	No	The content of the sort clause.	"-id"
distinct	boolean	No	Specifies whether to use the distinct clause.	true
columns	string	No	The fields to query. Format: columns=wordsTopPv. For more information, see Metrics for query analysis.	wordsTopPv

Response elements

Element	Type	Description	Example
	object	The response body.	{}
totalCount	integer	The total number of entries returned.	1
requestId	string	The request ID.	F76ACE3D-E510-EE2C-B7B1-39B3136A61EE
result	array<object>	The returned data. For more information, see: Hotword rankings	[]
	object	The returned data. For more information, see: Hotword rankings	[ { "rawQuery":"Taobao", "pv":100 } ]

hot: Hotword rankings

Parameter	Type	Description
rawQuery	String	The hotword.
pv	Integer	The number of page views (PVs).

Examples

Success response

JSON format

{
  "totalCount": 1,
  "requestId": "F76ACE3D-E510-EE2C-B7B1-39B3136A61EE",
  "result": [
    [
      {
        "rawQuery": "Taobao",
        "pv": 100
      }
    ]
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.