TCL / Monitoring API / Summarizes and returns metrics data filtered using the provided query expression and compartmentId.
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "namespace": "ipsum velit",
# "query": "enim sint cupidatat",
# "endTime": "1970-02-17T08:36:22.342Z",
# "resolution": "ad culpa officia",
# "resourceGroup": "exercitat",
# "startTime": "1960-03-31T20:00:02.377Z"
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "namespace" "ipsum velit"
CkJsonObject_UpdateString $json "query" "enim sint cupidatat"
CkJsonObject_UpdateString $json "endTime" "1970-02-17T08:36:22.342Z"
CkJsonObject_UpdateString $json "resolution" "ad culpa officia"
CkJsonObject_UpdateString $json "resourceGroup" "exercitat"
CkJsonObject_UpdateString $json "startTime" "1960-03-31T20:00:02.377Z"
CkHttp_SetRequestHeader $http "opc-request-id" "pariatur nostrud eiusmod"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
CkHttp_SetRequestHeader $http "x-content-sha256" "{{content_sha256}}"
CkHttp_SetRequestHeader $http "Authorization" "{{signature}}"
CkHttp_SetRequestHeader $http "Date" "{{date}}"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://telemetry-ingestion.{{region}}.oraclecloud.com/20180401/metrics/actions/summarizeMetricsData?compartmentId={{compartment_ocid}}&compartmentIdInSubtree=true" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jarrResp [new_CkJsonArray]
CkJsonArray_LoadSb $jarrResp $sbResponseBody
CkJsonArray_put_EmitCompact $jarrResp 0
puts "Response Body:"
puts [CkJsonArray_emit $jarrResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonArray $jarrResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# [
# {
# "aggregatedDatapoints": [
# {
# "timestamp": "1985-06-19T12:01:12.090Z",
# "value": -32623933.259507656
# }
# ],
# "compartmentId": "ocid1.compartment.oc1..exampleuniqueID",
# "dimensions": {},
# "name": "et",
# "namespace": "ea deserunt Duis",
# "metadata": {},
# "resolution": "veniam proident ullamco esse qui",
# "resourceGroup": "elit Duis"
# },
# {
# "aggregatedDatapoints": [
# {
# "timestamp": "2003-08-02T12:17:20.221Z",
# "value": 54399970.60984036
# }
# ],
# "compartmentId": "ocid1.compartment.oc1..exampleuniqueID",
# "dimensions": {},
# "name": "adipisicing fugiat",
# "namespace": "proident sunt veniam",
# "metadata": {},
# "resolution": "fugiat ullamco Lorem laborum est",
# "resourceGroup": "ut adipisicing exercitation magna Ut"
# }
# ]
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
# json is a CkJsonObject
set i 0
set count_i [CkJsonArray_get_Size $jarrResp]
while {$i < $count_i} {
set json [CkJsonArray_ObjectAt $jarrResp $i]
set compartmentId [CkJsonObject_stringOf $json "compartmentId"]
set name [CkJsonObject_stringOf $json "name"]
set namespace [CkJsonObject_stringOf $json "namespace"]
set resolution [CkJsonObject_stringOf $json "resolution"]
set resourceGroup [CkJsonObject_stringOf $json "resourceGroup"]
set j 0
set count_j [CkJsonObject_SizeOfArray $json "aggregatedDatapoints"]
while {$j < $count_j} {
CkJsonObject_put_J $json $j
set timestamp [CkJsonObject_stringOf $json "aggregatedDatapoints[j].timestamp"]
set value [CkJsonObject_stringOf $json "aggregatedDatapoints[j].value"]
set j [expr $j + 1]
}
delete_CkJsonObject $json
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonArray $jarrResp
Curl Command
curl -X POST
-H "opc-request-id: pariatur nostrud eiusmod"
-H "Content-Type: application/json"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
-H "x-content-sha256: {{content_sha256}}"
-d '{
"namespace": "ipsum velit",
"query": "enim sint cupidatat",
"endTime": "1970-02-17T08:36:22.342Z",
"resolution": "ad culpa officia",
"resourceGroup": "exercitat",
"startTime": "1960-03-31T20:00:02.377Z"
}'
https://telemetry-ingestion.{{region}}.oraclecloud.com/20180401/metrics/actions/summarizeMetricsData?compartmentId={{compartment_ocid}}&compartmentIdInSubtree=true
Postman Collection Item JSON
{
"name": "Summarizes and returns metrics data filtered using the provided query expression and compartmentId.",
"request": {
"method": "POST",
"header": [
{
"description": "Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
"key": "opc-request-id",
"value": "pariatur nostrud eiusmod"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Date",
"value": "{{date}}",
"description": "(Required) Current Date",
"type": "text"
},
{
"key": "Authorization",
"value": "{{signature}}",
"description": "(Required) Signature Authentication on Authorization header",
"type": "text"
},
{
"key": "x-content-sha256",
"value": "{{content_sha256}}",
"description": "(Required) Content sha256 for POST, PUT and PATCH operations",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"namespace\": \"ipsum velit\",\n \"query\": \"enim sint cupidatat\",\n \"endTime\": \"1970-02-17T08:36:22.342Z\",\n \"resolution\": \"ad culpa officia\",\n \"resourceGroup\": \"exercitat\",\n \"startTime\": \"1960-03-31T20:00:02.377Z\"\n}"
},
"url": {
"raw": "{{baseUrlIngestion}}/metrics/actions/summarizeMetricsData?compartmentId={{compartment_ocid}}&compartmentIdInSubtree=true",
"host": [
"{{baseUrlIngestion}}"
],
"path": [
"metrics",
"actions",
"summarizeMetricsData"
],
"query": [
{
"key": "compartmentId",
"value": "{{compartment_ocid}}",
"description": "(Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n"
},
{
"key": "compartmentIdInSubtree",
"value": "true",
"description": "When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n"
}
]
},
"description": "Returns aggregated data that match the criteria specified in the request. Compartment OCID required.\nFor information on metric queries, see [Building Metric Queries](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/buildingqueries.htm).\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nTransactions Per Second (TPS) per-tenancy limit for this operation: 10.\n"
},
"response": [
{
"name": "The metric data was successfully retrieved.\nResults are not paginated.\n",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
"key": "opc-request-id",
"value": "pariatur nostrud eiusmod"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"namespace\": \"ipsum velit\",\n \"query\": \"enim sint cupidatat\",\n \"endTime\": \"1970-02-17T08:36:22.342Z\",\n \"resolution\": \"ad culpa officia\",\n \"resourceGroup\": \"exercitat\",\n \"startTime\": \"1960-03-31T20:00:02.377Z\"\n}"
},
"url": {
"raw": "{{baseUrl}}/metrics/actions/summarizeMetricsData?compartmentId=mollit in Duis enim&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"actions",
"summarizeMetricsData"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "compartmentIdInSubtree",
"value": "true"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "pariatur nostrud eiusmod",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact Oracle about\na particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n {\n \"aggregatedDatapoints\": [\n {\n \"timestamp\": \"1985-06-19T12:01:12.090Z\",\n \"value\": -32623933.259507656\n }\n ],\n \"compartmentId\": \"ocid1.compartment.oc1..exampleuniqueID\",\n \"dimensions\": {},\n \"name\": \"et\",\n \"namespace\": \"ea deserunt Duis\",\n \"metadata\": {},\n \"resolution\": \"veniam proident ullamco esse qui\",\n \"resourceGroup\": \"elit Duis\"\n },\n {\n \"aggregatedDatapoints\": [\n {\n \"timestamp\": \"2003-08-02T12:17:20.221Z\",\n \"value\": 54399970.60984036\n }\n ],\n \"compartmentId\": \"ocid1.compartment.oc1..exampleuniqueID\",\n \"dimensions\": {},\n \"name\": \"adipisicing fugiat\",\n \"namespace\": \"proident sunt veniam\",\n \"metadata\": {},\n \"resolution\": \"fugiat ullamco Lorem laborum est\",\n \"resourceGroup\": \"ut adipisicing exercitation magna Ut\"\n }\n]"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
"key": "opc-request-id",
"value": "pariatur nostrud eiusmod"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"namespace\": \"ipsum velit\",\n \"query\": \"enim sint cupidatat\",\n \"endTime\": \"1970-02-17T08:36:22.342Z\",\n \"resolution\": \"ad culpa officia\",\n \"resourceGroup\": \"exercitat\",\n \"startTime\": \"1960-03-31T20:00:02.377Z\"\n}"
},
"url": {
"raw": "{{baseUrl}}/metrics/actions/summarizeMetricsData?compartmentId=mollit in Duis enim&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"actions",
"summarizeMetricsData"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "compartmentIdInSubtree",
"value": "true"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "pariatur nostrud eiusmod",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact Oracle about\na particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"qui anim ut\",\n \"message\": \"esse proident\"\n}"
},
{
"name": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
"key": "opc-request-id",
"value": "pariatur nostrud eiusmod"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"namespace\": \"ipsum velit\",\n \"query\": \"enim sint cupidatat\",\n \"endTime\": \"1970-02-17T08:36:22.342Z\",\n \"resolution\": \"ad culpa officia\",\n \"resourceGroup\": \"exercitat\",\n \"startTime\": \"1960-03-31T20:00:02.377Z\"\n}"
},
"url": {
"raw": "{{baseUrl}}/metrics/actions/summarizeMetricsData?compartmentId=mollit in Duis enim&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"actions",
"summarizeMetricsData"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "compartmentIdInSubtree",
"value": "true"
}
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "pariatur nostrud eiusmod",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact Oracle about\na particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"qui anim ut\",\n \"message\": \"esse proident\"\n}"
},
{
"name": "Not Authorized Or Not Found",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
"key": "opc-request-id",
"value": "pariatur nostrud eiusmod"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"namespace\": \"ipsum velit\",\n \"query\": \"enim sint cupidatat\",\n \"endTime\": \"1970-02-17T08:36:22.342Z\",\n \"resolution\": \"ad culpa officia\",\n \"resourceGroup\": \"exercitat\",\n \"startTime\": \"1960-03-31T20:00:02.377Z\"\n}"
},
"url": {
"raw": "{{baseUrl}}/metrics/actions/summarizeMetricsData?compartmentId=mollit in Duis enim&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"actions",
"summarizeMetricsData"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "compartmentIdInSubtree",
"value": "true"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "pariatur nostrud eiusmod",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact Oracle about\na particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"qui anim ut\",\n \"message\": \"esse proident\"\n}"
},
{
"name": "Client is getting throttled, please retry with backoff.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
"key": "opc-request-id",
"value": "pariatur nostrud eiusmod"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"namespace\": \"ipsum velit\",\n \"query\": \"enim sint cupidatat\",\n \"endTime\": \"1970-02-17T08:36:22.342Z\",\n \"resolution\": \"ad culpa officia\",\n \"resourceGroup\": \"exercitat\",\n \"startTime\": \"1960-03-31T20:00:02.377Z\"\n}"
},
"url": {
"raw": "{{baseUrl}}/metrics/actions/summarizeMetricsData?compartmentId=mollit in Duis enim&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"actions",
"summarizeMetricsData"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "compartmentIdInSubtree",
"value": "true"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "pariatur nostrud eiusmod",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact Oracle about\na particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"qui anim ut\",\n \"message\": \"esse proident\"\n}"
},
{
"name": "Internal Server Error",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
"key": "opc-request-id",
"value": "pariatur nostrud eiusmod"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"namespace\": \"ipsum velit\",\n \"query\": \"enim sint cupidatat\",\n \"endTime\": \"1970-02-17T08:36:22.342Z\",\n \"resolution\": \"ad culpa officia\",\n \"resourceGroup\": \"exercitat\",\n \"startTime\": \"1960-03-31T20:00:02.377Z\"\n}"
},
"url": {
"raw": "{{baseUrl}}/metrics/actions/summarizeMetricsData?compartmentId=mollit in Duis enim&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"actions",
"summarizeMetricsData"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "compartmentIdInSubtree",
"value": "true"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "pariatur nostrud eiusmod",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact Oracle about\na particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"qui anim ut\",\n \"message\": \"esse proident\"\n}"
},
{
"name": "An error has occurred.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
"key": "opc-request-id",
"value": "pariatur nostrud eiusmod"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"namespace\": \"ipsum velit\",\n \"query\": \"enim sint cupidatat\",\n \"endTime\": \"1970-02-17T08:36:22.342Z\",\n \"resolution\": \"ad culpa officia\",\n \"resourceGroup\": \"exercitat\",\n \"startTime\": \"1960-03-31T20:00:02.377Z\"\n}"
},
"url": {
"raw": "{{baseUrl}}/metrics/actions/summarizeMetricsData?compartmentId=mollit in Duis enim&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"actions",
"summarizeMetricsData"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "compartmentIdInSubtree",
"value": "true"
}
]
}
},
"status": "Internal Server Error",
"code": 500,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-request-id",
"value": "pariatur nostrud eiusmod",
"description": "Unique Oracle-assigned identifier for the request. If you need to contact Oracle about\na particular request, please provide the request ID.\n"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"code\": \"qui anim ut\",\n \"message\": \"esse proident\"\n}"
}
]
}
