All Products
Search
Document Center

Database Autonomy Service:GetQueryOptimizeDataTop

更新時間:Aug 09, 2024

Queries information about the best-performing and worst-performing instances based on query governance data.

Operation description

  • If you use an Alibaba Cloud SDK, make sure that the aliyun-sdk-core version is later than V2.1.8. We recommend that you use the latest version.

  • The version of your Database Autonomy Service (DAS) SDK must be V2.1.8 or later.

  • If you use an SDK to call API operations of DAS, you must set the region ID to cn-shanghai.

  • This operation supports the following database engines:

    • ApsaraDB RDS for MySQL
    • PolarDB for MySQL
    • ApsaraDB RDS for PostgreSQL

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
hdm:GetQueryOptimizeDataTopget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EnginestringYes

The database engine. Valid values:

  • MySQL
  • PolarDBMySQL
  • PostgreSQL
MySQL
InstanceIdsstringNo

The instance IDs. Separate multiple IDs with commas (,).

rm-2ze8g2am97624****
TagNamesstringNo

The reserved parameter.

None
TimestringYes

The time range to query. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1642953600000
TypestringYes

The type of instances that you want to query. Valid values:

  • RED: the best-performing instances
  • BLACK: the worst-performing instances
RED
RegionstringNo

The region in which the instance resides. Valid values:

  • cn-china: Chinese mainland
  • cn-hongkong: China (Hong Kong)
  • ap-southeast-1: Singapore

This parameter takes effect only if InstanceIds is left empty. If you leave InstanceIds empty, the system obtains data from the region set by Region. By default, Region is set to cn-china. If you specify InstanceIds, Region does not take effect and the system obtains data from the region in which the first specified instance resides.****

Note Set this parameter to cn-china for all your instances that reside in the regions in the Chinese mainland.
cn-china

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code returned.

200
Messagestring

The returned message.

Successful
Dataobject

The detailed information.

Totallong

The total number of entries returned.

10
PageNointeger

The reserved parameter.

None
PageSizeinteger

The reserved parameter.

None
Extrastring

The reserved parameter.

None
Listarray<object>

The information about the instances.

object
InstanceIdstring

The instance ID.

rm-2ze8g2am97624****
Typestring

The metric name. Valid values:

  • sqlExecuteCount: the number of slow SQL executions.
  • optimizedSqlExecuteCount: the number of slow SQL executions that need to be optimized.
sqlExecuteCount
Valuedouble

The metric value.

100
RequestIdstring

The request ID.

B6D17591-B48B-4D31-9CD6-9B9796B2****
Successstring

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "Total": 10,
    "PageNo": 0,
    "PageSize": 0,
    "Extra": "None",
    "List": [
      {
        "InstanceId": "rm-2ze8g2am97624****",
        "Type": "sqlExecuteCount",
        "Value": 100
      }
    ]
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true"
}

Error codes

HTTP status codeError codeError message
400InvalidParamsThe request parameters are invalid.
403NoPermissionYou are not authorized to do this action.

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

Change history

Change timeSummary of changesOperation
2023-03-29The request parameters of the API has changedView Change Details