DescribeDiagnosticReports -

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDiagnosticReports	The operation that you want to perform. Set the value to DescribeDiagnosticReports.
RegionId	String	Yes	cn-hangzhou	The region ID of the diagnostic report. You can call the DescribeRegions operation to query the most recent region list.
ReportIds.N	String	No	dr-uf6i0tv2refv8wz*****	The ID of diagnostic report N. You can specify up to 100 report IDs.
ResourceIds.N	String	No	i-uf6i0tv2refv8wz*****	The ID of resource N.
Status	String	No	Finished	The status of the diagnostic report. Valid values: InProgress Failed Finished
Severity	String	No	Normal	The severity level of the diagnostic report. Valid values: Unknown: The diagnostic does not start, fails to run, or unexpectedly exits without a diagnosis. Normal: No exceptions are detected. Info: Diagnostic information is recorded and may be related to exceptions. Warn: Diagnostic information is recorded and may indicate exceptions. Critical: Critical exceptions are detected.
NextToken	String	No	caeba0bbb2be03f84eb48b699f0a4883	The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of `NextToken`.
MaxResults	Integer	No	10	The number of entries per page. Valid values: 1 to 100. Default value: If this parameter is left empty, the default value is 10. If this parameter is set to a value greater than 100, the default value is 100.

Response parameters

Parameter	Type	Example	Description
RequestId	String	473469C7-AA6F-4DC5-B3DB-A3DC0DE*****	The ID of the request.
NextToken	String	caeba0bbb2be03f84eb48b699f0a4883	A pagination token. It can be used in the next request to retrieve a new page of results.
Reports	Array of Report		The diagnostic reports.
Report
ResourceId	String	i-uf6i0tv2refv8wz*****	The resource ID.
ResourceType	String	instance	The resource type.
MetricSetId	String	dms-bp17p0qwtr72zmu*****	The ID of the diagnostic metric set.
StartTime	String	2022-07-11T12:00:00Z	The beginning of the reporting period of the diagnostic report. The value is the StartTime value that was passed in when you called the CreateDiagnosticReport operation to create the diagnostic report.
EndTime	String	2022-07-11T14:00:00Z	The end of the reporting period of the diagnostic report. The value is the EndTime value that was passed in when you called the CreateDiagnosticReport operation to create the diagnostic report.
ReportId	String	dr-uf6i0tv2refv8wz*****	The ID of the diagnostic report.
Status	String	Finished	The status of the diagnostic report.
CreationTime	String	2022-07-11T12:00:00Z	The time when the diagnostic report was created.
FinishedTime	String	2022-07-11T14:00:00Z	The time when the diagnostic was complete.
Severity	String	Normal	The severity level of the diagnostic report. Valid values: Unknown: The diagnostic did not start, failed to run, or unexpectedly exited without a diagnosis. Normal: No exceptions were detected. Info: Diagnostic information was recorded and might be related to exceptions. Warn: Diagnostic information was recorded and might indicate exceptions. Critical: Critical exceptions were detected.
Issues	Array of Issue		The diagnosed issues.
Issue
MetricId	String	GuestOS.WinFirewall	The ID of the diagnostic metric.
MetricCategory	String	ECSService.GuestOS	The category of the diagnostic metric.
IssueId	String	GuestOS.CPU.HighUtiliz*****	The unique ID of the diagnosed issue.
Severity	String	Info	The severity level of the diagnostic metric. Valid values: Info: Diagnostic information was recorded and might be related to exceptions. Warn: Diagnostic information was recorded and might indicate exceptions. Critical: Critical exceptions were detected.

Examples

Sample requests

http(s)://ecs.aliyuncs.com/?Action=DescribeDiagnosticReports
&RegionId=cn-hangzhou
&ReportIds=["dr-uf6i0tv2refv8wz*****"]
&ResourceIds=["i-uf6i0tv2refv8wz*****"]
&Status=Finished
&Severity=Normal
&NextToken=caeba0bbb2be03f84eb48b699f0a4883
&MaxResults=10
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDiagnosticReportsResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE*****</RequestId>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <Reports>
        <ResourceId>i-uf6i0tv2refv8wz*****</ResourceId>
        <ResourceType>instance</ResourceType>
        <MetricSetId>dms-bp17p0qwtr72zmu*****</MetricSetId>
        <StartTime>2022-07-11T12:00:00Z</StartTime>
        <EndTime>2022-07-11T14:00:00Z</EndTime>
        <ReportId>dr-uf6i0tv2refv8wz*****</ReportId>
        <Status>Finished</Status>
        <CreationTime>2022-07-11T12:00:00Z</CreationTime>
        <FinishedTime>2022-07-11T14:00:00Z</FinishedTime>
        <Severity>Normal</Severity>
        <Issues>
            <MetricId>GuestOS.WinFirewall</MetricId>
            <MetricCategory>CPU</MetricCategory>
            <IssueId>GuestOS.CPU.HighUtiliz*****</IssueId>
            <Severity>Info</Severity>
        </Issues>
    </Reports>
</DescribeDiagnosticReportsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE*****",
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a4883",
  "Reports" : [ {
    "ResourceId" : "i-uf6i0tv2refv8wz*****",
    "ResourceType" : "instance",
    "MetricSetId" : "dms-bp17p0qwtr72zmu*****",
    "StartTime" : "2022-07-11T12:00:00Z",
    "EndTime" : "2022-07-11T14:00:00Z",
    "ReportId" : "dr-uf6i0tv2refv8wz*****",
    "Status" : "Finished",
    "CreationTime" : "2022-07-11T12:00:00Z",
    "FinishedTime" : "2022-07-11T14:00:00Z",
    "Severity" : "Normal",
    "Issues" : [ {
      "MetricId" : "GuestOS.WinFirewall",
      "MetricCategory" : "CPU",
      "IssueId" : "GuestOS.CPU.HighUtiliz*****",
      "Severity" : "Info"
    } ]
  } ]
}

Error codes

For a list of error codes, see Service error codes.