Checks whether the event source configuration is active.
Operation description
You can call this operation to test an event source configuration.
Try it now
Test
RAM authorization
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 |
| 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 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Code |
string |
The response code.
|
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.