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

Queries the details of a resource diagnostic report by calling DescribeDiagnosticReportAttributes.

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 region ID. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
ReportId	string	Yes	The ID of the diagnostic report.	dr-i-uf6i0tv2refv8wz*****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****
ResourceId	string	The resource ID.	i-uf6i0tv2refv8wz*****
ResourceType	string	The resource type. The supported type is instance.	instance
ReportId	string	The ID of the diagnostic report. This is the unique identifier of the resource diagnostic report.	dr-uf6i0tv2refv8wz*****
Status	string	The status of the diagnostic report. Valid 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. The time is in ISO 8601 format in UTC.	2022-07-11T12:00:00Z
FinishedTime	string	The time when the diagnostic report was completed. The time is in ISO 8601 format in UTC.	2022-07-11T14:00:00Z
StartTime	string	The start time. This is the parameter passed in when you called the CreateDiagnosticReport operation to create the diagnostic report. The time is in ISO 8601 format in UTC.	2022-07-11T12:00:00Z
EndTime	string	The end time. This is the parameter passed in when you called the CreateDiagnosticReport operation to create the diagnostic report. The time is in ISO 8601 format in UTC.	2022-07-11T14:00:00Z
Severity	string	The severity level of the report. This is the most severe level among all metrics. The severity levels in ascending order are: Unknown: The initial state. The diagnosis has not started, or the diagnostic process exited abnormally. No diagnostic conclusion is available. Normal: The diagnosis is normal. No issues were found. Info: Related information is available and may be associated with an exception. Warn: Related information is available and may cause an exception. Critical: A critical exception exists.	Normal
MetricSetId	string	The ID of the diagnostic metric set.	dms-bp17p0qwtr72zmu*****
MetricResults	object
MetricResult	array<object>	The diagnostic results of all metrics in the diagnostic set.
	array<object>
MetricId	string	The ID of the diagnostic metric.	GuestOS.WinFirewall
MetricCategory	string	The category of the diagnostic metric.	CPU
Severity	string	The severity level of the diagnostic metric. Valid values: Unknown: The initial state. The diagnosis has not started, or the diagnostic process exited abnormally. No diagnostic conclusion is available. Normal: The diagnosis is normal. No issues were found. Info: Related information is available and may be associated with an exception. NotSupport: The guest OS version does not support diagnosing this item. Warn: Related information is available and may cause an exception. Critical: A critical exception exists.	Normal
Status	string	The diagnostic status of the metric. Valid values: InProgress: The diagnosis is in progress. Finished: The diagnosis is complete. Failed: The diagnosis failed.	Finished
Issues	object
Issue	array<object>	The list of diagnostic issues.
	object	The list of diagnostic issues.
IssueId	string	The unique identifier of the diagnostic issue.	GuestOS.CPU.HighUtiliz*****
Severity	string	The severity level of the diagnostic issue. The severity levels in ascending order are: Info: Related information is available and may be associated with an exception. Warn: Related information is available and may cause an exception. Critical: A critical exception exists.	Info
Additional	string	The additional data associated with the diagnostic issue. This data helps you understand more information about the issue. The data is in JSON string format.	{ "TotalPercent": 95, "TopUtilizationProcesses": [ { "Pid": "1223", "CommandName": "/usr/bin/mem.py", "PhysicalMemoryPercent": 50 } ] }
OccurrenceTime	string	The time when the issue occurred. The time is in ISO 8601 format in UTC.	2022-07-11T14:00:00Z
RepairStatus	string	The repair status. This field has a value after a repair operation is performed. Valid values: InProgress: The repair is in progress. Failed: The repair failed. Finished: The repair is complete.
Repairable	boolean	Indicates whether the issue can be automatically repaired. Valid values: false (not repairable) and true (repairable).
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.