All Products
Search
Document Center

Elastic Compute Service:DescribeDiagnosticReportAttributes

Last Updated:Sep 29, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:DescribeDiagnosticReportAttributesget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the diagnostic report. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ReportIdstringYes

The ID of the diagnostic report.

dr-i-uf6i0tv2refv8wz*****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
ResourceIdstring

The resource ID.

i-uf6i0tv2refv8wz*****
ResourceTypestring

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

instance
ReportIdstring

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

dr-uf6i0tv2refv8wz*****
Statusstring

The state of the diagnostic report. Valid values:

  • InProgress: The diagnostic is in progress.
  • Finished: The diagnostic is complete.
  • Failed: The diagnostic failed.
Finished
CreationTimestring

The time when the diagnostic report was created.

2022-07-11T12:00:00Z
FinishedTimestring

The time when the diagnostic report was complete.

2022-07-11T14:00:00Z
StartTimestring

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.

2022-07-11T12:00:00Z
EndTimestring

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.

2022-07-11T14:00:00Z
Severitystring

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 potential exceptions.
  • Critical: Critical exceptions were detected.
Normal
MetricSetIdstring

The ID of the diagnostic metric set.

dms-bp17p0qwtr72zmu*****
MetricResultsarray<object>

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

MetricResultobject
MetricIdstring

The ID of the diagnostic metric.

GuestOS.WinFirewall
MetricCategorystring

The category of the diagnostic metric.

CPU
Severitystring

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 potential exceptions.
  • Critical: Critical exceptions were detected.
Normal
Statusstring

The state of the diagnostic metric. Valid values:

  • InProgress.
  • Finished.
  • Failed.
Finished
Issuesarray<object>

The diagnosed issues.

Issueobject

The diagnosed issue.

IssueIdstring

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

GuestOS.CPU.HighUtiliz*****
Severitystring

The severity level of the diagnosed issue. Valid values:

  • Info: Diagnostic information was recorded and may be related to exceptions.
  • Warn: Diagnostic information was recorded and may indicate potential exceptions.
  • Critical: Critical exceptions were detected.
Info
Additionalstring

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

{ "TotalPercent": 95, "TopUtilizationProcesses": [ { "Pid": "1223", "CommandName": "/usr/bin/mem.py", "PhysicalMemoryPercent": 50 } ] }
OccurrenceTimestring

The time when the diagnosed issue occurred.

2022-07-11T14:00:00Z
Attributesstring

The extended attributes of the diagnostic report.

{ "OfflineDiagReportStatus":"CONFIRMED" }

Examples

Sample success responses

JSONformat

{
  "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": {
    "MetricResult": [
      {
        "MetricId": "GuestOS.WinFirewall",
        "MetricCategory": "CPU",
        "Severity": "Normal",
        "Status": "Finished",
        "Issues": {
          "Issue": [
            {
              "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": "{\n    \"OfflineDiagReportStatus\":\"CONFIRMED\"\n}"
}

Error codes

HTTP status codeError codeError message
403InvalidParameter.ReportNotExistThe specified report does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history