Querying Instance Diagnosis Reports

Function

This API is used to query instance diagnosis reports.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: Required)	Condition Key	Alias	Dependency
das:clouddba:listDailyReports	list	Instance	-	das:clouddba:dailyReportsList	-

URI

GET /v3/{project_id}/instances/{instance_id}/get-instance-health-report-task-list

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region To obtain this value, see Obtaining a Project ID. Constraints: N/A Values: The value can contain 32 characters. Only letters and digits are allowed. Default value: N/A
instance_id	Yes	String	Explanation: Unique ID of an instance Constraints: N/A Values: The value can contain 32 characters. Only letters and digits are allowed. Default value: N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
start_at	Yes	Long	Explanation: Start time in the Unix timestamp format, in milliseconds Constraints: N/A Values: [0, 2^31-1]. The actual value depends on the query result. Default value: N/A
end_at	Yes	Long	Explanation: End time in the Unix timestamp format, in milliseconds Constraints: N/A Values: [0, 2^31-1]. The actual value depends on the query result. Default value: N/A
offset	No	Integer	Explanation: Index offset. The query starts from the next piece of data indexed by this parameter. If this parameter is set to 1 and limit is set to 10, only the second to eleventh records are displayed. Constraints: N/A Values: [0, 2^31-1] Default value: 0: The query starts from the first data record.
limit	No	Integer	Explanation: Records on each page Constraints: N/A Values: [0, 200]. The actual value depends on the query result. Default value: 10

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Long	Explanation: Number of diagnosis reports Values: N/A
health_report_task_list	Array of Table 4 objects	Explanation: Diagnosis reports Values: N/A

**Table 4** HealthReportTask
Parameter	Type	Description
task_id	String	Explanation: Report ID Values: N/A
instance_id	String	Explanation: Instance ID Values: N/A
create_at	Long	Explanation: Creation time in the Unix timestamp format, in milliseconds Values: N/A
report_status	String	Explanation: Diagnosis status Values: N/A
risk_count	Integer	Explanation: Number of risks Values: N/A
origin	String	Explanation: Trigger source Values: N/A
start_at	Long	Explanation: Diagnosis start time (in Unix timestamp format) in a daily report, in milliseconds Values: N/A
end_at	Long	Explanation: Diagnosis end time (in Unix timestamp format) in a daily report, in milliseconds Values: N/A

Example Request

Querying instance diagnosis reports

GET https://das.cn-north-7.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/instances/bcfa975193f1402fa11a6d4fd6baf5fbin01/get-instance-health-report-task-list?start_at=1727177896507&end_at=1728871794805

Example Response

Status code: 200

Successful request

{ 
  "health_report_task_list" : [ { 
    "instance_id" : "bcfa975193f1402fa11a6d4fd6baf5fbin01", 
    "task_id" : "8aa02bb1-ca4a-4724-ad3b-00993d6e08e0", 
    "create_at" : 1727200803179, 
    "report_status" : "SUCCESS", 
    "risk_count" : 1, 
    "origin" : "SYSTEM", 
    "start_at" : 1727064000211, 
    "end_at" : 1727150400211 
  } ], 
  "total" : 22 
}