Use DescribeDiagnosticReports to query resource diagnostic reports - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries a list of resource diagnostic reports.

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:DescribeDiagnosticReports

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
ReportIds	array	No	The list of diagnostic report IDs.
	string	No	The list of diagnostic report IDs. A maximum of 100 IDs are supported.	dr-uf6i0tv2refv8wz*****
ResourceIds	array	No	The list of resource IDs. A maximum of 100 IDs are supported.
	string	No	The resource ID.	i-uf6i0tv2refv8wz*****
Status	string	No	The report status. Valid values: InProgress: The diagnostic is in progress. Failed: The diagnostic failed. Finished: The diagnostic is complete. Valid values: Finished : The diagnostic is complete. Failed : The diagnostic failed. InProgress : The diagnostic is in progress.	Finished
Severity	string	No	The severity level. Valid values: Unknown: The initial state, which indicates that the diagnostic has not started or the diagnostic process exited abnormally. No diagnostic conclusion is available. Normal: The diagnostic is normal. No issues are 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. Valid values: Unknown : Initial state (no diagnostic conclusion) Critical : Critical exception. Info : Related information. Normal : Normal. Warn : Related information that may cause an exception.	Normal
NextToken	string	No	The pagination token. Set this parameter to the NextToken value returned in the previous call. You do not need to set this parameter for the first request.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	The number of entries per page for a paged query. Maximum value: 100. Default value: If this parameter is not specified, the default value is 10. If the specified value is greater than 100, the default value is 100.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE*****
NextToken	string	The pagination token returned in this call.	caeba0bbb2be03f84eb48b699f0a4883
Reports	object
Report	array<object>	The list of diagnostic reports.
	array<object>
ResourceId	string	The resource ID.	i-uf6i0tv2refv8wz*****
ResourceType	string	The resource type.	instance
MetricSetId	string	The diagnostic metric set ID.	dms-bp17p0qwtr72zmu*****
StartTime	string	The start time. This parameter is passed in when you call the CreateDiagnosticReport operation to create a diagnostic report. The time is in ISO 8601 format in UTC.	2022-07-11T12:00:00Z
EndTime	string	The end time. This parameter is passed in when you call the CreateDiagnosticReport operation to create a diagnostic report. The time is in ISO 8601 format in UTC.	2022-07-11T14:00:00Z
ReportId	string	The diagnostic report ID.	dr-uf6i0tv2refv8wz*****
Status	string	The diagnostic report status.	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
Severity	string	The severity level. Valid values: Unknown: The initial state, which indicates that the diagnostic has not started or the diagnostic process exited abnormally. No diagnostic conclusion is available. Normal: The diagnostic is normal. No issues are 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
Issues	object
Issue	array<object>	The list of diagnostic issues.
	object
MetricId	string	The diagnostic metric ID.	GuestOS.WinFirewall
MetricCategory	string	The diagnostic metric category.	ECSService.GuestOS
IssueId	string	The unique identifier of the diagnostic issue.	GuestOS.CPU.HighUtiliz*****
Severity	string	The severity level of the diagnostic metric. 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

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE*****",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "Reports": {
    "Report": [
      {
        "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": {
          "Issue": [
            {
              "MetricId": "GuestOS.WinFirewall",
              "MetricCategory": "ECSService.GuestOS",
              "IssueId": "GuestOS.CPU.HighUtiliz*****",
              "Severity": "Info"
            }
          ]
        }
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.