Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
queryParams = Chilkat::CkJsonObject.new()
queryParams.UpdateString("compartmentId","{{compartment_ocid}}")
queryParams.UpdateString("page","")
queryParams.UpdateInt("limit",576)
queryParams.UpdateString("displayName","laboris veniam quis")
queryParams.UpdateString("lifecycleState","ACTIVE")
queryParams.UpdateString("sortBy","displayName")
queryParams.UpdateString("sortOrder","ASC")
queryParams.UpdateString("compartmentIdInSubtree","true")
http.SetRequestHeader("opc-request-id","pariatur nostrud eiusmod")
http.SetRequestHeader("Authorization","{{signature}}")
http.SetRequestHeader("Date","{{date}}")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://telemetry.{{region}}.oraclecloud.com/20180401/alarms",queryParams)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jarrResp = Chilkat::CkJsonArray.new()
jarrResp.LoadSb(sbResponseBody)
jarrResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jarrResp.emit() + "\n";
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# [
# {
# "compartmentId": "ut in mollit labore",
# "destinations": [
# "nostrud fugiat ut commodo"
# ],
# "displayName": "ex",
# "id": "Duis magna officia aute",
# "isEnabled": false,
# "lifecycleState": "anim laboris ad aliquip",
# "metricCompartmentId": "esse ad non",
# "namespace": "dolor velit laboris incididunt veniam",
# "query": "non ut",
# "severity": "ERROR",
# "definedTags": {},
# "freeformTags": {},
# "suppression": {
# "timeSuppressFrom": "1982-09-15T09:12:21.166Z",
# "timeSuppressUntil": "1992-01-31T22:49:09.448Z",
# "description": "do cillum officia"
# }
# },
# {
# "compartmentId": "i",
# "destinations": [
# "dolor laborum aliquip culpa Excepteur"
# ],
# "displayName": "aliquip",
# "id": "ea dolor qui",
# "isEnabled": true,
# "lifecycleState": "ullamco officia deserunt",
# "metricCompartmentId": "magna laboris qui id",
# "namespace": "est exercita",
# "query": "voluptate",
# "severity": "CRITICAL",
# "definedTags": {},
# "freeformTags": {},
# "suppression": {
# "timeSuppressFrom": "1973-12-07T07:53:51.991Z",
# "timeSuppressUntil": "2008-10-19T15:07:46.702Z",
# "description": "deserunt paria"
# }
# }
# ]
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i = 0
count_i = jarrResp.get_Size()
while i < count_i
# json is a CkJsonObject
json = jarrResp.ObjectAt(i)
compartmentId = json.stringOf("compartmentId")
displayName = json.stringOf("displayName")
id = json.stringOf("id")
isEnabled = json.BoolOf("isEnabled")
lifecycleState = json.stringOf("lifecycleState")
metricCompartmentId = json.stringOf("metricCompartmentId")
namespace = json.stringOf("namespace")
query = json.stringOf("query")
severity = json.stringOf("severity")
TimeSuppressFrom = json.stringOf("suppression.timeSuppressFrom")
TimeSuppressUntil = json.stringOf("suppression.timeSuppressUntil")
Description = json.stringOf("suppression.description")
j = 0
count_j = json.SizeOfArray("destinations")
while j < count_j
json.put_J(j)
strVal = json.stringOf("destinations[j]")
j = j + 1
end
i = i + 1
end
Curl Command
curl -G -d "compartmentId=%7B%7Bcompartment_ocid%7D%7D"
-d "page="
-d "limit=576"
-d "displayName=laboris%20veniam%20quis"
-d "lifecycleState=ACTIVE"
-d "sortBy=displayName"
-d "sortOrder=ASC"
-d "compartmentIdInSubtree=true"
-H "opc-request-id: pariatur nostrud eiusmod"
-H "Date: {{date}}"
-H "Authorization: {{signature}}"
https://telemetry.{{region}}.oraclecloud.com/20180401/alarms
Postman Collection Item JSON
{
"name": "List Alarms",
"request": {
"method": "GET",
"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": "Date",
"value": "{{date}}",
"description": "(Required) Current Date",
"type": "text"
},
{
"key": "Authorization",
"value": "{{signature}}",
"description": "(Required) Signature Authentication on Authorization header",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/alarms?compartmentId={{compartment_ocid}}&page=&limit=576&displayName=laboris veniam quis&lifecycleState=ACTIVE&sortBy=displayName&sortOrder=ASC&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"alarms"
],
"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": "page",
"value": "",
"description": "For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
},
{
"key": "limit",
"value": "576",
"description": "For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n"
},
{
"key": "displayName",
"value": "laboris veniam quis",
"description": "A filter to return only resources that match the given display name exactly.\nUse this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.\n"
},
{
"key": "lifecycleState",
"value": "ACTIVE",
"description": "A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.\n"
},
{
"key": "sortBy",
"value": "displayName",
"description": "The field to use when sorting returned alarm definitions. Only one sorting level is provided.\n\nExample: `severity`\n"
},
{
"key": "sortOrder",
"value": "ASC",
"description": "The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC).\n\nExample: `ASC`\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": "Lists the alarms for the specified compartment.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n"
},
"response": [
{
"name": "Successfully retrieved alarms for listing.",
"originalRequest": {
"method": "GET",
"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"
}
],
"url": {
"raw": "{{baseUrl}}/alarms?compartmentId=mollit in Duis enim&page=do ipsum&limit=576&displayName=laboris veniam quis&lifecycleState=tempor qui&sortBy=displayName&sortOrder=ASC&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"alarms"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "page",
"value": "do ipsum"
},
{
"key": "limit",
"value": "576"
},
{
"key": "displayName",
"value": "laboris veniam quis"
},
{
"key": "lifecycleState",
"value": "tempor qui"
},
{
"key": "sortBy",
"value": "displayName"
},
{
"key": "sortOrder",
"value": "ASC"
},
{
"key": "compartmentIdInSubtree",
"value": "true"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "opc-next-page",
"value": "pariatur nostrud eiusmod",
"description": "For list pagination. When this header appears in the response, additional pages of results remain.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
},
{
"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 \"compartmentId\": \"ut in mollit labore\",\n \"destinations\": [\n \"nostrud fugiat ut commodo\"\n ],\n \"displayName\": \"ex\",\n \"id\": \"Duis magna officia aute\",\n \"isEnabled\": false,\n \"lifecycleState\": \"anim laboris ad aliquip\",\n \"metricCompartmentId\": \"esse ad non\",\n \"namespace\": \"dolor velit laboris incididunt veniam\",\n \"query\": \"non ut\",\n \"severity\": \"ERROR\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"suppression\": {\n \"timeSuppressFrom\": \"1982-09-15T09:12:21.166Z\",\n \"timeSuppressUntil\": \"1992-01-31T22:49:09.448Z\",\n \"description\": \"do cillum officia\"\n }\n },\n {\n \"compartmentId\": \"i\",\n \"destinations\": [\n \"dolor laborum aliquip culpa Excepteur\"\n ],\n \"displayName\": \"aliquip\",\n \"id\": \"ea dolor qui\",\n \"isEnabled\": true,\n \"lifecycleState\": \"ullamco officia deserunt\",\n \"metricCompartmentId\": \"magna laboris qui id\",\n \"namespace\": \"est exercita\",\n \"query\": \"voluptate\",\n \"severity\": \"CRITICAL\",\n \"definedTags\": {},\n \"freeformTags\": {},\n \"suppression\": {\n \"timeSuppressFrom\": \"1973-12-07T07:53:51.991Z\",\n \"timeSuppressUntil\": \"2008-10-19T15:07:46.702Z\",\n \"description\": \"deserunt paria\"\n }\n }\n]"
},
{
"name": "Bad Request",
"originalRequest": {
"method": "GET",
"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"
}
],
"url": {
"raw": "{{baseUrl}}/alarms?compartmentId=mollit in Duis enim&page=do ipsum&limit=576&displayName=laboris veniam quis&lifecycleState=tempor qui&sortBy=displayName&sortOrder=ASC&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"alarms"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "page",
"value": "do ipsum"
},
{
"key": "limit",
"value": "576"
},
{
"key": "displayName",
"value": "laboris veniam quis"
},
{
"key": "lifecycleState",
"value": "tempor qui"
},
{
"key": "sortBy",
"value": "displayName"
},
{
"key": "sortOrder",
"value": "ASC"
},
{
"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": "GET",
"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"
}
],
"url": {
"raw": "{{baseUrl}}/alarms?compartmentId=mollit in Duis enim&page=do ipsum&limit=576&displayName=laboris veniam quis&lifecycleState=tempor qui&sortBy=displayName&sortOrder=ASC&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"alarms"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "page",
"value": "do ipsum"
},
{
"key": "limit",
"value": "576"
},
{
"key": "displayName",
"value": "laboris veniam quis"
},
{
"key": "lifecycleState",
"value": "tempor qui"
},
{
"key": "sortBy",
"value": "displayName"
},
{
"key": "sortOrder",
"value": "ASC"
},
{
"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": "GET",
"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"
}
],
"url": {
"raw": "{{baseUrl}}/alarms?compartmentId=mollit in Duis enim&page=do ipsum&limit=576&displayName=laboris veniam quis&lifecycleState=tempor qui&sortBy=displayName&sortOrder=ASC&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"alarms"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "page",
"value": "do ipsum"
},
{
"key": "limit",
"value": "576"
},
{
"key": "displayName",
"value": "laboris veniam quis"
},
{
"key": "lifecycleState",
"value": "tempor qui"
},
{
"key": "sortBy",
"value": "displayName"
},
{
"key": "sortOrder",
"value": "ASC"
},
{
"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": "GET",
"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"
}
],
"url": {
"raw": "{{baseUrl}}/alarms?compartmentId=mollit in Duis enim&page=do ipsum&limit=576&displayName=laboris veniam quis&lifecycleState=tempor qui&sortBy=displayName&sortOrder=ASC&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"alarms"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "page",
"value": "do ipsum"
},
{
"key": "limit",
"value": "576"
},
{
"key": "displayName",
"value": "laboris veniam quis"
},
{
"key": "lifecycleState",
"value": "tempor qui"
},
{
"key": "sortBy",
"value": "displayName"
},
{
"key": "sortOrder",
"value": "ASC"
},
{
"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": "GET",
"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"
}
],
"url": {
"raw": "{{baseUrl}}/alarms?compartmentId=mollit in Duis enim&page=do ipsum&limit=576&displayName=laboris veniam quis&lifecycleState=tempor qui&sortBy=displayName&sortOrder=ASC&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"alarms"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "page",
"value": "do ipsum"
},
{
"key": "limit",
"value": "576"
},
{
"key": "displayName",
"value": "laboris veniam quis"
},
{
"key": "lifecycleState",
"value": "tempor qui"
},
{
"key": "sortBy",
"value": "displayName"
},
{
"key": "sortOrder",
"value": "ASC"
},
{
"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": "GET",
"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"
}
],
"url": {
"raw": "{{baseUrl}}/alarms?compartmentId=mollit in Duis enim&page=do ipsum&limit=576&displayName=laboris veniam quis&lifecycleState=tempor qui&sortBy=displayName&sortOrder=ASC&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"alarms"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "page",
"value": "do ipsum"
},
{
"key": "limit",
"value": "576"
},
{
"key": "displayName",
"value": "laboris veniam quis"
},
{
"key": "lifecycleState",
"value": "tempor qui"
},
{
"key": "sortBy",
"value": "displayName"
},
{
"key": "sortOrder",
"value": "ASC"
},
{
"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}"
}
]
}
