GetJobResourceUsage-阿里云帮助中心

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

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
date	string	Yes	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
jobOwnerList	array	No	The list of job executors.
	string	No	The list of job executors.	ALIYUN$xxx@test.aliyunid.com
quotaNicknameList	array	No	The list of nicknames of quotas that are used by jobs.
	string	No	The list of nicknames of quotas that are used by jobs.	my_quota
pageNumber	integer	No	The page number.	1
pageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	10

Response elements

Element	Type	Description	Example
	object	PopResult
requestId	string	The request ID.	0b57ff7616612271051086500ea3ce
httpCode	integer	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
errorCode	string	The error code returned if the request failed.	success
errorMsg	string	The error message returned if the request failed.	0A3B1E82006A23A918C70905BF08AEC7
data	object	The data returned.
jobResourceUsageList	array<object>	The data list returned.
	object
date	string	The start date of the query in the format of yyyy-MM-dd.	2023-05-09
jobOwner	string	The job executor.	ALIYUN$xxx@test.aliyunid.com
quotaNickname	string	The quota nickname.	my_quota
cuUsage	integer	The total number of used compute units (CUs).	1185100
memoryUsage	integer	The total memory usage.	15169536
totalCount	integer	The total number of returned entries.	64
pageNumber	integer	The page number.	2
pageSize	integer	The number of entries per page.	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.