phpExt / Monitoring API / List metrics based on matching criteria.
Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$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.
// {
// "dimensionFilters": {},
// "groupBy": [
// "aliqua nisi incididunt magna Excepteur",
// "eu et non laborum dolor"
// ],
// "name": "amet ut",
// "namespace": "Ut dolore",
// "resourceGroup": "aliqua sed",
// "sortBy": "NAME",
// "sortOrder": "ASC"
// }
$json = new CkJsonObject();
$json->UpdateNewObject('dimensionFilters');
$json->UpdateString('groupBy[0]','aliqua nisi incididunt magna Excepteur');
$json->UpdateString('groupBy[1]','eu et non laborum dolor');
$json->UpdateString('name','amet ut');
$json->UpdateString('namespace','Ut dolore');
$json->UpdateString('resourceGroup','aliqua sed');
$json->UpdateString('sortBy','NAME');
$json->UpdateString('sortOrder','ASC');
$http->SetRequestHeader('opc-request-id','pariatur nostrud eiusmod');
$http->SetRequestHeader('Content-Type','application/json');
$http->SetRequestHeader('x-content-sha256','{{content_sha256}}');
$http->SetRequestHeader('Authorization','{{signature}}');
$http->SetRequestHeader('Date','{{date}}');
// resp is a CkHttpResponse
$resp = $http->PostJson3('https://telemetry-ingestion.{{region}}.oraclecloud.com/20180401/metrics/actions/listMetrics?compartmentId={{compartment_ocid}}&page=&limit=576&compartmentIdInSubtree=true','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
print $http->lastErrorText() . "\n";
exit;
}
$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jarrResp = new CkJsonArray();
$jarrResp->LoadSb($sbResponseBody);
$jarrResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jarrResp->emit() . "\n";
$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->header() . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// [
// {
// "compartmentId": "ocid1.compartment.oc1..exampleuniqueID",
// "dimensions": {},
// "name": "in veniam",
// "namespace": "ut eu ex deserunt",
// "resourceGroup": "sunt dolor dolore ea ipsum"
// },
// {
// "compartmentId": "ocid1.compartment.oc1..exampleuniqueID",
// "dimensions": {},
// "name": "tempor nisi",
// "namespace": "aliquip occaecat ullamco aute sint",
// "resourceGroup": "cillum laboris"
// }
// ]
// 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');
$name = $json->stringOf('name');
$namespace = $json->stringOf('namespace');
$resourceGroup = $json->stringOf('resourceGroup');
$i = $i + 1;
}
?>
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 '{
"dimensionFilters": {},
"groupBy": [
"aliqua nisi incididunt magna Excepteur",
"eu et non laborum dolor"
],
"name": "amet ut",
"namespace": "Ut dolore",
"resourceGroup": "aliqua sed",
"sortBy": "NAME",
"sortOrder": "ASC"
}'
https://telemetry-ingestion.{{region}}.oraclecloud.com/20180401/metrics/actions/listMetrics?compartmentId={{compartment_ocid}}&page=&limit=576&compartmentIdInSubtree=true
Postman Collection Item JSON
{
"name": "List metrics based on matching criteria.",
"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 \"dimensionFilters\": {},\n \"groupBy\": [\n \"aliqua nisi incididunt magna Excepteur\",\n \"eu et non laborum dolor\"\n ],\n \"name\": \"amet ut\",\n \"namespace\": \"Ut dolore\",\n \"resourceGroup\": \"aliqua sed\",\n \"sortBy\": \"NAME\",\n \"sortOrder\": \"ASC\"\n}"
},
"url": {
"raw": "{{baseUrlIngestion}}/metrics/actions/listMetrics?compartmentId={{compartment_ocid}}&page=&limit=576&compartmentIdInSubtree=true",
"host": [
"{{baseUrlIngestion}}"
],
"path": [
"metrics",
"actions",
"listMetrics"
],
"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": "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 metric definitions that match the criteria specified in the request. Compartment OCID required.\nFor information about metrics, see [Metrics Overview](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview).\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 definitions were successfully retrieved.\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 \"dimensionFilters\": {},\n \"groupBy\": [\n \"ea dolor tempor nostrud\",\n \"cillum ea in\"\n ],\n \"name\": \"exercitation dolor\",\n \"namespace\": \"elit consectetur\",\n \"resourceGroup\": \"enim adipis\",\n \"sortBy\": \"NAMESPACE\",\n \"sortOrder\": \"DESC\"\n}"
},
"url": {
"raw": "{{baseUrl}}/metrics/actions/listMetrics?compartmentId=mollit in Duis enim&page=do ipsum&limit=576&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"actions",
"listMetrics"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "page",
"value": "do ipsum"
},
{
"key": "limit",
"value": "576"
},
{
"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\": \"ocid1.compartment.oc1..exampleuniqueID\",\n \"dimensions\": {},\n \"name\": \"in veniam\",\n \"namespace\": \"ut eu ex deserunt\",\n \"resourceGroup\": \"sunt dolor dolore ea ipsum\"\n },\n {\n \"compartmentId\": \"ocid1.compartment.oc1..exampleuniqueID\",\n \"dimensions\": {},\n \"name\": \"tempor nisi\",\n \"namespace\": \"aliquip occaecat ullamco aute sint\",\n \"resourceGroup\": \"cillum laboris\"\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 \"dimensionFilters\": {},\n \"groupBy\": [\n \"ea dolor tempor nostrud\",\n \"cillum ea in\"\n ],\n \"name\": \"exercitation dolor\",\n \"namespace\": \"elit consectetur\",\n \"resourceGroup\": \"enim adipis\",\n \"sortBy\": \"NAMESPACE\",\n \"sortOrder\": \"DESC\"\n}"
},
"url": {
"raw": "{{baseUrl}}/metrics/actions/listMetrics?compartmentId=mollit in Duis enim&page=do ipsum&limit=576&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"actions",
"listMetrics"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "page",
"value": "do ipsum"
},
{
"key": "limit",
"value": "576"
},
{
"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 \"dimensionFilters\": {},\n \"groupBy\": [\n \"ea dolor tempor nostrud\",\n \"cillum ea in\"\n ],\n \"name\": \"exercitation dolor\",\n \"namespace\": \"elit consectetur\",\n \"resourceGroup\": \"enim adipis\",\n \"sortBy\": \"NAMESPACE\",\n \"sortOrder\": \"DESC\"\n}"
},
"url": {
"raw": "{{baseUrl}}/metrics/actions/listMetrics?compartmentId=mollit in Duis enim&page=do ipsum&limit=576&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"actions",
"listMetrics"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "page",
"value": "do ipsum"
},
{
"key": "limit",
"value": "576"
},
{
"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 \"dimensionFilters\": {},\n \"groupBy\": [\n \"ea dolor tempor nostrud\",\n \"cillum ea in\"\n ],\n \"name\": \"exercitation dolor\",\n \"namespace\": \"elit consectetur\",\n \"resourceGroup\": \"enim adipis\",\n \"sortBy\": \"NAMESPACE\",\n \"sortOrder\": \"DESC\"\n}"
},
"url": {
"raw": "{{baseUrl}}/metrics/actions/listMetrics?compartmentId=mollit in Duis enim&page=do ipsum&limit=576&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"actions",
"listMetrics"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "page",
"value": "do ipsum"
},
{
"key": "limit",
"value": "576"
},
{
"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 \"dimensionFilters\": {},\n \"groupBy\": [\n \"ea dolor tempor nostrud\",\n \"cillum ea in\"\n ],\n \"name\": \"exercitation dolor\",\n \"namespace\": \"elit consectetur\",\n \"resourceGroup\": \"enim adipis\",\n \"sortBy\": \"NAMESPACE\",\n \"sortOrder\": \"DESC\"\n}"
},
"url": {
"raw": "{{baseUrl}}/metrics/actions/listMetrics?compartmentId=mollit in Duis enim&page=do ipsum&limit=576&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"actions",
"listMetrics"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "page",
"value": "do ipsum"
},
{
"key": "limit",
"value": "576"
},
{
"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 \"dimensionFilters\": {},\n \"groupBy\": [\n \"ea dolor tempor nostrud\",\n \"cillum ea in\"\n ],\n \"name\": \"exercitation dolor\",\n \"namespace\": \"elit consectetur\",\n \"resourceGroup\": \"enim adipis\",\n \"sortBy\": \"NAMESPACE\",\n \"sortOrder\": \"DESC\"\n}"
},
"url": {
"raw": "{{baseUrl}}/metrics/actions/listMetrics?compartmentId=mollit in Duis enim&page=do ipsum&limit=576&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"actions",
"listMetrics"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "page",
"value": "do ipsum"
},
{
"key": "limit",
"value": "576"
},
{
"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 \"dimensionFilters\": {},\n \"groupBy\": [\n \"ea dolor tempor nostrud\",\n \"cillum ea in\"\n ],\n \"name\": \"exercitation dolor\",\n \"namespace\": \"elit consectetur\",\n \"resourceGroup\": \"enim adipis\",\n \"sortBy\": \"NAMESPACE\",\n \"sortOrder\": \"DESC\"\n}"
},
"url": {
"raw": "{{baseUrl}}/metrics/actions/listMetrics?compartmentId=mollit in Duis enim&page=do ipsum&limit=576&compartmentIdInSubtree=true",
"host": [
"{{baseUrl}}"
],
"path": [
"metrics",
"actions",
"listMetrics"
],
"query": [
{
"key": "compartmentId",
"value": "mollit in Duis enim"
},
{
"key": "page",
"value": "do ipsum"
},
{
"key": "limit",
"value": "576"
},
{
"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}"
}
]
}
