All Products
Search
Document Center

Database Autonomy Service:GetQueryOptimizeExecErrorStats

Last Updated:Mar 03, 2024

Queries SQL templates that failed to be executed.

Operation description

  • If you use Alibaba Cloud SDK or Database Autonomy Service (DAS) SDK to call this operation, we recommend that you use the latest version of the SDK.

  • 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:GetQueryOptimizeExecErrorStatsRead
  • 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****
KeywordsstringNo

The keywords of the SQL template. Separate multiple keywords with spaces.

select update
LogicalOperatorstringNo

The logical relationship between multiple keywords. Valid values:

  • or
  • and
or
DbNamesstringNo

The name of the database to be queried.

testdb01
TimestringYes

The time range to query. Specify the time in the UNIX timestamp format. Unit: milliseconds.

1642953600000
PageSizestringYes

The number of entries per page. Default value: 10.

10
PageNostringYes

The page number. Pages start from page 1. Default value: 1.

1
OrderBystringNo

The field by which to sort the returned entries. Only error_count is supported, which specifies that the entries are sorted based on the number of failed executions.

error_count
AscstringNo

Specifies whether to sort the returned entries in ascending order. Default value: true. Valid values:

  • true: sorts the returned entries in ascending order.
  • false: does not sort the returned entries in ascending order.
true
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 the instances that are created 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, including the error codes and the number of entries that are returned.

Totallong

The total number of entries returned.

19
PageNointeger

The page number.

1
PageSizeinteger

The number of entries per page.

10
Extrastring

The reserved parameter.

None
Listobject []

The information about the SQL templates that failed to execute.

InstanceIdstring

The instance ID.

rm-2ze8g2am97624****
InstanceNamestring

The alias of the database instance.

test01
Dbnamestring

The name of the database.

testdb01
SqlIdstring

The SQL template ID.

2e8147b5ca2dfc640dfd5e43d96a****
SqlTextstring

The content of the SQL template.

select * from test1
ErrorCodestring

The error code returned if the request failed.

1146
ErrorCountlong

The number of errors.

10
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": 19,
    "PageNo": 1,
    "PageSize": 10,
    "Extra": "None",
    "List": [
      {
        "InstanceId": "rm-2ze8g2am97624****",
        "InstanceName": "test01",
        "Dbname": "testdb01",
        "SqlId": "2e8147b5ca2dfc640dfd5e43d96a****",
        "SqlText": "select * from test1",
        "ErrorCode": "1146",
        "ErrorCount": 10
      }
    ]
  },
  "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 Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Region