All Products
Search
Document Center

MaxCompute:ListJobMetric

Last Updated:Mar 07, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Queries a performance metric of the job that is complete.

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:
    • For mandatory resource types, indicate with a prefix of * .
    • 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:ListJobMetriclist
*All Resources
*
    none
none

Request syntax

POST /api/v1/jobs/metric HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
startTimelongYes

The start time for the observation interval.

1735534322
endTimelongYes

The end time for the observation interval.

1735536322
bodyobjectNo

The request body parameters.

metricstringNo

The name of observation metric.

Enumeration Value:
  • inputBytes: inputBytes.
  • memory: memory.
  • num: num.
  • inputBytesPerCu: inputBytesPerCu.
  • cpu: cpu.
  • runningTime: runningTime.
num
typestringNo

The type of observation metric.

Enumeration Value:
  • p1: only for metric runningTime.
  • p99: only for metric runningTime.
  • total: only for metric num,cpu,memory,inputBytes,inputBytesPerCu.
  • min: only for metric runningTime.
  • avg: only for metric runningTime.
  • max: only for metric runningTime.
  • p5: only for metric runningTime.
  • p90: only for metric runningTime.
  • p50: only for metric runningTime.
  • p95: only for metric runningTime.
  • p10: only for metric runningTime.
total
projectarrayNo

The name of MaxCompute projects (for filtering).

projectstringNo

The name of the MaxCompute project.

project_a
quotaarrayNo

The nickname of computing Quota nickname used by the job (for filtering).

quotastringNo

The nickname of computing Quota nickname used by the job

os_PayAsYouGoQuota
periodlongNo

The monitoring statistical period.Unit:Second(s).

Enumeration Value:
  • 3600: 3600.
  • 86400: 86400.
3600
groupstringNo

Grouping basis.

Note Available values: project, quota, type, status. Meanings:
  • project: Group and aggregate by project;
  • quota: Group and aggregate by quota;
  • type: Group and aggregate by job type;
  • status: Group and aggregate by job status.
  • project

    Response parameters

    ParameterTypeDescriptionExample
    object

    PopResult

    requestIdstring

    The request ID.

    0be3e0aa16667684362147582e038f
    httpCodeinteger

    HTTP status code.

    • 1xx: Informational response - Request received, processing continues.
    • 2xx: Success - The request has been successfully received, understood, and accepted by the server.
    • 3xx: Redirection - Further action must be taken to complete the request.
    • 4xx: Client error - The request contains bad syntax or cannot be fulfilled.
    • 5xx: Server error - The server failed to fulfill an apparently valid request.
    200
    errorCodestring

    The error code.

    OBJECT_NOT_EXIST
    errorMsgstring

    The error message.

    This object does not exist.
    dataobject

    The data returned.

    categorystring

    The category of the metrics.

    job
    namestring

    The name of observation metric.

    num
    periodlong

    The monitoring statistical period.Unit:Second(s).

    3600
    metricsarray<object>

    Metric details.

    metricobject

    Metric values.

    metricobject

    Metric related information.

    string

    Metric information.

    Note Possible values: type, project, quota, group.
    "type": "total"
    valuesarray

    Metric values information.

    valuearray

    List of metric values.

    itemdouble

    The first column represents the timestamp and the second column represents the corresponding value.

    1736679600, 3

    Examples

    Sample success responses

    JSONformat

    {
      "requestId": "0be3e0aa16667684362147582e038f",
      "httpCode": 200,
      "errorCode": "OBJECT_NOT_EXIST",
      "errorMsg": "This object does not exist.",
      "data": {
        "category": "job",
        "name": "num",
        "period": 3600,
        "metrics": [
          {
            "metric": {
              "key": "\"type\": \"total\""
            },
            "values": [
              [
                0
              ]
            ]
          }
        ]
      }
    }

    Error codes

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