Qodex.ai

List metrics based on matching criteria.

POST {{baseUrlIngestion}}/metrics/actions/listMetrics?compartmentId={{compartment_ocid}}&page=&limit=576&compartmentIdInSubtree=true

Returns metric definitions that match the criteria specified in the request. Compartment OCID required. For information about metrics, see Metrics Overview. For important limits information, see Limits on Monitoring.

Transactions Per Second (TPS) per-tenancy limit for this operation: 10.

Request Params

KeyDatatypeRequiredDescription
compartmentIdstring(Required) The OCID of the compartment containing the
resources monitored by the metric that you are searching for. Use tenancyId to search in
the root compartment.

Example: ocid1.compartment.oc1..exampleuniqueID | | page | null | | For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination. | | limit | number | | For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

Default: 1000

Example: 500 | | compartmentIdInSubtree | boolean | | When true, returns resources from all compartments and subcompartments. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, returns resources from only the compartment specified in compartmentId. Default is false. |

Request Body

{"groupBy"=>["aliqua nisi incididunt magna Excepteur", "eu et non laborum dolor"], "name"=>"amet ut", "namespace"=>"Ut dolore", "resourceGroup"=>"aliqua sed", "sortBy"=>"NAME", "sortOrder"=>"ASC"}

HEADERS

KeyDatatypeRequiredDescription
opc-request-idstringCustomer part of the request identifier token. If you need to contact Oracle about a particular
request, please provide the complete request ID.
Content-Typestring
Datestring(Required) Current Date
Authorizationstring(Required) Signature Authentication on Authorization header
x-content-sha256string(Required) Content sha256 for POST, PUT and PATCH operations

RESPONSES

status: OK

[{"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"}]