DeleteTargets - EventBridge - Alibaba Cloud Documentation Center

Deletes one or more event targets of an event rule.

Operation description

You can call this API operation to delete one or more event targets 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
eventbridge:DeleteTargets	Write	Rule acs:eventbridge:{#regionId}:{#accountId}:eventbus/{#eventbusId}/rule/{#ruleId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
EventBusName	string	Yes	The name of the event bus.	MyEventBus
RuleName	string	Yes	The name of the event rule.	ramrolechange-mns
TargetIds	array	No	The IDs of the event targets that you want to delete.
	string	No	The ID of the event target. Note: You can call the GetRule operation to query the IDs of event targets.	12

Sample request: `POST /openapi/deleteTargets HTTP/1.1 Host: 123456789098****.eventbridge.cn-hangzhou.aliyuncs.com Date: Sat, 18 Apr 2020 05:30:41 GMT x-eventbridge-version: 2020-04-01 Authorization: acs vZ3VL0SuJdHi****:Jo2PbT*****4azYAYoYslKLvWzg= Content-type: application/json;charset=UTF-8 Content-Length: 26

{ "EventBusName":"default", "RuleName":"myRule", "TargetIds": [ "targetId1", "targetId2" ] }`

Response parameters

Parameter	Type	Description	Example
	object
Message	string	The returned error message.	EventBusNotExist
RequestId	string	The request ID.	78FA9EAC-F0C0-58B0-871E-9F9756CE1D29
Data	object	The returned data.
ErrorEntriesCount	integer	The number of event bodies that failed to be processed. Valid values: 0: No event bodies failed to be processed. An integer other than 0: the number of event bodies that failed to be processed.	0
ErrorEntries	object []	The information about the event body that failed to be processed.
ErrorMessage	string	The returned error message.	The id of event target is duplicate!
ErrorCode	string	The returned error code.	EventRuleTargetIdDuplicate
EntryId	string	The ID of the event body that failed to be processed.	target5
Code	string	The returned HTTP status code. The HTTP status code 200 indicates that the request is successful.	200
Success	boolean	Indicates whether the operation is successful. Valid values: true and false.	true

Examples

Sample success responses

JSONformat

{
  "Message": "EventBusNotExist",
  "RequestId": "78FA9EAC-F0C0-58B0-871E-9F9756CE1D29",
  "Data": {
    "ErrorEntriesCount": 0,
    "ErrorEntries": [
      {
        "ErrorMessage": "The id of event target is duplicate!",
        "ErrorCode": "EventRuleTargetIdDuplicate",
        "EntryId": "target5"
      }
    ]
  },
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
403	ServiceNotEnable	Service not enable

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