Query Slow Query Optimizer Results with ListSlowQueryQueries API - OpenSearch - Alibaba Cloud - OpenSearch

Lists the slow query statements from the optimization advisor.

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

none

*AppGroup

acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

None

Request syntax

GET /v4/openapi/app-groups/{appGroupIdentity}/optimizers/slow-query/categories/{categoryIndex}/queries HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The application name.	my_app_group_name
categoryIndex	string	Yes	The optimization suggestions ID.	0

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Query parameters

Field	Type	Required	Example	Description
start	Integer	Yes	1589986800	The start timestamp (in seconds).
end	Integer	Yes	1589990340	The end timestamp (in seconds).
size	Integer	No	10	The number of entries to return.

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	EB250CA0-ACFD-C5DE-17CD-01445BFE8AE5
result	object	The returned result.
index	integer	The optimization suggestions ID.	0
appQuery	string	The optimization suggestions information.	no data
start	integer	The start timestamp.	1589986800
end	integer	The end timestamp.	1589990340
queries	array<object>
	object
requestId	string
sumLcu	number
seekLcu	number
aggLcu	number
sortLcu	number
summaryLcu	number
otherLcu	number
appQuery	string
categoryAdvice	string

Examples

Success response

JSON format

{
  "requestId": "EB250CA0-ACFD-C5DE-17CD-01445BFE8AE5",
  "result": {
    "index": 0,
    "appQuery": "no data",
    "start": 1589986800,
    "end": 1589990340,
    "queries": [
      {
        "requestId": "",
        "sumLcu": 0,
        "seekLcu": 0,
        "aggLcu": 0,
        "sortLcu": 0,
        "summaryLcu": 0,
        "otherLcu": 0,
        "appQuery": "",
        "categoryAdvice": ""
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.