Class ListMetricsRequest

Inheritance
object
ListMetricsRequest
Implements
Inherited Members
Namespace: Oci.MonitoringService.Requests
Assembly: OCI.DotNetSDK.Monitoring.dll
Syntax
public class ListMetricsRequest : IOciRequest
Examples

Click here to see an example of how to use ListMetrics request.

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

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
Remarks

Required

CompartmentIdInSubtree

Declaration
[HttpConverter(TargetEnum.Query, "compartmentIdInSubtree")]
public bool? CompartmentIdInSubtree { get; set; }
Property Value
Type Description
bool?

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.

Limit

Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type Description
int?

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

ListMetricsDetails

Declaration
[Required(ErrorMessage = "ListMetricsDetails is required.")]
[HttpConverter(TargetEnum.Body)]
public ListMetricsDetails ListMetricsDetails { get; set; }
Property Value
Type Description
ListMetricsDetails

The dimensions used to filter metrics.
Remarks

Required

OpcRequestId

Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type Description
string

Customer part of the request identifier token. If you need to contact Oracle about a particular request, please provide the complete request ID.

Page

Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type Description
string

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.

Implements