All Products
Search
Document Center

Database Autonomy Service:GetAsyncErrorRequestStatByCode

Last Updated:Sep 25, 2024

Asynchronously queries the MySQL error codes in SQL Explorer data and the number of SQL queries corresponding to each error code.

Operation description

Note GetAsyncErrorRequestStatByCode is an asynchronous operation After a request is sent, the complete results are not returned immediately. If the value of isFinish is false in the response, wait for 1 second and then send a request again. If the value of isFinish is true, the complete results are returned.
  • This API operation supports only ApsaraDB RDS for MySQL instances and PolarDB for MySQL clusters for which Database Autonomy Service (DAS) Enterprise Edition is enabled. For more information, see Purchase DAS Enterprise Edition.
  • If you use an SDK to call API operations of DAS, you must set the region ID to cn-shanghai.

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

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The instance ID.

rm-2ze8g2am97624****
NodeIdstringNo

The node ID.

Note This parameter must be specified for PolarDB for MySQL clusters.
pi-wz9s658475e58****
StartlongNo

The beginning of 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.

Note The start time must be within the storage duration of the SQL Explorer feature of the database instance and can be up to 90 days earlier than the current time.
1642556990714
EndlongNo

The end of 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.

Note The end time must be later than the start time. The interval between the start time and the end time cannot exceed 24 hours.
1642566830000
DbNamestringNo

The name of a database.

testdb01

Response parameters

ParameterTypeDescriptionExample
object
Codelong

The HTTP status code returned.

200
Messagestring

The returned message.

Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.
Successful
Dataobject

The data returned.

failboolean

Indicates whether the asynchronous request failed. Valid values:

  • true
  • false
false
isFinishboolean

Indicates whether the asynchronous request was complete. Valid values:

  • true
  • false
true
resultIdstring

The ID of the asynchronous request.

async__fcd7c35788e62324622c3b4a03de****
statestring

The state of the asynchronous request. Valid values:

  • RUNNING
  • SUCCESS
  • FAIL
SUCCESS
timestamplong

The time when the asynchronous request was made. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1644560866961
completeboolean

Indicates whether the asynchronous request was complete.

  • true
  • false
true
resultarray<object>

The number of SQL queries corresponding to the error code.

statobject
instanceIdstring

The instance ID.

rm-2ze8g2am97624****
errorCodestring

The error code returned if the request failed.

1062
countinteger

The number of SQL queries corresponding to the error code.

1
RequestIdstring

The request ID.

840F51F7-9C01-538D-94F6-AE712905****
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "fail": false,
    "isFinish": true,
    "resultId": "async__fcd7c35788e62324622c3b4a03de****",
    "state": "SUCCESS",
    "timestamp": 1644560866961,
    "complete": true,
    "result": [
      {
        "instanceId": "rm-2ze8g2am97624****",
        "errorCode": "1062",
        "count": 1
      }
    ]
  },
  "RequestId": "840F51F7-9C01-538D-94F6-AE712905****",
  "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
No change history