Queries the details of a diagnostic report.

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 DescribeDiagnosticReportAttributes

The operation that you want to perform. Set the value to DescribeDiagnosticReportAttributes.

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.

ReportId String Yes dr-i-uf6i0tv2refv8wz*****

The ID of the diagnostic report.

Response parameters

Parameter Type Example Description
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

The ID of the region.

ResourceId String i-uf6i0tv2refv8wz*****

The ID of the resource.

ResourceType String instance

The type of the resource. The ResourceType parameter can be set only to instance, which indicates that only instances are supported.

ReportId String dr-uf6i0tv2refv8wz*****

The ID of the diagnostic report, which is the unique identifier of the report.

Status String Finished

The state of the diagnostic report. Valid values:

  • InProgress: The diagnostic is in progress.
  • Finished: The diagnostic is complete.
  • Failed: The diagnostic failed.
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 report was complete.

StartTime String 2022-07-11T12:00:00Z

The beginning of the reporting period. 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. The value is the EndTime value that was passed in when you called the CreateDiagnosticReport operation to create the diagnostic report.

Severity String Normal

The severity level of the diagnostic report. The value of this parameter is determined by the highest severity level of all diagnostic metrics. Valid values:

  • Unknown: The diagnostic has not started, failed to run, or exited unexpectedly without a diagnosis.
  • Normal: No exceptions were detected.
  • Info: Diagnostic information was recorded and may be related to exceptions.
  • Warn: Diagnostic information was recorded and may indicate exceptions.
  • Critical: Critical exceptions were detected.
MetricSetId String dms-bp17p0qwtr72zmu*****

The ID of the diagnostic metric set.

MetricResults Array of MetricResult

The results of all diagnostic metrics in the diagnostic metric set.

MetricResult
MetricId String GuestOS.WinFirewall

The ID of the diagnostic metric.

MetricCategory String CPU

The category of the diagnostic metric.

Severity String Normal

The severity level of the diagnostic metric. Valid values:

  • Unknown: The diagnostic has not started, failed to run, or exited unexpectedly without a diagnosis.
  • Normal: No exceptions were detected.
  • Info: Diagnostic information was recorded and may be related to exceptions.
  • NotSupport: The version of the guest operating system does support diagnosing the metric.
  • Warn: Diagnostic information was recorded and may indicate exceptions.
  • Critical: Critical exceptions were detected.
Status String Finished

The state of the diagnostic metric. Valid values:

  • InProgress: The diagnostic is in progress.
  • Finished: The diagnostic is complete.
  • Failed: The diagnostic failed.
Issues Array of Issue

Details about the diagnosed issue.

Issue
IssueId String GuestOS.CPU.HighUtiliz*****

The ID of the diagnosed issue, which is the unique identifier of the issue.

Severity String Info

Valid values:

  • Info: Diagnostic information was recorded and may be related to exceptions.
  • Warn: Diagnostic information was recorded and may indicate exceptions.
  • Critical: Critical exceptions were detected.
Additional String { "TotalPercent": 95, "TopUtilizationProcesses": [ { "Pid": "1223", "CommandName": "/usr/bin/mem.py", "PhysicalMemoryPercent": 50 } ] }

Additional data about the diagnosed issue. The value is a JSON string.

OccurrenceTime String 2022-07-11T14:00:00Z

The time when the diagnosed issue occurred.

Attributes String {"OfflineDiagReportStatus":"CONFIRMED"}

The extended attributes of the diagnostic report.

Examples

Sample requests

http(s)://ecs.aliyuncs.com/?Action=DescribeDiagnosticReportAttributes
&RegionId=cn-hangzhou
&ReportId=dr-i-uf6i0tv2refv8wz*****
&<Common request parameters>

Sample success responses

XML format

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

<DescribeDiagnosticReportAttributesResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3****</RequestId>
    <ResourceId>i-uf6i0tv2refv8wz*****</ResourceId>
    <ResourceType>instance</ResourceType>
    <ReportId>dr-uf6i0tv2refv8wz*****</ReportId>
    <Status>Finished</Status>
    <CreationTime>2022-07-11T12:00:00Z</CreationTime>
    <FinishedTime>2022-07-11T14:00:00Z</FinishedTime>
    <StartTime>2022-07-11T12:00:00Z</StartTime>
    <EndTime>2022-07-11T14:00:00Z</EndTime>
    <Severity>Normal</Severity>
    <MetricSetId>dms-bp17p0qwtr72zmu*****</MetricSetId>
    <MetricResults>
        <MetricId>GuestOS.WinFirewall</MetricId>
        <MetricCategory>CPU</MetricCategory>
        <Severity>Normal</Severity>
        <Status>Finished</Status>
        <Issues>
            <IssueId>GuestOS.CPU.HighUtiliz*****</IssueId>
            <Severity>Info</Severity>
            <Additional>{
  "TotalPercent": 95,
  "TopUtilizationProcesses": [
    {
      "Pid": "1223",
      "CommandName": "/usr/bin/mem.py",
      "PhysicalMemoryPercent": 50
    }
  ]
}</Additional>
            <OccurrenceTime>2022-07-11T14:00:00Z</OccurrenceTime>
        </Issues>
    </MetricResults>
    <Attributes>{"OfflineDiagReportStatus":"CONFIRMED"}</Attributes>
</DescribeDiagnosticReportAttributesResponse>

JSON format

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

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****",
  "ResourceId" : "i-uf6i0tv2refv8wz*****",
  "ResourceType" : "instance",
  "ReportId" : "dr-uf6i0tv2refv8wz*****",
  "Status" : "Finished",
  "CreationTime" : "2022-07-11T12:00:00Z",
  "FinishedTime" : "2022-07-11T14:00:00Z",
  "StartTime" : "2022-07-11T12:00:00Z",
  "EndTime" : "2022-07-11T14:00:00Z",
  "Severity" : "Normal",
  "MetricSetId" : "dms-bp17p0qwtr72zmu*****",
  "MetricResults" : [ {
    "MetricId" : "GuestOS.WinFirewall",
    "MetricCategory" : "CPU",
    "Severity" : "Normal",
    "Status" : "Finished",
    "Issues" : [ {
      "IssueId" : "GuestOS.CPU.HighUtiliz*****",
      "Severity" : "Info",
      "Additional" : "{\n  \"TotalPercent\": 95,\n  \"TopUtilizationProcesses\": [\n    {\n      \"Pid\": \"1223\",\n      \"CommandName\": \"/usr/bin/mem.py\",\n      \"PhysicalMemoryPercent\": 50\n    }\n  ]\n}",
      "OccurrenceTime" : "2022-07-11T14:00:00Z"
    } ]
  } ],
  "Attributes" : "{\"OfflineDiagReportStatus\":\"CONFIRMED\"}"
}

Error codes

For a list of error codes, visit the API Error Center.