Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListMetricsDetails

The request details for retrieving metric definitions. Specify optional properties to filter the returned results. Use an asterisk (*) as a wildcard character, placed anywhere in the string. For example, to search for all metrics with names that begin with "disk", specify "name" as "disk*". If no properties are specified, then all metric definitions within the request scope are returned.

Properties

Optional dimensionFilters

dimensionFilters: undefined | object

Qualifiers that you want to use when searching for metric definitions. Available dimensions vary by metric namespace. Each dimension takes the form of a key-value pair.

Example: {@code {\"resourceId\": \"ocid1.instance.region1.phx.exampleuniqueID\"}}

Optional groupBy

groupBy: Array<string>

Group metrics by these fields in the response. For example, to list all metric namespaces available in a compartment, groupBy the "namespace" field. Supported fields: namespace, name, resourceGroup. If {@code groupBy} is used, then {@code dimensionFilters} is ignored.

Example - group by namespace: {@code [ \"namespace\" ]}

Optional name

name: undefined | string

The metric name to use when searching for metric definitions.

Example: {@code CpuUtilization}

Optional namespace

namespace: undefined | string

The source service or application to use when searching for metric definitions.

Example: {@code oci_computeagent}

Optional resourceGroup

resourceGroup: undefined | string

Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($).

Example: {@code frontend-fleet}

Optional sortBy

sortBy: SortBy

The field to use when sorting returned metric definitions. Only one sorting level is provided.

Example: {@code NAMESPACE}

Optional sortOrder

sortOrder: SortOrder

The sort order to use when sorting returned metric definitions. Ascending (ASC) or descending (DESC).

Example: {@code ASC}

Functions

getDeserializedJsonObj

getJsonObj