Querying Instance Diagnosis Reports

Function

This API is used to query instance diagnosis reports.

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	Project ID To obtain the value, see Obtaining a Project ID.
instance_id	Yes	String	Instance ID

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
start_at	Yes	Long	Start time in Unix timestamp format, in milliseconds
end_at	Yes	Long	End time in Unix timestamp format, in milliseconds
offset	No	Integer	Offset. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value must be a number but cannot be a negative number.
limit	No	Integer	Number of records displayed on each page. The default value is 10, and the maximum value is 200.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token
X-Language	No	String	Language Enumerated values: zh-cn en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Long	Number of diagnosis reports
health_report_task_list	Array of Table 5 objects	Diagnosis report list

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

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

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

Success

{ 
  "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 
}