文档中心

数据库工作台

实例接入

DataConnectInstance

DataConnectInstance

调用 DataConnectInstance 接口连接实例。

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
InstanceType	String	是	MySQL	数据库类型，当前支持的数据库如下所示： MySQL：云数据库 MySQL 版。 VeDBMySQL：云数据库 veDB MySQL 版。 Redis：缓存数据库 Redis 版。 Mongo：文档数据库 MongoDB 版。
MongoNodeId	String	是	mongo-shard-aec0d9c2****-0	MongoDB 的节点 ID。说明仅当 InstanceType 设置为 Mongo 时，才需要配置 MongoNodeId 参数。
InstanceId	String	是	mysql-ba2f323b*****	实例 ID。说明您可以按需选择以下接口查询实例 ID：您可以调用 DescribeDBInstances 接口查询 MySQL 的实例 ID。调用 DescribeDBInstances 接口查询 veDB for MySQL 的实例 ID。调用 DescribeDBInstance 接口查询 Redis 的实例 ID。您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 的实例 ID。
Username	String	是	test	数据库账号。说明在 InstanceType 设置为 Redis 连接 Redis 类型的实例时，该参数需设置为 default。若调用 EnableInstanceManagement 接口或在 DBW 控制台为数据库实例开启了安全管控，则无需传入该参数。若在 DBW 控制台的 SQL 窗口登录数据库实例选择了记住密码，则无需传入该参数。
Password	String	是	password123	数据库账号密码。说明若调用 EnableInstanceManagement 接口或在 DBW 控制台为数据库实例开启了安全管控，则无需传入该参数。若在 DBW 控制台的 SQL 窗口登录数据库实例选择了记住密码，则无需传入该参数。
DatabaseName	String	否	sys	实例连接的数据库名称，根据实例类型的不同，默认连接的数据库如下所示：云数据库 MySQL 版：默认连接 information_schema 数据库。云数据库 veDB MySQL 版：默认连接 information_schema 数据库。缓存数据库 Redis 版：默认连接 DB0 数据库。文档数据库 MongoDB 版：默认连接 admin 数据库。
KeepAliveOverTime	Integer	否	10	会话超时时间，单位：秒（s），默认为 1800 秒。

返回参数

名称	类型	示例值	描述
SessionId	string	MTU4MDg1MTE1NzM5ODQ3ODg0OC8xNTgwODUxMTU3NDQ0NjIw****	会话 ID。
DatabaseName	string	information_schema	实例连接的数据库名称。

请求示例

返回示例

正常返回示例如下。

错误码

更多详情，请参见错误码。

最近更新时间：2026.01.29 18:14:55

这个页面对您有帮助吗？

有用

有用

无用

无用