GetScheduledReports-阿里云帮助中心

Retrieves the inspection reports for a specified scheduled task, allowing you to filter by time range and paginate the results.

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

rdsai:GetScheduledReports

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ScheduledId	string	Yes	The scheduled inspection ID.	847268a4-196f-416b-aa12-bfe0c115****
StartTime	string	No	Specifies the start of the time range to query. The time must be in UTC and formatted as `YYYY-MM-DDTHH:mm:ssZ`. If omitted, the results are not filtered by start time.	2026-01-25T01:02:00Z
EndTime	string	No	Specifies the end of the time range to query. The time must be in UTC and formatted as `YYYY-MM-DDTHH:mm:ssZ`. If omitted, the results are not filtered by end time.	2026-01-25T02:02:00Z
PageNumber	integer	No	Specifies the page number of the results to return. Default: 1.	1
PageSize	integer	No	Specifies the number of entries to return on each page. Default: 20. Maximum: 100.	10

Response elements

Element	Type	Description	Example
	object	The response object.
Success	boolean	Indicates whether the request succeeded.	true
Message	string	The response message.	获取巡检报告列表成功
Reports	array<object>	A list of inspection reports.
	object
TaskId	string	The inspection report ID.	65f0053b-f933-49f5-bf65-4e4593e1****
StartTime	string	The time when the inspection started. The time is in UTC and formatted as `YYYY-MM-DDTHH:mm:ssZ`.	2025-01-01T00:00:00Z
EndTime	string	The time when the inspection ended. The time is in UTC and formatted as `YYYY-MM-DDTHH:mm:ssZ`.	2025-01-01T23:59:59Z
Status	string	The status of the inspection report.	success
CreatedTime	string	The time when the report was created. The time is in UTC and formatted as `YYYY-MM-DDTHH:mm:ssZ`.	2025-01-01T22:59:59Z
ReportLanguage	string
ReportType	string
RegionId	string
InspectionItems	string
TotalCount	integer	The total number of records.	20
PageNumber	integer	The page number of the returned results. The default value is 1.	1
PageSize	integer	The number of records per page.	10
RequestId	string	The request ID.	FE9C65D7-930F-57A5-A207-8C396329****

Examples

Success response

JSON format

{
  "Success": true,
  "Message": "获取巡检报告列表成功",
  "Reports": [
    {
      "TaskId": "65f0053b-f933-49f5-bf65-4e4593e1****",
      "StartTime": "2025-01-01T00:00:00Z",
      "EndTime": "2025-01-01T23:59:59Z",
      "Status": "success",
      "CreatedTime": "2025-01-01T22:59:59Z",
      "ReportLanguage": "",
      "ReportType": "",
      "RegionId": "",
      "InspectionItems": ""
    }
  ],
  "TotalCount": 20,
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "FE9C65D7-930F-57A5-A207-8C396329****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Request parameter validation failed.	Request parameter verification failed
500	InternalError	System internal exception.	System internal exception
403	PermissionDenied	User has no operation permission.	User has no operation permission
403	InvalidUserOrder	There is no valid order for this UID.	There is no valid order for this UID
404	TaskNotFound	The resource of the specified ld does not exist.	The resource of the specified ld does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.