All Products
Search
Document Center

Elastic High Performance Computing:GetAccountingReport

Last Updated:Mar 03, 2024

Queries the resource report information of a specified cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ehpc:GetAccountingReportREAD
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The ID of the cluster.

ehpc-hz-FYUr32****
StartTimeintegerYes

The beginning of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

1576922873
EndTimeintegerYes

The end of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

1577441873
ReportTypestringYes

The query type. Valid values:

  • total_report: Queries the number of CPU cores in different dimensions.
  • job_report: Collects the historical node data of a node.
  • number_report: Queries job information in different dimensions.
job_report
FilterValuestringNo

The actual name of the dimension to be queried. Valid values:

  • If you set the value of the parameter Dim to user, the value of FilterValue is the name of the specified user.
  • If you set the value of the parameter Dim to queue, the value of FilterValue is the name of the specified queue.
  • If you set the value of the parameter Dim to instance, the value of FilterValue is the instance name.
userNo1
DimstringNo

The layers at which you want to query the bandwidth and traffic data. Valid values:

  • user: Query by user.
  • queue: Query by queue.
  • instance: Query by instance.
user
JobIdstringNo

The ID of the job.

[{Id: 1.scheduler}]
PageSizeintegerNo

The page number of the returned page.

Pages start from page 1.

Default value: 1.

1
PageNumberintegerNo

The number of entries to return on each page. Valid values: 1 to 50.

Default value: 10.

10

Response parameters

ParameterTypeDescriptionExample
object
TotalCoreTimeinteger

The total number of CPU cores in the queried cluster.

261300
Metricsstring

The list serialized in the JSON format. The list contains the column names of each record in the Data.

[\"user\",\"coreTime\",\"usedMem\"]
RequestIdstring

The ID of the request.

B1DCB399-9333-4B38-A35A-0BDFABC71881
PageSizeinteger

The number of entries returned per page.

10
PageNumberinteger

The page number of the returned page.

1
TotalCountinteger

The total number of entries.

10
Dataarray

The list serialized in the JSON format. The list contains multiple records.

string
[[\"userNo1\",49856,7062192],[\"userNo2\",29904,4317280]]

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400InvalidParamsThe specified parameter %s is invalid.The specified parameter %s is invalid.
400NotEnabledYou have not enabled this serviceYou have not enabled this service
400InDebtYour account has overdue payments.Your account has overdue payments.
400Cluster.NotSupportedCurrent cluster does not support this operation.-
403InvalidClusterStatusThe operation failed due to invalid cluster status.The cluster status does not support the operation.
404ClusterNotFoundThe specified cluster does not exist.The specified instance does not exist.
404ObjectNotFoundThe specified object is not found.The specified object does not exist. Please verify the parameter.
404ComputeNotFoundThe specified compute node does not exist.The specified compute node does not exist.
406SlsErrorSLS API request failed.Failed to request the SLS interface.
406AgentErrorThe agent service request failed.-
406ExecFailFailed to execute the command: %s.Failed to execute the command: %s.
406AliyunErrorAn Alibaba Cloud product error occurred.An Alibaba Cloud product error occurred.
407NotAuthorizedYou are not authorized by RAM for this request.The request is not authorized by RAM.
500UnknownErrorAn unknown error occurred.An unknown error occurred.
503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.