All Products
Search
Document Center

ApsaraDB RDS:GetInspectionReport

Last Updated:Mar 05, 2026

Queries the content of a specified inspection report.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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
rdsai:GetInspectionReportget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TaskIdstringYes

The ID of the inspection report.

9d246af2-a0cd-4f69-857d-3785048f****
InstanceIdstringNo

The inspected instance. If you do not specify this parameter, the complete report is returned. If you specify this parameter, only the content related to the instance is returned.

rm-2zep6e5u6l2yu****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

TaskIdstring

The inspection report ID.

9d246af2-a0cd-4f69-857d-3785048f****
MarkdownTextstring

The report text in the markdown format.

Dataarray<object>

The details of the result.

object

The information about the object.

InstanceIdstring

The instance ID.

rm-2zep6e5u6l2yu****
EngineTypestring

The engine type.

MySQL
InstanceDescstring

The description of the instance.

Regionstring

The region where the instance resides.

cn-beijing
MarkdownTextstring

The report text in the markdown format.

  • If the InstanceId parameter is not specified, all content of the inspection report is returned. However, the MarkdownText field is empty.
  • If the InstanceId parameter is specified, the content related to the instance is returned in the MarkdownText field.
StartTimestring

The start time of the inspection task. Specify the time in the YYYY-MM-DDTHH:mm:ssZ format.

2025-11-06T16:00:00Z
EndTimestring

The end time of the inspection. Specify the time in the YYYY-MM-DDTHH:mm:ssZ format.

2026-01-31T02:05:04Z
LevelSummaryobject

The hierarchical summary of the report.

Normallong

The number of normal records in the report.

10
Warninglong

The number of warnings in the report.

1
Errorlong

The number of errors in the report.

2
Failedlong

The number of failures in the report.

3
Dataarray<object>

The returned results.

object

The returned results.

Groupstring

The group ID.

instance_info
Itemsarray<object>

The items in the result.

object

The information about the object.

Namestring

The name of the category.

instance_runningstatus
Messagestring

The response message.

Levelstring

The level of the alert.

Normal
Dataarray<object>

The returned results.

object

The information about the object.

Keystring

The tag key.

DBInstanceStatus
Valuestring

The tag value.

Running
RequestIdstring

The request ID.

FE9C65D7-930F-57A5-A207-8C396329****

Examples

Sample success responses

JSONformat

{
  "TaskId": "9d246af2-a0cd-4f69-857d-3785048f****",
  "MarkdownText": "",
  "Data": [
    {
      "InstanceId": "rm-2zep6e5u6l2yu****",
      "EngineType": "MySQL",
      "InstanceDesc": "",
      "Region": "cn-beijing",
      "MarkdownText": "",
      "StartTime": "2025-11-06T16:00:00Z",
      "EndTime": "2026-01-31T02:05:04Z",
      "LevelSummary": {
        "Normal": 10,
        "Warning": 1,
        "Error": 2,
        "Failed": 3
      },
      "Data": [
        {
          "Group": "instance_info",
          "Items": [
            {
              "Name": "instance_runningstatus",
              "Message": "",
              "Level": "Normal",
              "Data": [
                {
                  "Key": "DBInstanceStatus",
                  "Value": "Running"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameterRequest parameter validation failed.Request parameter verification failed
403PermissionDeniedUser has no operation permission.User has no operation permission
403InvalidUserOrderThere is no valid order for this UID.There is no valid order for this UID
404TaskNotFoundThe resource of the specified ld does not exist.The resource of the specified ld does not exist.
500InternalErrorSystem internal exception.System internal exception

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

Change history

Change timeSummary of changesOperation
2026-02-05Add OperationView Change Details