DataConnectInstance--数据库工作台-火山引擎

文档中心

立即注册

导航

DataConnectInstance

最近更新时间：2024.10.18 16:13:50首次发布时间：2022.11.18 17:51:21

调用 DataConnectInstance 接口连接实例。

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
InstanceType	String	是	MySQL	数据库类型，当前支持的数据库如下所示： `MySQL`：云数据库 MySQL 版。 `VeDBMySQL`：云数据库 veDB MySQL 版。 `Redis`：缓存数据库 Redis 版。 `Mongo`：文档数据库 MongoDB 版。
InstanceId	String	是	mysql-ba2f323bxxxxx	实例 ID。说明您可以按需选择以下接口查询实例 ID：您可以调用 DescribeDBInstances 接口查询 MySQL 的实例 ID。调用 DescribeDBInstances 接口查询 veDB MySQL 的实例 ID。调用 DescribeDBInstance 接口查询 Redis 的实例 ID。您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 的实例 ID。
Username	String	是	test	数据库账号。说明在 `InstanceType` 设置为 `Redis` 连接 Redis 类型的实例时，该参数需设置为 `default`。
Password	String	是	password123	数据库账号密码。
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	实例连接的数据库名称。

请求示例

POST /?Action=DataConnectInstance&Version=2018-01-01 HTTP/1.1
Content-Type: application/json
Host: dbw.volcengineapi.com
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/dbw/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****
{
     "InstanceType": "MySQL",
     "InstanceId": "mysql-ba2f323bxxxxx",
     "Username": "test",
     "Password": "Password123",
     "DatabaseName": "sys",
     "KeepAliveOverTime": 10
}

返回示例

正常返回示例

{
    "ResponseMetadata" : {
        "RequestId": "202210141721010102251451520552E055",
        "Action": "DataConnectInstance",
        "Version": "2018-01-01",
        "Service": "dbw",
        "Region": "cn-beijing"
    },
 
    "Result": {
         "DatabaseName": "information_schema",
         "SessionId": "MTU4MDg1MTE1NzM5ODQ3ODg0OC8xNTgwODUxMTU3NDQ0NjIw****"
    }
}

错误码

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