DocsICP FilingConsole
Documentation

CancelSqlPatternCompareReport

Updated at:
Copy as MD
My Favorites

Cancels an SQL Pattern comparison report.

Operation description

Cancels a specified SQL Pattern comparison report. Reports in the following statuses can be canceled:

  • PENDING: Waiting to be generated.

  • RUNNING: Being generated.

Note

  • Only reports with CancelAvailable set to true can be canceled.

  • Reports that are completed, failed, or expired cannot be canceled.

  • When you cancel an already canceled report again, Canceled still returns true, and CancelTime retains the time of the first cancellation.

  • Reports are isolated by instance and Alibaba Cloud account.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example
RegionId

string

Yes

The region ID of the instance.

cn-beijing
DBClusterId

string

Yes

The AnalyticDB for MySQL instance ID.

am-2ze1234567890****
ReportId

integer

Yes

The SQL Pattern comparison report ID.

1001

Response elements

Element

Type

Description

Example

object

The report cancellation result.

CancelTime

string

The time when the report was first canceled. The time is in UTC in the yyyy-MM-ddTHH:mmZ format.

2026-09-08T01:06Z
Canceled

boolean

Indicates whether the report is canceled. The value true is returned when the report is successfully canceled or canceled again.

true
ReportId

integer

The SQL Pattern comparison report ID.

1001
RequestId

string

The request ID.

9A1B2C3D-4E5F-6789-ABCD-0123456789AB

Examples

Success response

JSON format

{
  "CancelTime": "2026-09-08T01:06Z",
  "Canceled": true,
  "ReportId": 1001,
  "RequestId": "9A1B2C3D-4E5F-6789-ABCD-0123456789AB"
}

Error codes

HTTP status code

Error code

Error message

Description
400 IdempotentParameterMismatch The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.