ListSlowQueryCategories - OpenSearch - Alibaba Cloud Documentation Center

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

*AppGroup

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application.	my_app_group_name

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Request example

GET /v4/openapi/app-groups/kevintest2/optimizers/slow-query/categories?end=1589990340&sort=max&start=1589986800

Query parameters

Parameter	Type	Required	Example	Description
start	Integer	Yes	1589986800	The start of the time range to query. This is a UNIX timestamp and is accurate to the second.
end	Integer	Yes	1589990340	The end of the time range to query. This is a UNIX timestamp and is accurate to the second.
sort	String	No	"max"	The sorting method.Valid values: - max: the maximum value - avg: the average value - sum: the total value - queryProportion: the query proportion

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	4406F40B-A0A2-9D5D-531F-3B6936567584
result	object	The returned data.
start	integer	The start timestamp.	1589986800
analyzeStatus	string	The analysis status. PENDING: The analysis is being prepared. SUCCESS: The analysis is successful. RUNNING: The analysis is in progress. FAILED: The analysis failed. N/A: The analysis status is unknown.	"PENDING"
end	integer	The end timestamp.	1589990340

Examples

Success response

JSON format

{
  "requestId": "4406F40B-A0A2-9D5D-531F-3B6936567584",
  "result": {
    "start": 1589986800,
    "analyzeStatus": "\"PENDING\"",
    "end": 1589990340
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.