ListStatisticLogs - OpenSearch - Alibaba Cloud Documentation Center

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
opensearch:ListStatisticLogs		AppGroup acs:opensearch:{#regionId}:{#accountId}:app-groups/{#AppGroupId}	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The application name.	app_group_name
moduleName	string	Yes	The module name. Valid values: hot: rankings of hotwords. error: application error logs. slow-log: slow query logs. Set the value to hot.	hot
startTime	integer	No	The beginning of the time range to query. The default value is the timestamp of 00:00:00 on the current day.	1582214400
stopTime	integer	No	The end of the time range to query. The default value is the timestamp of 24:00:00 on the current day.	1682222400
pageNumber	integer	No	The page number. Default value: 1.	1
pageSize	integer	No	The number of entries per page. Default value: 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 in statistical reports.	wordsTopPv

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
totalCount	long	The total number of entries returned.	1
requestId	string	The request ID.	F76ACE3D-E510-EE2C-B7B1-39B3136A61EE
result	array<object>	The returned result. For more information, see Parameters of hotwords rankings.	[]
result	object	The returned result. For more information, see Parameters of hotwords rankings.	[]

Parameters of hotwords rankings

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

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history