Use ListReports to query historical reports - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries the historical report list for a specified application using a centralized role.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The pagination token. Set this parameter to the value of NextToken returned in the previous API call.	a6792e832ff0XXXXX
MaxResults	integer	No	The maximum number of entries to return when using token-based pagination.	10
PageSize	integer	No	The number of entries per page set in Settings for a paged query during paging.	100
PageNumber	integer	No	The page number in paged queries.	1
RegionId	string	No	The region ID. You can call DescribeRegions to query the regions supported by EBS Lens.	cn-hangzhou
AppId	string	No	The application ID.	app-xxx

Response elements

Element	Type	Description	Example
	object	DescribeAppHistoryReportsResponse
HistoryReports	array<object>	historyReports
	object
AppName	string	The application name.	default
ReportId	string	The report ID.	report-e19c7b597f5fXX
ReportTime	string	The time when the report was generated (UTC).	2024-10-07T02:09:17Z
SubscribePeriod	string	The subscription period of the report.	Weekly
ReportName	string	The report name.	default-2024-09-30~2024-10-07-Usage Report
NextToken	string	The pagination token. Set this parameter to the value of NextToken returned in the previous API call.	a6792e832ff0XXXX
PageNumber	integer	The page number in paged queries.	1
PageSize	integer	The number of entries per page in paged queries.	10
TotalCount	integer	The total number of entries.	1
RequestId	string	The request ID generated by Alibaba Cloud for this request.	C123F94F-4E38-19AE-942A-A8D6F44F****

Examples

Success response

JSON format

{
  "HistoryReports": [
    {
      "AppName": "default",
      "ReportId": "report-e19c7b597f5fXX",
      "ReportTime": "2024-10-07T02:09:17Z",
      "SubscribePeriod": "Weekly",
      "ReportName": "default-2024-09-30~2024-10-07-Usage Report"
    }
  ],
  "NextToken": "a6792e832ff0XXXX",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "RequestId": "C123F94F-4E38-19AE-942A-A8D6F44F****"
}

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.