Call DescribeJobResourceUsage to retrieve job resource usage statistics - AnalyticDB

Obtain job resource usage statistics.

Operation description

For the current service endpoint, see endpoint.

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

adb:DescribeJobResourceUsage

get

*DBClusterLakeVersion

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	Data Lakehouse Edition cluster ID.	am-uf6g8w25jacm7****
StartTime	string	Yes	Query start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).	2023-02-04T03:45:00Z
EndTime	string	Yes	Query end time. Must be later than the query start time. Format: yyyy-MM-ddTHH:mm:ssZ (UTC time).	2023-03-17T16:00:00Z
PageNumber	integer	No	Page number. Valid values: positive integers. Default value: 1.	1
PageSize	integer	No	Number of records per page. Valid values: 30 50 100 Default value: 30.	30

Response elements

Element	Type	Description	Example
	object	PlainResponse
RequestId	string	Request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Code	integer	API status or POP error code.	200
Data	object	Response data.
DBClusterId	string	Data Lakehouse Edition cluster ID.	amv-clusterxxx
StartTime	string	Start time. Format: yyyy-MM-ddTHH:mmZ (UTC time).	2023-05-22T16:00:00Z
EndTime	string	End time. Format: yyyy-MM-ddTHH:mmZ (UTC time).	2023-05-23T16:00:00Z
JobAcuUsage	array<object>	ACU usage for Job-type resource groups.
	array<object>
JobId	string	Job ID.	1592
ResourceGroupName	string	Job-type resource group name.	job_default
JobStartTime	string	Job start time. Format: yyyy-MM-ddTHH:mmZ (UTC time).	2023-05-22T16:00:00Z
JobEndTime	string	Job end time. Format: yyyy-MM-ddTHH:mmZ (UTC time).	2023-05-23T16:00:00Z
AcuUsageDetail	object	ACU resource usage details.
TotalAcuNumber	number	Total ACU resources.	32ACU
ReservedAcuNumber	number	The number of reserved ACUs.	16ACU
ElasticAcuNumber	number	The number of elastic ACUs allocated to the resource.	16ACU
SpotAcuNumber	number	The number of ACUs used by spot instances.	16ACU
SpotAcuPercentage	number	Percentage of spot instance resources in total elastic resources.	0.9
UseCachePool	boolean	Indicates whether a hot pool is used.	false
PageNumber	integer	Page number.	1
PageSize	integer	Number of records per page.	30
TotalCount	integer	Total number of records.	100

Examples

Success response

JSON format

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Code": 200,
  "Data": {
    "DBClusterId": "amv-clusterxxx",
    "StartTime": "2023-05-22T16:00:00Z",
    "EndTime": "2023-05-23T16:00:00Z\n",
    "JobAcuUsage": [
      {
        "JobId": "1592",
        "ResourceGroupName": "job_default",
        "JobStartTime": "2023-05-22T16:00:00Z\n",
        "JobEndTime": "2023-05-23T16:00:00Z",
        "AcuUsageDetail": {
          "TotalAcuNumber": 0,
          "ReservedAcuNumber": 0,
          "ElasticAcuNumber": 0,
          "SpotAcuNumber": 0,
          "SpotAcuPercentage": 0.9
        },
        "UseCachePool": false
      }
    ],
    "PageNumber": 1,
    "PageSize": 30,
    "TotalCount": 100
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.