Lists rules for this compartment.
GET {{baseUrl}}/rules?compartmentId={{compartment_ocid}}&limit=5&lifecycleState=ACTIVE&sortBy=ID&sortOrder=ASC
Lists rules for this compartment.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
compartmentId | string | (Required) The OCID of the compartment to which this rule belongs. | |
limit | number | The maximum number of items to return. 1 is the minimum, 50 is the maximum. | |
| Default: 10 | |||
page | 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. | |||
lifecycleState | string | A filter to return only rules that match the lifecycle state in this parameter. |
Example: Creating
|
| displayName | string | | A filter to return only rules with descriptions that match the displayName string
in this parameter.
Example: "This rule sends a notification upon completion of DbaaS backup."
|
| sortBy | string | | Specifies the attribute with which to sort the rules.
Default: timeCreated
-
TIME_CREATED: Sorts by timeCreated.
-
DISPLAY_NAME: Sorts by displayName.
-
ID: Sorts by id. | |
sortOrder| string | | Specifies sort order. -
ASC: Ascending sort order.
-
DESC: Descending sort order. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
opc-request-id | string | The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a | |
| particular request, please provide the request ID. | |||
Date | string | (Required) Current Date | |
Authorization | string | (Required) Signature Authentication on Authorization header |
RESPONSES
status: OK
[{"compartmentId":"mollit nisi","condition":"laboris incididunt","displayName":"pariatur Lorem sint mollit","id":"officia labore anim","isEnabled":true,"lifecycleState":"in ipsum cupidatat","timeCreated":"1958-03-05T09:31:52.909Z","definedTags":{},"description":"reprehenderit dolor","freeformTags":{}},{"compartmentId":"veniam amet laboris","condition":"eiusmod ut dolor consectetur","displayName":"culpa ipsum","id":"proident deserunt quis cupidatat reprehenderit","isEnabled":true,"lifecycleState":"ut enim mollit tempor","timeCreated":"2001-11-03T20:03:10.082Z","definedTags":{},"description":"aliqua est","freeformTags":{}}]