Class ListAlarmsStatusRequest

Inheritance

object

ListAlarmsStatusRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.MonitoringService.Requests

Assembly: OCI.DotNetSDK.Monitoring.dll

Syntax

public class ListAlarmsStatusRequest : IOciRequest

Examples

Click here to see an example of how to use ListAlarmsStatus 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.

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.

DisplayName

Declaration

[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.

EntityId

Declaration

[HttpConverter(TargetEnum.Query, "entityId")]
public string EntityId { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match the given entity OCID exactly. The resource (entity) must be monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID

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

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.

ResourceId

Declaration

[HttpConverter(TargetEnum.Query, "resourceId")]
public string ResourceId { get; set; }

Property Value

Type	Description
string	A filter to return only the resource with the specified OCID. The resource must be monitored by the metric that you are searching for. Example: ocid1.instance.oc1.phx.exampleuniqueID

ServiceName

Declaration

[HttpConverter(TargetEnum.Query, "serviceName")]
public string ServiceName { get; set; }

Property Value

Type	Description
string	A filter to return only resources that match the given service name exactly. Use this filter to list all alarms containing metric streams that match the exact service-name dimension. Example: logging-analytics

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListAlarmsStatusRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListAlarmsStatusRequest.SortByEnum?	The field to use when sorting returned alarm definitions. Only one sorting level is provided. Example: severity

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListAlarmsStatusRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListAlarmsStatusRequest.SortOrderEnum?	The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC). Example: ASC

Status

Declaration

[HttpConverter(TargetEnum.Query, "status")]
public ListAlarmsStatusRequest.StatusEnum? Status { get; set; }

Property Value

Type	Description
ListAlarmsStatusRequest.StatusEnum?	A filter to return only metric streams that match the specified status. For example, the value "FIRING" returns only firing metric streams. Example: FIRING

Implements

IOciRequest