GetJobResourceUsage API for querying daily resource usage of jobs - MaxCompute - Alibaba Cloud - MaxCompute

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

odps:GetJobResourceUsage

list

*全部资源

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
date	string	Yes	查询的日期，以天为级别，时间参数填写必须为 yyyy-MM-dd	2023-05-15
jobOwnerList	array	No	作业的执行者列表
	string	No	作业的执行者列表	ALIYUN$xxx@test.aliyunid.com
quotaNicknameList	array	No	作业使用的配额昵称列表
	string	No	作业使用的配额昵称列表	my_quota
pageNumber	integer	No	页码	1
pageSize	integer	No	每页返回数目，默认为 10，最大为 100	10

Response elements

Element	Type	Description	Example
	object	PopResult
requestId	string	请求 id	0b57ff7616612271051086500ea3ce
httpCode	integer	业务成功与否。如果非空且不是 200，那么表示业务处理失败。	200
errorCode	string	错误码	success
errorMsg	string	错误信息	0A3B1E82006A23A918C70905BF08AEC7
data	object	返回数据。
jobResourceUsageList	array<object>	返回的数据列表
	object	返回的数据列表
date	string	日程开始日期，格式：yyyy-MM-dd。	2023-05-09
jobOwner	string	作业的执行者	ALIYUN$xxx@test.aliyunid.com
quotaNickname	string	配额昵称	my_quota
cuUsage	integer	cu 使用总量	1185100
memoryUsage	integer	内存使用总量	15169536
totalCount	integer	返回结果的总数量。	64
pageNumber	integer	当前页码。	2
pageSize	integer	每页显示条数。	10

Examples

Success response

JSON format

{
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.