All Products
Search
Document Center

EventBridge:UpdateRule

Last Updated:Mar 15, 2024

Updates the configurations of an event rule.

Operation description

You can call this API operation to update the configurations of an event rule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
eventbridge:UpdateRuleWrite
  • Rule
    acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#eventbusId}/rule/{#ruleId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EventBusNamestringYes

The name of the event bus.

hw-test
DescriptionstringNo

The description of the event bus.

demo
RuleNamestringYes

The name of the event rule.

tf-testacc-rule
StatusstringNo

The status of the event rule. Valid values: ENABLE: The event rule is enabled. It is the default state of the event rule. DISABLE: The event rule is disabled.

ENABLE
FilterPatternstringYes

The event pattern, in JSON format. Valid values: stringEqual stringExpression Each field can have a maximum of five expressions in the map data structure.

Each field can have a maximum of five expressions in the map data structure.

{\"source\":[\"acs.oss\"],\"type\":[\"oss:BucketQueried:GetBucketStat\"]}

Response parameters

ParameterTypeDescriptionExample
object
Messagestring

The error message that is returned if the request failed.

EventRuleFilterPatternSchemaError
RequestIdstring

The request ID.

7439944D-D9FC-5614-B65E-07A468988924
Databoolean

The result of the operation.

true
Codestring

The status code returned. The status code 200 indicates that the request was successful.

200
Successboolean

Indicates whether the operation is successful. Valid values: true and false.

true

Examples

Sample success responses

JSONformat

{
  "Message": "EventRuleFilterPatternSchemaError",
  "RequestId": "7439944D-D9FC-5614-B65E-07A468988924",
  "Data": true,
  "Code": "200",
  "Success": true
}

Error codes

HTTP status codeError codeError message
403ServiceNotEnableService not enable

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history