Validate Event Source Connectivity with TestEventSourceConfig API - EventBridge

Checks whether the event source configuration is active.

Operation description

You can call this operation to test an event source configuration.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eventbridge:TestEventSourceConfig

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceMySQLParameters	object	No	The parameters for the MySQL source.
RegionId	string	No	The region ID.	cn-hangzhou
HostName	string	No	The database endpoint.	rm-bp1vxxx.mysql.rds.aliyuncs.com
Port	integer	No	The port that is used to connect to the database.	80
DatabaseName	string	No	The database name.	database1
TableNames	string	No	The name of the database table. The name must be prefixed with the database name in the ${DatabaseName}.${TableName} format.	database1.table1
User	string	No	The username for the database.	user***
Password	string	No	The password for the specified username.	1234xxx
NetworkType	string	No	The network type. Valid values: PrivateNetwork : PrivateNetwork PublicNetwork : PublicNetwork	PrivateNetwork
VpcId	string	No	The VPC ID.	vpc-xxx
VSwitchIds	string	No	The vSwitch ID.	vsw-bp1gb7xxx
SecurityGroupId	string	No	The security group ID.	sg-xxx
AllowedCIDRs	string	No
SnapshotMode	string	No

Response elements

Element	Type	Description	Example
	object
Code	string	The response code. A value of Success indicates that the call was successful. For more information about other error codes, see Error codes.	Success
Data	array<object>	The returned data.
	object	A list of event streams.
CheckItem	string	The name of the check item.	CHECK_CONNECTION
ErrorMsg	string	The error message.	Connection established successfully.
IsSucceed	string	Indicates whether the check item was successfully executed.	true
Message	string	The error message.	Success
RequestId	string	The ID of the request.	FF942675-F937-549C-A942-EB94FFE28DD3
Success	boolean	Indicates whether the call was successful. If the call is successful, true is returned.	true

Examples

Success response

JSON format

{
  "Code": "Success",
  "Data": [
    {
      "CheckItem": "CHECK_CONNECTION",
      "ErrorMsg": "Connection established successfully.",
      "IsSucceed": "true"
    }
  ],
  "Message": "Success",
  "RequestId": "FF942675-F937-549C-A942-EB94FFE28DD3",
  "Success": true
}

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.