调用 DataConnectInstance 接口连接实例。
同步请求。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
InstanceType | String | 是 | MySQL | 数据库类型,当前支持的数据库如下所示:
|
InstanceId | String | 是 | mysql-ba2f323bxxxxx | 实例 ID。 说明 您可以按需选择以下接口查询实例 ID:
|
Username | String | 是 | test | 数据库账号。 说明 在 |
Password | String | 是 | password123 | 数据库账号密码。 |
DatabaseName | String | 否 | sys | 实例连接的数据库名称,根据实例类型的不同,默认连接的数据库如下所示:
|
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****"
}
}
更多详情,请参见错误码。