All Products
Search
Document Center

EventBridge:DisableRule

Last Updated:Dec 04, 2024

Disables an event rule.

Operation description

You can call this API operation to disable an event rule.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:DisableRuleupdate
*Rule
acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#EventBusName}/rule/{#RuleName}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EventBusNamestringYes

The name of the event bus.

MyEventBus
RuleNamestringYes

The name of the event rule.

tf-testacc-rule

Response parameters

ParameterTypeDescriptionExample
object
Messagestring

The returned error message.

EventRuleNotExisted
RequestIdstring

The request ID.

C36345A1-75F3-5A1A-BFCF-33B8271971FA
Codestring

The error code. The value Success indicates that the request is successful.

Success
Successboolean

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

true

Examples

Sample success responses

JSONformat

{
  "Message": "EventRuleNotExisted",
  "RequestId": "C36345A1-75F3-5A1A-BFCF-33B8271971FA",
  "Code": "Success",
  "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
2024-02-21The Error code has changedView Change Details