Query DAS Inspection Reports via GetInstanceGroupInspectReportList API - Database Autonomy Service - Alibaba Cloud - Database Autonomy Service

Operation description

Enabling the O&M report feature for DAS Agent allows the system to perform regular inspections on target instances and generate reports. Currently, only daily reports are supported.

Before you call this operation, make sure that the following prerequisites are met:

You have activated DAS Agent and the agent is still within its validity period.
You have enabled the daily report feature on the DAS Agent configuration page.
If you use the Alibaba Cloud SDK, ensure that the version of aliyun-sdk-core is later than 4.3.3. The latest version is recommended.
The version of the DAS SDK is 1.0.3 or later.
When you use the SDK to call DAS, specify the region as cn-shanghai.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hdm:GetInstanceGroupInspectReportList

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	No	The reserved parameter.	null
AgentId	string	No	Optional. The default agent is used by default. Alternatively, you can specify an agent that was generated after DAS Agent was activated or manually created.	ag-472T0DxtmjIxxxxx
StartTime	integer	Yes	The start time of the query, which is a UNIX timestamp in milliseconds.	1596177993000
EndTime	integer	Yes	The end time of the query, which is a UNIX timestamp in milliseconds.	1655427625000
ReportType	string	No	The type of the inspection report.	daily

Response elements

Element	Type	Description	Example
	object	Schema of Response
Code	string	The returned status code.	200
Message	string	The returned message. Note If the request is successful, Successful is returned. If the request fails, an exception message such as an error code is returned.	Successful
RequestId	string	The ID of the request.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Data	array<object>	List
	object	The list of details, including the report ID, task date, and task status.
ReportId	string	The ID of the report.	13f52040-5a6e-42c3-bb84-051f5d6d****
Status	string	The status of the task. Valid values: WAITING_UNREADY = 0, WAITING_READY = 1, PROCESSING = 2, FINISHED = 3, ERROR = 4, and STOPPED = -1.	3
ReportDate	string	The date of diagnosis, in the YYYY-MM-DD format.	2025-12-10
CreateTime	string	The time when the task was created, in the YYYY-MM-DD HH:mm:ss format.	2025-12-11 00:39:00

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true",
  "Data": [
    {
      "ReportId": "13f52040-5a6e-42c3-bb84-051f5d6d****",
      "Status": "3",
      "ReportDate": "2025-12-10",
      "CreateTime": "2025-12-11 00:39:00"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.	You do not have the permission to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.