DescribeDiagnoseReport-阿里云帮助中心

Query a diagnostic report

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
DiagnoseType	string	No	The type of diagnosis. Valid values: `Performance`: A performance diagnosis.	Performance
ResourceIds	array	No	The resource IDs.	d-asb1s8***
	string	No	The resource ID.	d-bp14d1obw9qijunh8div
ReportIds	array	No	The diagnostic report IDs.	report-asb1s8***
	string	No	The diagnostic report ID.	report-da21a****
StartTime	string	No	The start time for the resource diagnosis. The time must be in ISO 8601 format and in UTC. The format is `yyyy-MM-ddTHH:mm:ssZ`.	2024-08-26T01:00:00Z
EndTime	string	No	The end time for the resource diagnosis. The time must be in ISO 8601 format and in UTC. The format is `yyyy-MM-ddTHH:mm:ssZ`.	2024-08-26T02:06:00Z
Status	string	No	The diagnostic report status. Valid values: Running Success TimeOut Fail	Running
RegionId	string	No	The region ID. You can call DescribeRegions to query the regions supported by EBS DataLens.	cn-zhangjiakou
ClientToken	string	No	A client-generated token that you can use to ensure the idempotency of the request. The token must be unique across requests.	123e4567-e89b-12d3-a456-42665544****
MaxResults	integer	No	The maximum number of entries to return on a single page. Valid values: 1 to 30. Default value: 10.	10
NextToken	string	No	The token returned from a previous query to retrieve the next page of results. If you do not specify this parameter, the query starts 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	A pagination token. Use it to retrieve the next page of results.	f07b150eadfa1d7a
Reports	array<object>	A list of diagnostic reports.
	array<object>	A diagnostic report.
Status	string	The status of the diagnostic report. Valid values: Running Success TimeOut Fail The `Severity` and `Events` fields are returned only when `Status` is `Success`.	Success
ReportId	string	The ID of the diagnostic report.	report-sag8d****
ResourceType	string	The resource type. The only valid value is: Disk	Disk
Severity	string	The severity of the diagnostic report. 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
FinishedTime	integer	The Unix timestamp in seconds for when the diagnostic report was completed.	1727239295
DiagnoseStartTime	integer	The Unix timestamp in seconds for when the resource diagnosis started.	1727229294
ResourceId	string	The resource ID.	d-wz95ycu****
Events	array<object>	A list of diagnosed issues.
	object	The details of a diagnosed issue.
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 Unix timestamp in seconds for when the resource diagnosis ended.	1727239294
CreationTime	integer	The Unix timestamp in seconds for when the diagnostic report was created.	1727239294
RegionId	string	The region ID.	cn-zhangjiakou
DiagnoseType	string	The diagnosis type.	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.