Jump to

• Request
• Response

Summarize compute metrics data

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/summarizeMetricsData

Provides summarized compute metrics for a compute cluster in the given workspace. This API aggregates metric data points based on a specified namespace, metric name, and aggregation type. The response contains computed metric summaries.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• clusterKey(required): string
  Cluster key.
• workspaceKey(required): string
  The key of the Workspace

Header Parameters

• if-match: string
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.

Body ()

Request body containing metric parameters.

Root Schema : SummarizeMetricsDataDetails

Type: object

Request payload for summarizing compute metrics data.

Show Source

• aggregationType(required): string
  Allowed Values: [ "MAX", "MEAN", "MIN", "SUM", "RATE", "P50", "P80", "P90", "P95", "P99", "P99_9" ]

  The type of aggregation to apply. - Standard Aggregations: `MAX`, `MEAN`, `MIN`, `SUM`, `RATE`. - Percentile Aggregation: Use `Pxx`, where `xx` is the percentile value (e.g., `P80` for the 80th percentile).

  Example: P80
• interval(required): string
  The time window used to convert the set of raw data points. The timestamp of the aggregated data point corresponds to the end of the time window during which raw data points are assessed. For example, for a five-minute interval, the timestamp "2:05" corresponds to the five-minute time window from 2:00:00 to 2:05:00.

  Example: 5m
• metricName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The metric to summarize. - Supported values include but are not limited to: - `CPU_UTILIZATION`, `MEMORY_UTILIZATION`, `FILE_SYSTEM_UTILIZATION`, `GC_CPU_UTILIZATION` - `DISK_READ_BYTES`, `DISK_WRITE_BYTES`, `NETWORK_RECEIVE_BYTES`, `NETWORK_TRANSMIT_BYTES` - `APP_STATUS`, `EXECUTOR_METRICS`, `SYSTEM_CPU`, `SYSTEM_MEMORY` - `SYSTEM_NETWORK_IN`, `SYSTEM_NETWORK_OUT`, `SYSTEM_DISK_READ`, `SYSTEM_DISK_WRITE` - Additional metrics such as task-related and shuffle metrics may be introduced in the future. - Refer to API documentation or contact support for the latest supported metric list.
• resolution: string
  The time between calculated aggregation windows. Use with the query interval to vary the frequency for returning aggregated data points. For example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency. The resolution must be equal to or less than the interval in the query. The default resolution is 1m (one minute). Supported values: 1m-60m, 1h-24h, 1d.

  Example: 1m
• timeBegin(required): string(date-time)
  The beginning of the time range to use when searching for metric data points. Format is RFC 3339.
• timeEnd(required): string(date-time)
  The end of the time range to use when searching for metric data points. Format is RFC 3339.

