Query diagnostic report details with DescribeDiagnosticReportAttributes - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Call DescribeDiagnosticReportAttributes to get the details of a resource diagnosis.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeDiagnosticReportAttributes

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region. Call DescribeRegions to get the latest list of Alibaba Cloud regions.	cn-hangzhou
ReportId	string	Yes	The ID of the diagnostic report.	dr-i-uf6i0tv2refv8wz*****

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
ResourceId	string	The resource ID.	i-uf6i0tv2refv8wz*****
ResourceType	string	The resource type. Only `instance` is supported.	instance
ReportId	string	The unique ID of the diagnostic report.	dr-uf6i0tv2refv8wz*****
Status	string	The status of the diagnostic report. Possible values: InProgress: The diagnosis is in progress. Finished: The diagnosis is complete. Failed: The diagnosis failed.	Finished
CreationTime	string	The time when the diagnostic report was created.	2022-07-11T12:00:00Z
FinishedTime	string	The time when the diagnosis was complete.	2022-07-11T14:00:00Z
StartTime	string	The start of the diagnostic time range. This value corresponds to the `StartTime` parameter you provided when calling the CreateDiagnosticReport operation.	2022-07-11T12:00:00Z
EndTime	string	The end of the diagnostic time range. This value corresponds to the `EndTime` parameter you provided when calling the CreateDiagnosticReport operation.	2022-07-11T14:00:00Z
Severity	string	The overall severity level of the diagnostic report. This is the highest severity level among all metrics in the report. Valid values are listed below, from lowest to highest severity: Unknown: The initial state. The diagnosis has not started or exited unexpectedly, so the result is inconclusive. Normal: The resource is healthy, and no issues were found. Info: Informational messages were found that may be relevant to an issue. Warn: Warnings were found that may lead to an issue. Critical: Critical issues were found.	Normal
MetricSetId	string	The metric set ID.	dms-bp17p0qwtr72zmu*****
MetricResults	object
MetricResult	array<object>	A list of the diagnostic results for all metrics in the metric set.
	array<object>
MetricId	string	The metric ID.	GuestOS.WinFirewall
MetricCategory	string	The metric category.	CPU
Severity	string	The severity level of the metric. The valid values are: Unknown: The initial state. The diagnosis has not started or exited unexpectedly, so the result is inconclusive. Normal: The metric is normal, and no issues were found. Info: Informational messages were found that may be relevant to an issue. NotSupport: The guest OS version does not support this diagnostic metric. Warn: Warnings were found that may lead to an issue. Critical: Critical issues were found.	Normal
Status	string	The diagnostic status of the metric. The valid values are: InProgress: The diagnosis is in progress. Finished: The diagnosis is complete. Failed: The diagnosis failed.	Finished
Issues	object
Issue	array<object>	The list of issues.
	object	A diagnosed issue.
IssueId	string	The unique ID of the issue.	GuestOS.CPU.HighUtiliz*****
Severity	string	The severity level of the issue. The following values are listed in ascending order of severity: Info: Informational messages were found that may be relevant to an issue. Warn: Warnings were found that may lead to an issue. Critical: Critical issues were found.	Info
Additional	string	Additional information about the issue. The value is a JSON-formatted string.	{ "TotalPercent": 95, "TopUtilizationProcesses": [ { "Pid": "1223", "CommandName": "/usr/bin/mem.py", "PhysicalMemoryPercent": 50 } ] }
OccurrenceTime	string	The time when the issue occurred.	2022-07-11T14:00:00Z
RepairStatus	string
Repairable	boolean
Attributes	string	The extended attributes of the diagnostic report.	{"OfflineDiagReportStatus":"CONFIRMED"}

Examples

Success response

JSON format

{
  "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",
              "RepairStatus": "",
              "Repairable": false
            }
          ]
        }
      }
    ]
  },
  "Attributes": "{\"OfflineDiagReportStatus\":\"CONFIRMED\"}"
}

Error codes

HTTP status code	Error code	Error message	Description
403	InvalidParameter.ReportNotExist	The specified report does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.