|
| 1 | +--- |
| 2 | +title: OCI Events |
| 3 | +description: Discover and manage OCI event routing rules |
| 4 | +--- |
| 5 | + |
| 6 | +import { BlockInfoCard } from "@/components/ui/block-info-card" |
| 7 | + |
| 8 | +<BlockInfoCard |
| 9 | + type="oci_events" |
| 10 | + color="#FFFFFF" |
| 11 | +/> |
| 12 | + |
| 13 | +## Usage Instructions |
| 14 | + |
| 15 | +Manage OCI Events rules using a reusable OCI API signing-key credential. List and inspect rules, create routing to existing Notifications topics, Streaming streams or Functions, update conditions and enabled states, move rules, and delete rules. Conditions match events in the rule compartment and child compartments. Updates replace supplied actions and tag maps; omit fields to retain them and use an ETag to protect concurrent changes. IAM must permit rule management and the selected action destinations. Sim limits requests to 1 MiB, responses to 8 MiB and each JSON input to 10000 values, 32 nesting levels and 1 MiB of text. This integration manages routing configuration; it does not receive events or start Sim workflows. Topic subscriptions, stream consumption and function management belong to their respective services. |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +## Actions |
| 20 | + |
| 21 | +### OCI Events List Rules |
| 22 | + |
| 23 | +List one page of OCI Events rules in a compartment |
| 24 | + |
| 25 | +#### Input |
| 26 | + |
| 27 | +| Parameter | Type | Required | Description | |
| 28 | +| --------- | ---- | -------- | ----------- | |
| 29 | +| `oauthCredential` | string | Yes | Reusable OCI API signing-key credential. | |
| 30 | +| `region` | string | No | OCI region override; omit to use the credential region. | |
| 31 | +| `opcRequestId` | string | No | Optional request identifier for OCI support correlation. | |
| 32 | +| `compartmentId` | string | Yes | Compartment OCID for listing or creating rules. | |
| 33 | +| `limit` | number | No | Maximum rules on this page: 1–50; defaults to 10. | |
| 34 | +| `page` | string | No | Opaque nextPage from the preceding list response. | |
| 35 | +| `displayName` | string | No | Rule display name; list operations apply the OCI displayName filter. | |
| 36 | +| `lifecycleState` | string | No | Filter: CREATING, ACTIVE, INACTIVE, UPDATING, DELETING, DELETED or FAILED. | |
| 37 | +| `sortBy` | string | No | Sort field: TIME_CREATED, ID or DISPLAY_NAME. | |
| 38 | +| `sortOrder` | string | No | Sort direction: ASC or DESC. | |
| 39 | + |
| 40 | +#### Output |
| 41 | + |
| 42 | +| Parameter | Type | Description | |
| 43 | +| --------- | ---- | ----------- | |
| 44 | +| `status` | number | OCI HTTP response status | |
| 45 | +| `opcRequestId` | string | OCI request identifier | |
| 46 | +| `rules` | array | One page of rule summaries; actions require Get Rule | |
| 47 | +| `nextPage` | string | Opaque continuation token | |
| 48 | + |
| 49 | +### OCI Events Get Rule |
| 50 | + |
| 51 | +Get an OCI Events rule with its actions and ETag |
| 52 | + |
| 53 | +#### Input |
| 54 | + |
| 55 | +| Parameter | Type | Required | Description | |
| 56 | +| --------- | ---- | -------- | ----------- | |
| 57 | +| `oauthCredential` | string | Yes | Reusable OCI API signing-key credential. | |
| 58 | +| `region` | string | No | OCI region override; omit to use the credential region. | |
| 59 | +| `opcRequestId` | string | No | Optional request identifier for OCI support correlation. | |
| 60 | +| `ruleId` | string | Yes | Rule OCID, from List Rules or a previous rule response. | |
| 61 | + |
| 62 | +#### Output |
| 63 | + |
| 64 | +| Parameter | Type | Description | |
| 65 | +| --------- | ---- | ----------- | |
| 66 | +| `status` | number | OCI HTTP response status | |
| 67 | +| `opcRequestId` | string | OCI request identifier | |
| 68 | +| `rule` | json | Rule configuration including its actions | |
| 69 | +| `etag` | string | ETag for conditional updates, moves or deletion | |
| 70 | + |
| 71 | +### OCI Events Create Rule |
| 72 | + |
| 73 | +Create an OCI Events rule routing matching events to existing action resources |
| 74 | + |
| 75 | +#### Input |
| 76 | + |
| 77 | +| Parameter | Type | Required | Description | |
| 78 | +| --------- | ---- | -------- | ----------- | |
| 79 | +| `oauthCredential` | string | Yes | Reusable OCI API signing-key credential. | |
| 80 | +| `region` | string | No | OCI region override; omit to use the credential region. | |
| 81 | +| `opcRequestId` | string | No | Optional request identifier for OCI support correlation. | |
| 82 | +| `compartmentId` | string | Yes | Compartment OCID for listing or creating rules. | |
| 83 | +| `displayName` | string | Yes | Rule display name; list operations apply the OCI displayName filter. | |
| 84 | +| `description` | string | No | Rule description, up to 1024 characters. An explicit empty string clears it on update. | |
| 85 | +| `isEnabled` | boolean | Yes | Whether the rule is enabled. Omit on update to keep the current state. | |
| 86 | +| `condition` | json | Yes | JSON filter object, for example \{"eventType":"com.oraclecloud.objectstorage.createbucket"\}. Explicit \{\} matches all compartment and child-compartment events. Replaces the condition on update. | |
| 87 | +| `actions` | json | Yes | Array of 1–10 actions. Each requires actionType, isEnabled and topicId \(ONS\), streamId \(OSS\) or functionId \(FAAS\); description is optional. Replaces all actions on update. No action IDs or lifecycle fields. | |
| 88 | +| `freeformTags` | json | No | Map of tag names to string values. Replaces all freeform tags on update; \{\} clears them. | |
| 89 | +| `definedTags` | json | No | Map of tag namespaces to tag-name/string-value maps. Replaces defined tags on update; \{\} clears them. | |
| 90 | +| `opcRetryToken` | string | No | Optional stable retry token, 1–64 characters. Reuse for retries of the same create or move request. | |
| 91 | + |
| 92 | +#### Output |
| 93 | + |
| 94 | +| Parameter | Type | Description | |
| 95 | +| --------- | ---- | ----------- | |
| 96 | +| `status` | number | OCI HTTP response status | |
| 97 | +| `opcRequestId` | string | OCI request identifier | |
| 98 | +| `rule` | json | Rule configuration including its actions | |
| 99 | +| `etag` | string | ETag for conditional updates, moves or deletion | |
| 100 | + |
| 101 | +### OCI Events Update Rule |
| 102 | + |
| 103 | +Update rule settings and replace supplied conditions, actions or tags |
| 104 | + |
| 105 | +#### Input |
| 106 | + |
| 107 | +| Parameter | Type | Required | Description | |
| 108 | +| --------- | ---- | -------- | ----------- | |
| 109 | +| `oauthCredential` | string | Yes | Reusable OCI API signing-key credential. | |
| 110 | +| `region` | string | No | OCI region override; omit to use the credential region. | |
| 111 | +| `opcRequestId` | string | No | Optional request identifier for OCI support correlation. | |
| 112 | +| `ruleId` | string | Yes | Rule OCID, from List Rules or a previous rule response. | |
| 113 | +| `displayName` | string | No | Rule display name; list operations apply the OCI displayName filter. | |
| 114 | +| `description` | string | No | Rule description, up to 1024 characters. An explicit empty string clears it on update. | |
| 115 | +| `isEnabled` | boolean | No | Whether the rule is enabled. Omit on update to keep the current state. | |
| 116 | +| `condition` | json | No | JSON filter object, for example \{"eventType":"com.oraclecloud.objectstorage.createbucket"\}. Explicit \{\} matches all compartment and child-compartment events. Replaces the condition on update. | |
| 117 | +| `actions` | json | No | Array of 1–10 actions. Each requires actionType, isEnabled and topicId \(ONS\), streamId \(OSS\) or functionId \(FAAS\); description is optional. Replaces all actions on update. No action IDs or lifecycle fields. | |
| 118 | +| `freeformTags` | json | No | Map of tag names to string values. Replaces all freeform tags on update; \{\} clears them. | |
| 119 | +| `definedTags` | json | No | Map of tag namespaces to tag-name/string-value maps. Replaces defined tags on update; \{\} clears them. | |
| 120 | +| `ifMatch` | string | No | ETag from Get Rule; mutation fails if the rule changed since that read. | |
| 121 | + |
| 122 | +#### Output |
| 123 | + |
| 124 | +| Parameter | Type | Description | |
| 125 | +| --------- | ---- | ----------- | |
| 126 | +| `status` | number | OCI HTTP response status | |
| 127 | +| `opcRequestId` | string | OCI request identifier | |
| 128 | +| `rule` | json | Rule configuration including its actions | |
| 129 | +| `etag` | string | ETag for conditional updates, moves or deletion | |
| 130 | + |
| 131 | +### OCI Events Delete Rule |
| 132 | + |
| 133 | +Delete an OCI Events rule, optionally matching an ETag |
| 134 | + |
| 135 | +#### Input |
| 136 | + |
| 137 | +| Parameter | Type | Required | Description | |
| 138 | +| --------- | ---- | -------- | ----------- | |
| 139 | +| `oauthCredential` | string | Yes | Reusable OCI API signing-key credential. | |
| 140 | +| `region` | string | No | OCI region override; omit to use the credential region. | |
| 141 | +| `opcRequestId` | string | No | Optional request identifier for OCI support correlation. | |
| 142 | +| `ruleId` | string | Yes | Rule OCID, from List Rules or a previous rule response. | |
| 143 | +| `ifMatch` | string | No | ETag from Get Rule; mutation fails if the rule changed since that read. | |
| 144 | + |
| 145 | +#### Output |
| 146 | + |
| 147 | +| Parameter | Type | Description | |
| 148 | +| --------- | ---- | ----------- | |
| 149 | +| `status` | number | OCI HTTP response status | |
| 150 | +| `opcRequestId` | string | OCI request identifier | |
| 151 | + |
| 152 | +### OCI Events Change Rule Compartment |
| 153 | + |
| 154 | +Move an OCI Events rule to another compartment in the same tenancy |
| 155 | + |
| 156 | +#### Input |
| 157 | + |
| 158 | +| Parameter | Type | Required | Description | |
| 159 | +| --------- | ---- | -------- | ----------- | |
| 160 | +| `oauthCredential` | string | Yes | Reusable OCI API signing-key credential. | |
| 161 | +| `region` | string | No | OCI region override; omit to use the credential region. | |
| 162 | +| `opcRequestId` | string | No | Optional request identifier for OCI support correlation. | |
| 163 | +| `ruleId` | string | Yes | Rule OCID, from List Rules or a previous rule response. | |
| 164 | +| `destinationCompartmentId` | string | Yes | Destination compartment OCID in the same tenancy; moving changes event matching scope. | |
| 165 | +| `ifMatch` | string | No | ETag from Get Rule; mutation fails if the rule changed since that read. | |
| 166 | +| `opcRetryToken` | string | No | Optional stable retry token, 1–64 characters. Reuse for retries of the same create or move request. | |
| 167 | + |
| 168 | +#### Output |
| 169 | + |
| 170 | +| Parameter | Type | Description | |
| 171 | +| --------- | ---- | ----------- | |
| 172 | +| `status` | number | OCI HTTP response status | |
| 173 | +| `opcRequestId` | string | OCI request identifier | |
| 174 | + |
| 175 | + |
0 commit comments