GetAccountingReport - Elastic High Performance Computing

Obtains the resource report for a specified cluster.

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

ehpc:GetAccountingReport

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	ehpc-hz-FYUr32****
StartTime	integer	No	The start time of the query. This is a UNIX timestamp, which is the number of seconds that have elapsed since 00:00:00 UTC on January 1, 1970.	1576922873
EndTime	integer	No	The end time of the query. This is a UNIX timestamp, which is the number of seconds that have elapsed since 00:00:00 UTC on January 1, 1970.	1577441873
ReportType	string	Yes	The type of the report. Valid values: total_report: Queries the number of core-hours by dimension. job_report: Gathers historical data of nodes. number_report: Queries job information by dimension.	job_report
FilterValue	string	No	The name of the dimension to query. Valid values: If Dim is set to user, FilterValue is the name of a specific user. If Dim is set to queue, FilterValue is the name of a specific queue. If Dim is set to instance, FilterValue is the name of the instance.	userNo1
Dim	string	No	The dimension to query. Valid values: user: Queries by user. queue: Queries by queue. instance: Queries by instance.	user
JobId	string	No	The job ID.	[{Id: 1.scheduler}]
PageSize	integer	No	The page number. The value must be greater than or equal to 1. The default value is 1. The minimum value is 1. The default value is 1.	1
PageNumber	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 10.	10

Response elements

Element	Type	Description	Example
	object
TotalCoreTime	integer	The total core-hours of the cluster.	261300
Metrics	string	A JSON-serialized list that contains the column names for each record in Data.	[\"user\",\"coreTime\",\"usedMem\"]
RequestId	string	The request ID.	B1DCB399-9333-4B38-A35A-0BDFABC71881
PageSize	integer	The number of entries returned on the current page.	10
PageNumber	integer	The page number.	1
TotalCount	integer	The total number of entries.	10
Data	object
Data	array	A JSON-serialized list that contains multiple records.
	string	A JSON-serialized list that contains multiple records.	[[\"userNo1\",49856,7062192],[\"userNo2\",29904,4317280]]

Examples

Success response

JSON format

{
  "TotalCoreTime": 261300,
  "Metrics": "[\\\"user\\\",\\\"coreTime\\\",\\\"usedMem\\\"]",
  "RequestId": "B1DCB399-9333-4B38-A35A-0BDFABC71881",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 10,
  "Data": {
    "Data": [
      "[[\\\"userNo1\\\",49856,7062192],[\\\"userNo2\\\",29904,4317280]]"
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
400	NotEnabled	You have not enabled this service	You have not enabled this service
400	InDebt	Your account has overdue payments.	Your account has overdue payments.
400	Cluster.NotSupported	Current cluster does not support this operation.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
403	InvalidClusterStatus	The operation failed due to invalid cluster status.	The cluster status does not support the operation.
404	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
404	ObjectNotFound	The specified object is not found.	The specified object does not exist. Please verify the parameter.
404	ComputeNotFound	The specified compute node does not exist.	The specified compute node does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The request has failed due to a temporary failure of the server.
406	SlsError	SLS API request failed.	Failed to request the SLS interface.
406	AgentError	The agent service request failed.	The cluster-side command failed to run. %s
406	ExecFail	Failed to execute the command: %s.
406	AliyunError	An Alibaba Cloud product error occurred.	Alibaba Cloud product error. %s
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.