All Products
Search
Document Center

MaxCompute:GetJobResourceUsage

Last Updated:Oct 24, 2024

Performs statistics on all jobs that are complete on a specified day and obtains the total resource usage of each job executor on a daily basis.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
odps:GetJobResourceUsagelist
  • All Resources
    *
    none
none

Request syntax

GET /api/v1/jobs/resourceUsage HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
datestringYes

The date that is accurate to the day part for the query. The date must be in the yyyy-MM-dd format.

2023-05-15
jobOwnerListarrayNo

The list of job executors.

itemstringNo

The list of job executors.

ALIYUN$xxx@test.aliyunid.com
quotaNicknameListarrayNo

The list of nicknames of quotas that are used by jobs.

itemstringNo

The list of nicknames of quotas that are used by jobs.

my_quota
pageNumberlongNo

The page number.

1
pageSizelongNo

The number of entries per page. Default value: 10. Maximum value: 100.

10

Response parameters

ParameterTypeDescriptionExample
object

PopResult

requestIdstring

The request ID.

0b57ff7616612271051086500ea3ce
httpCodeinteger

Indicates whether the request was successful. If this parameter was not empty and the value of this parameter was not 200, the request failed.

200
errorCodestring

The error code returned if the request failed.

success
errorMsgstring

The error message returned if the request failed.

0A3B1E82006A23A918C70905BF08AEC7
dataobject

The data returned.

jobResourceUsageListarray<object>

The data list returned.

jobResourceUsageListobject
datestring

The start date of the query in the format of yyyy-MM-dd.

2023-05-09
jobOwnerstring

The job executor.

ALIYUN$xxx@test.aliyunid.com
quotaNicknamestring

The quota nickname.

my_quota
cuUsagelong

The total number of used compute units (CUs).

1185100
memoryUsagelong

The total memory usage.

15169536
totalCountlong

The total number of returned entries.

64
pageNumberlong

The page number.

2
pageSizelong

The number of entries per page.

10

Examples

Sample success responses

JSONformat

{
  "requestId": "0b57ff7616612271051086500ea3ce",
  "httpCode": 200,
  "errorCode": "success",
  "errorMsg": "0A3B1E82006A23A918C70905BF08AEC7",
  "data": {
    "jobResourceUsageList": [
      {
        "date": "2023-05-09",
        "jobOwner": "ALIYUN$xxx@test.aliyunid.com",
        "quotaNickname": "my_quota",
        "cuUsage": 1185100,
        "memoryUsage": 15169536
      }
    ],
    "totalCount": 64,
    "pageNumber": 2,
    "pageSize": 10
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-08-26The internal configuration of the API is changed, but the call is not affectedView Change Details