All Products
Search
Document Center

OpenSearch:ListSlowQueryCategories

Last Updated:Mar 03, 2024

Queries the suggestions that are provided by Optimization Master for slow queries.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
opensearch:ListSlowQueryCategories
  • AppGroup
    acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}
    none
none

Request syntax

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

Request parameters

ParameterTypeRequiredDescriptionExample
appGroupIdentitystringYes

The name of the application

my_app_group_name

Sample requests

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

Query parameters

ParameterTypeRequiredExampleDescription
startIntegerYes1589986800The timestamp that specifies the beginning of the time range to query. The time is accurate to seconds.
endIntegerYes1589990340The timestamp that specifies the end of the time range to query. The time is accurate to seconds.
sortStringNo"max"The sort type.
Valid values:
-max: the maximum value
-avg: the average value
-sum: the sum value
-queryProportion: the query proportion

Response parameters

ParameterTypeDescriptionExample
object
requestIdstring

The ID of the request.

4406F40B-A0A2-9D5D-531F-3B6936567584
resultobject

The data returned.

startinteger

The timestamp that indicates the beginning of the time range to query.

1589986800
analyzeStatusstring

The status of the analysis. Valid values:

  • PENDING: preparing
  • SUCCESS: succeeded
  • RUNNING: running
  • FAILED: failed
  • N/A: unknown
"PENDING"
endinteger

The timestamp that indicates the end of the time range to query.

1589990340

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history