GetScheduledReports-阿里云帮助中心

Queries all inspection reports for a specified scheduled task, and supports filtering by time range and pagination.

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 ID of the scheduled task.	847268a4-196f-416b-aa12-bfe0c115****
StartTime	string	No	The start time for filtering. Format: YYYY-MM-DDTHH:mm:ssZ. If this parameter is not specified, no filtering is applied.	2026-01-25T01:02:00Z
EndTime	string	No	The end time for filtering. Format: YYYY-MM-DDTHH:mm:ssZ. If this parameter is not specified, no filtering is applied.	2026-01-25T02:02:00Z
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Default value: 20. Maximum value: 100.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
Success	boolean	Indicates whether the request was successful.	true
Message	string	The returned message.	The inspection report list was retrieved successfully
Reports	array<object>	The report details.
	object
TaskId	string	The ID of the inspection report.	65f0053b-f933-49f5-bf65-4e4593e1****
StartTime	string	The start time of the inspection. Format: YYYY-MM-DDTHH:mm:ssZ.	2025-01-01T00:00:00Z
EndTime	string	The end time of the inspection. Format: YYYY-MM-DDTHH:mm:ssZ.	2025-01-01T23:59:59Z
Status	string	The status.	success
CreatedTime	string	The creation time.	2025-01-01T22:59:59Z
ReportLanguage	string
ReportType	string
RegionId	string	The region ID.	cn-beijing
InspectionItems	string
TotalCount	integer	The total number of records.	20
PageNumber	integer	The page number. Default value: 1.	1
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	FE9C65D7-930F-57A5-A207-8C396329****

Examples

Success response

JSON format

{
  "Success": true,
  "Message": "Successfully retrieved the inspection report list",
  "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": "cn-beijing",
      "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	%s.	The request parameter verification failed. For more information, see the return message.
400	InvalidRequest.Format	The request body must be a non-empty JSON object.	The request body must be a non-empty JSON object.
400	InvalidUserIdentity.Missing	The authenticated caller identity is missing.	Missing authenticated caller identity information.
400	MissingParameter	A required inspection parameter is missing.	Required inspection parameters are missing.
400	InvalidTaskParameter.Value	An inspection task identifier is invalid.	An inspection task identifier is invalid.
400	InvalidPagination.Value	PageNumber or PageSize is outside the supported range.	PageNumber or PageSize is outside the supported range.
400	InvalidTimeParameter.Value	An inspection time or frequency parameter is invalid.	The inspection time or execution frequency parameter is invalid.
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.