调用DiscoverEventSource探测事件源Schema与SimpleData-事件总线-阿里云

发现EventSource(例如：Mysql)的Schema和SimpleData

接口说明

探测事件源信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eventbridge:DiscoverEventSource

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
SourceMySQLParameters	object	否	MySQL 源参数
RegionId	string	否	地域 id。	cn-hangzhou
HostName	string	否	数据库连接地址	rm-xxx.mysql.rds.aliyuncs.com
Port	integer	否	数据库的连接端口。	80
DatabaseName	string	否	数据库名称	database1
TableName	string	否	数据库表名，需要添加数据库名前缀。${DatabaseName}.${TableName}	database1.table1
User	string	否	数据库用户名	user1
Password	string	否	数据库密码	1234xxx
NetworkType	string	否	网络类型。枚举值： PrivateNetwork : PrivateNetwork PublicNetwork : PublicNetwork	PrivateNetwork
VpcId	string	否	专有网络 VPC 的 ID。	vpc-uf6hwiei8u5uil3bfahc1
VSwitchIds	string	否	交换机 ID。	vsw-gw824tpaptxtlo256lqub
SecurityGroupId	string	否	安全组 ID。	sg-bp1ic0vsbwyv176e9inx
Offset	string	否	查询结果分页帧的偏移量。	30
Limit	string	否	限定每次返回的最大条数。	20

返回参数

名称	类型	描述	示例值
	object
Code	string	接口返回码： 200：表示成功。其它：表示错误码。错误码详情，请参见错误码。	Success
Data	object	返回结果。
SourceMySQLDiscovery	object	MySQL 源探测结果
DatabaseNames	array	数据库名称，格式为 JSON 数组。
	string	数据库名称	database1
TableNames	array	数据库表名
	string	数据库表名	ai_festival_gift_ranking
TableSchema	object	表格属性。
TableName	string	表名。	map
Columns	array<object>	列信息。
	object	列。
Field	string	列名。	id
IsNull	string	是否允许空值，返回值如下： YES：允许为空。 NO：不允许为空。	NO
Extra	string	备用参数。	auto_increment
Type	string	属性类型	int
Key	string	主键类型。	PRI
SimpleData	string	表格内容示例	[{\"is_active\":\"1\",\"name\":\"0c0c5d1a-e844-44a8-902d-4f62cbcb0479\",\"id\":\"21\"},{\"is_active\":\"1\",\"name\":\"18ef033e-70bb-4795-8222-6cfb54f38f26\",\"id\":\"22\"}]
ExpireLogsDays	integer	binlog 过期天数，单位：天
WaitTimeout	integer	非交互式连接的最大空闲时间，单位：秒
EstimatedRows	integer	预估行数，单位：行
Message	string	错误信息。	success
RequestId	string	阿里云为该请求生成的唯一标识符。	C7043799-F4DA-5290-9249-97C35987****
Success	boolean	操作成功返回 true。	true

示例

正常返回示例

JSON格式

{
  "Code": "Success",
  "Data": {
    "SourceMySQLDiscovery": {
      "DatabaseNames": [
        "database1"
      ],
      "TableNames": [
        "ai_festival_gift_ranking"
      ],
      "TableSchema": {
        "TableName": "map",
        "Columns": [
          {
            "Field": "id",
            "IsNull": "NO",
            "Extra": "auto_increment",
            "Type": "int",
            "Key": "PRI"
          }
        ]
      },
      "SimpleData": "[{\\\"is_active\\\":\\\"1\\\",\\\"name\\\":\\\"0c0c5d1a-e844-44a8-902d-4f62cbcb0479\\\",\\\"id\\\":\\\"21\\\"},{\\\"is_active\\\":\\\"1\\\",\\\"name\\\":\\\"18ef033e-70bb-4795-8222-6cfb54f38f26\\\",\\\"id\\\":\\\"22\\\"}]",
      "ExpireLogsDays": 0,
      "WaitTimeout": 0,
      "EstimatedRows": 0
    }
  },
  "Message": "success",
  "RequestId": "C7043799-F4DA-5290-9249-97C35987****",
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
403	ServiceNotEnable	Service not enable

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。