SQL Server / Monitoring API / Summarizes and returns metrics data filtered using the provided query expression and compartmentId.
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- 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"
-- }
DECLARE @json int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'namespace', 'ipsum velit'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'query', 'enim sint cupidatat'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'endTime', '1970-02-17T08:36:22.342Z'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'resolution', 'ad culpa officia'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'resourceGroup', 'exercitat'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'startTime', '1960-03-31T20:00:02.377Z'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'opc-request-id', 'pariatur nostrud eiusmod'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'x-content-sha256', '{{content_sha256}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Authorization', '{{signature}}'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Date', '{{date}}'
DECLARE @resp int
EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://telemetry-ingestion.{{region}}.oraclecloud.com/20180401/metrics/actions/summarizeMetricsData?compartmentId={{compartment_ocid}}&compartmentIdInSubtree=true', 'application/json', @json
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jarrResp int
-- Use "Chilkat_9_5_0.JsonArray" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonArray', @jarrResp OUT
EXEC sp_OAMethod @jarrResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jarrResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jarrResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jarrResp
RETURN
END
EXEC @hr = sp_OADestroy @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
DECLARE @json int
DECLARE @compartmentId nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @namespace nvarchar(4000)
DECLARE @resolution nvarchar(4000)
DECLARE @resourceGroup nvarchar(4000)
DECLARE @j int
DECLARE @count_j int
DECLARE @timestamp nvarchar(4000)
DECLARE @value nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAGetProperty @jarrResp, 'Size', @count_i OUT
WHILE @i < @count_i
BEGIN
EXEC sp_OAMethod @jarrResp, 'ObjectAt', @json OUT, @i
EXEC sp_OAMethod @json, 'StringOf', @compartmentId OUT, 'compartmentId'
EXEC sp_OAMethod @json, 'StringOf', @name OUT, 'name'
EXEC sp_OAMethod @json, 'StringOf', @namespace OUT, 'namespace'
EXEC sp_OAMethod @json, 'StringOf', @resolution OUT, 'resolution'
EXEC sp_OAMethod @json, 'StringOf', @resourceGroup OUT, 'resourceGroup'
SELECT @j = 0
EXEC sp_OAMethod @json, 'SizeOfArray', @count_j OUT, 'aggregatedDatapoints'
WHILE @j < @count_j
BEGIN
EXEC sp_OASetProperty @json, 'J', @j
EXEC sp_OAMethod @json, 'StringOf', @timestamp OUT, 'aggregatedDatapoints[j].timestamp'
EXEC sp_OAMethod @json, 'StringOf', @value OUT, 'aggregatedDatapoints[j].value'
SELECT @j = @j + 1
END
EXEC @hr = sp_OADestroy @json
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jarrResp
END
GO
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}"
}
]
}
