Options
All
  • Public
  • Public/Protected
  • All
Menu

Module ListAlarmsStatusRequest

Properties

compartmentId

compartmentId: 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`

Optional compartmentIdInSubtree

compartmentIdInSubtree: undefined | false | true

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.

Optional displayName

displayName: undefined | 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.

Optional limit

limit: undefined | 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

Optional opcRequestId

opcRequestId: undefined | string

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

Optional page

page: undefined | 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.

Optional sortBy

sortBy: SortBy

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

Example: `severity`

Optional sortOrder

sortOrder: SortOrder

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

Example: `ASC`