{
    "type":"object",
    "description":"Request payload for summarizing compute metrics data.",
    "required":[
        "timeBegin",
        "timeEnd",
        "aggregationType",
        "metricName",
        "interval"
    ],
    "properties":{
        "aggregationType":{
            "type":"string",
            "description":"The type of aggregation to apply.\n- Standard Aggregations: `MAX`, `MEAN`, `MIN`, `SUM`, `RATE`.\n- Percentile Aggregation: Use `Pxx`, where `xx` is the percentile value (e.g., `P80` for the 80th percentile).\n",
            "enum":[
                "MAX",
                "MEAN",
                "MIN",
                "SUM",
                "RATE",
                "P50",
                "P80",
                "P90",
                "P95",
                "P99",
                "P99_9"
            ],
            "example":"P80"
        },
        "metricName":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "description":"The metric to summarize. \n- Supported values include but are not limited to:\n  - `CPU_UTILIZATION`, `MEMORY_UTILIZATION`, `FILE_SYSTEM_UTILIZATION`, `GC_CPU_UTILIZATION`\n  - `DISK_READ_BYTES`, `DISK_WRITE_BYTES`, `NETWORK_RECEIVE_BYTES`, `NETWORK_TRANSMIT_BYTES`\n  - `APP_STATUS`, `EXECUTOR_METRICS`, `SYSTEM_CPU`, `SYSTEM_MEMORY`\n  - `SYSTEM_NETWORK_IN`, `SYSTEM_NETWORK_OUT`, `SYSTEM_DISK_READ`, `SYSTEM_DISK_WRITE`\n  - Additional metrics such as task-related and shuffle metrics may be introduced in the future.\n- Refer to API documentation or contact support for the latest supported metric list.\n"
        },
        "timeBegin":{
            "type":"string",
            "format":"date-time",
            "description":"The beginning of the time range to use when searching for metric data points. Format is RFC 3339.",
            "x-default-description":"Default value is the timestamp 3 hours before the call was sent."
        },
        "timeEnd":{
            "type":"string",
            "format":"date-time",
            "description":"The end of the time range to use when searching for metric data points. Format is RFC 3339.",
            "x-default-description":"Default value is the timestamp representing when the call was sent."
        },
        "interval":{
            "type":"string",
            "description":"The time window used to convert the set of raw data points.\nThe timestamp of the aggregated data point corresponds to the end of the time window during which raw data points are assessed.\nFor example, for a five-minute interval, the timestamp \"2:05\" corresponds to the five-minute time window from 2:00:00 to 2:05:00.\n",
            "example":"5m"
        },
        "resolution":{
            "type":"string",
            "description":"The time between calculated aggregation windows. Use with the query interval to vary the frequency for returning aggregated data points.\nFor example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency.\nThe resolution must be equal to or less than the interval in the query.\nThe default resolution is 1m (one minute).\nSupported values: 1m-60m, 1h-24h, 1d.\n",
            "example":"1m"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Summarized metrics data for the specified parameters is retrieved.

Headers

• etag: string
  The ETag for optimistic concurrency control.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : SummarizeMetricsResponse

Type: object

Response payload containing summarized metric data.

Show Source

• results(required): array results
  List of computed metric summary results.

{
    "type":"object",
    "description":"Response payload containing summarized metric data.",
    "required":[
        "results"
    ],
    "properties":{
        "results":{
            "type":"array",
            "description":"List of computed metric summary results.",
            "items":{
                "$ref":"#/definitions/MetricsSummary"
            }
        }
    }
}

Nested Schema : results

Type: array

List of computed metric summary results.

Show Source

• Array of: object MetricsSummary
  A summarized metric result containing aggregated data points.

{
    "type":"array",
    "description":"List of computed metric summary results.",
    "items":{
        "$ref":"#/definitions/MetricsSummary"
    }
}

Nested Schema : MetricsSummary

Type: object

A summarized metric result containing aggregated data points.

Show Source

• aggregatedDataPoints(required): array aggregatedDataPoints
  Minimum Number of Items: 1

  List of timestamp-value pairs for the metric.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment containing the resources that the aggregated data was returned from.
• dimensions(required): object dimensions
  Key-value pairs that provide context for the metric.
• metadata: object metadata
  Additional references provided in the metric definition.
• name(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the metric.
• namespace(required): string
  Minimum Length: 1

  Maximum Length: 255

  The source service or application that emitted the metric.
• resolution: string
  The time between calculated aggregation windows.

  Example: 5m
• resourceGroup: string
  Minimum Length: 1

  Maximum Length: 255

  A custom string used for grouping related metrics.

{
    "type":"object",
    "description":"A summarized metric result containing aggregated data points.",
    "required":[
        "namespace",
        "compartmentId",
        "name",
        "dimensions",
        "aggregatedDataPoints"
    ],
    "properties":{
        "namespace":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "description":"The source service or application that emitted the metric."
        },
        "compartmentId":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "description":"The OCID of the compartment containing the resources that the aggregated data was returned from."
        },
        "name":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "description":"The name of the metric."
        },
        "dimensions":{
            "type":"object",
            "description":"Key-value pairs that provide context for the metric.",
            "example":{
                "resourceId":"ocid1.instance.region1.phx.exampleuniqueID"
            }
        },
        "metadata":{
            "type":"object",
            "description":"Additional references provided in the metric definition.",
            "example":{
                "unit":"bytes"
            }
        },
        "resolution":{
            "type":"string",
            "description":"The time between calculated aggregation windows.",
            "example":"5m"
        },
        "resourceGroup":{
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "description":"A custom string used for grouping related metrics."
        },
        "aggregatedDataPoints":{
            "type":"array",
            "description":"List of timestamp-value pairs for the metric.",
            "minItems":1,
            "items":{
                "$ref":"#/definitions/AggregatedDataPoint"
            }
        }
    }
}

Nested Schema : aggregatedDataPoints

Type: array

Minimum Number of Items: 1

List of timestamp-value pairs for the metric.

Show Source

• Array of: object AggregatedDataPoint
  A single aggregated data point.

{
    "type":"array",
    "description":"List of timestamp-value pairs for the metric.",
    "minItems":1,
    "items":{
        "$ref":"#/definitions/AggregatedDataPoint"
    }
}

Nested Schema : dimensions

Type: object

Key-value pairs that provide context for the metric.

Example:

{
    "resourceId":"ocid1.instance.region1.phx.exampleuniqueID"
}

Nested Schema : metadata

Type: object

Additional references provided in the metric definition.

Example:

{
    "unit":"bytes"
}

Nested Schema : AggregatedDataPoint

Type: object

A single aggregated data point.

Show Source

• timestamp(required): string(date-time)
  The timestamp of the aggregated data point.
• value(required): number(float)
  The computed metric value at the given timestamp.

{
    "type":"object",
    "description":"A single aggregated data point.",
    "required":[
        "timestamp",
        "value"
    ],
    "properties":{
        "timestamp":{
            "type":"string",
            "format":"date-time",
            "description":"The timestamp of the aggregated data point."
        },
        "value":{
            "type":"number",
            "format":"float",
            "description":"The computed metric value at the given timestamp."
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

409 Response

Conflict. Request conflicts with the current state of the resource.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

412 Response

Precondition Failed (One or more conditions in request failed).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top