DescribeDiagnoseReport - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries 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

ebs:DescribeDiagnoseReport

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DiagnoseType	string	No	The type of diagnosis. Valid values: Performance: performance diagnostics	Performance
ResourceIds	array	No	The resource ID.	d-asb1s8***
	string	No	The list of resource IDs.	d-bp14d1obw9qijunh8div
ReportIds	array	No	The diagnostic report ID.	report-asb1s8***
	string	No	The list of diagnostic reports.	report-da21a****
StartTime	string	No	The start time of the resource diagnosis. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2024-08-26T01:00:00Z
EndTime	string	No	The end time of the resource diagnosis. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2024-08-26T02:06:00Z
Status	string	No	The status of the diagnostic report. Valid values: Running Success TimeOut Fail	Running
RegionId	string	No	The region ID. You can call DescribeRegions to query the regions supported by EBS Lens.	cn-zhangjiakou
ClientToken	string	No	A string generated by the server that serves as a client request identifier.	123e4567-e89b-12d3-a456-42665544****
MaxResults	integer	No	The maximum number of entries per page for a paged query. Valid values: 1 to 30. Default value: 10.	10
NextToken	string	No	The pagination token that marks the position from which to start reading. An empty value indicates reading from the beginning.	adf8a2534f1c0a23e0b5e8707e68181f

Response elements

Element	Type	Description	Example
	object	DescribeDiagnoseReportResponse
RequestId	string	The request ID.	AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****
TotalCount	integer	The total number of entries returned.	10
NextToken	string	The pagination token returned in this call.	f07b150eadfa1d7a
Reports	array<object>	The list of diagnostic reports.
	array<object>	The list of diagnostic reports.
Status	string	The status of the diagnostic report. Valid values: Running Success TimeOut Fail The Severity and Events fields are valid only when Status is set to Success.	Success
ReportId	string	The diagnostic report ID.	report-sag8d****
ResourceType	string	The resource type. Valid values: Disk	Disk
Severity	string	The severity level of the diagnosis. The severity levels in ascending order are: Info: Associated information that may be related to an anomaly. Warn: Associated information that may cause an anomaly. Critical: A critical anomaly exists.	Warn
FinishedTime	integer	The time when the diagnostic report was completed, in Unix/POSIX timestamp (seconds).	1727239295
DiagnoseStartTime	integer	The start timestamp of the resource diagnosis.	1727229294
ResourceId	string	The resource ID.	d-wz95ycu****
Events	array<object>	The list of diagnosed issues.
	object	The list of diagnosed issues.
RecommendParams	string	The parameters for the recommended action.	4096
Description	string	The event description.	test
RecommendAction	string	The recommended action for the event. Valid values: `ModifyDiskSpec`: Modify the disk specification. `CreateSnapshot`: Create a snapshot. `ResizeDisk`: Resize the disk. `AdjustProvision`: Adjust the provisioned performance settings. `ModifyInstanceSpec`: Modify the instance specification.	ResizeDisk
StartTime	integer	The Unix timestamp in milliseconds for when the event started.	1755756214000
Severity	string	The severity of the diagnosed issue. Valid values are listed in ascending order of severity: `Info`: Provides information that may be related to an issue. `Warn`: Indicates a condition that may cause an issue. `Critical`: Indicates a critical issue was detected.	Warn
EventName	string	The name of the issue. Valid values: `NoSnapshot`: Indicates a lack of recent snapshots for data protection. `BurstIOTriggered`: Indicates that burst I/O has been triggered. `CostOptimizationNeeded`: Indicates that cost optimization is possible. `DiskSpecNotMatchedWithInstance`: The disk specification does not match the instance type. `DiskIONo4kAligned`: Disk I/O is not 4K-aligned. `DiskIOHang`: An I/O hang has occurred on the disk. `InstanceIOPSExceedInstanceMaxLimit`: The instance IOPS has exceeded its maximum limit. `InstanceBPSExceedInstanceMaxLimit`: The instance BPS has exceeded its maximum limit. `DiskIOPSExceedInstanceMaxLimit`: The disk IOPS has exceeded the instance's maximum limit. `DiskBPSExceedInstanceMaxLimit`: The disk BPS has exceeded the instance's maximum limit. `DiskIOPSExceedDiskMaxLimit`: The disk IOPS has exceeded its own maximum limit. `DiskBPSExceedDiskMaxLimit`: The disk BPS has exceeded its own maximum limit.	DiskIOPSExceedDiskMaxLimit
DiagnoseEndTime	integer	The end timestamp of the resource diagnosis.	1727239294
CreationTime	integer	The time when the diagnostic report was created, in Unix/POSIX timestamp (seconds).	1727239294
RegionId	string	The region ID.	cn-zhangjiakou
DiagnoseType	string	The type of diagnosis.	Performance
AliUid	integer	The user ID.	196380451****

Examples

Success response

JSON format

{
  "RequestId": "AAA478A0-BEE6-1D42-BEB6-A9CFEAD6****\n",
  "TotalCount": 10,
  "NextToken": "f07b150eadfa1d7a",
  "Reports": [
    {
      "Status": "Success",
      "ReportId": "report-sag8d****",
      "ResourceType": "Disk",
      "Severity": "Warn",
      "FinishedTime": 1727239295,
      "DiagnoseStartTime": 1727229294,
      "ResourceId": "d-wz95ycu****",
      "Events": [
        {
          "RecommendParams": "4096",
          "Description": "test",
          "RecommendAction": "ResizeDisk",
          "StartTime": 1755756214000,
          "Severity": "Warn",
          "EventName": "DiskIOPSExceedDiskMaxLimit"
        }
      ],
      "DiagnoseEndTime": 1727239294,
      "CreationTime": 1727239294,
      "RegionId": "cn-zhangjiakou",
      "DiagnoseType": "Performance",
      "AliUid": 0
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The parameter %s is invalid.	The specified parameter value is invalid.
400	InvalidParameter.Conflict	The specified parameter %s and %s are not blank at the same time.
400	InvalidParameter.Format	Specified parameter format is not valid.	english description
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	The parameter must be specified.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
403	Forbidden	User is not authorized to operate.	You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403	Forbidden.Action	User is not authorized to operate this action.	You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
403	LastTokenProcessing	The last token request is processing.	The value of clientToken is used in another request that is being processed. Try again later.
403	NoPermission.SLR	The RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.	You are not authorized to create service-linked roles.
403	OperationDenied	The operation is not allowed.	The operation is not supported.
404	InvalidApi.NotFound	Specified api is not found, please check your url and method.
404	NoSuchResource	The specified resource does not exist.	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.
429	BLOCK.LimitedRequest	Request was denied due to user flow control.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.