创建实例连接
功能介绍
创建实例连接。
调试
您可以在API Explorer中调试该接口。
URI
POST /v3/{project_id}/instances/{instance_id}/create-connection
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
instance_id |
是 |
String |
参数解释: 实例ID。标识实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
engine_type |
是 |
String |
参数解释: 数据库引擎类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
network_type |
是 |
String |
参数解释: 数据库来源类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及。 |
username |
是 |
String |
参数解释: 用户名。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
is_save_password |
是 |
Boolean |
参数解释: 是否保存密码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
password |
是 |
String |
参数解释: 密码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
node_ids |
否 |
Array of strings |
参数解释: 节点ID。标识实例节点的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
remarks |
否 |
String |
参数解释: 备注。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
port |
否 |
Integer |
参数解释: 端口。 约束限制: 不涉及。 取值范围: [1,65536] 默认取值: 不涉及。 |
database_name |
否 |
String |
参数解释: 数据库名字。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
sql_record_flag |
否 |
Boolean |
参数解释: sql记录开关。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
connection_id |
String |
参数解释: 连接ID。 取值范围: 只能由英文字母、数字、中划线组成,且长度为36个字符的UUID。 |
请求示例
创建实例连接。
POST https://das.cn-north-7.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/instances/bcfa975193f1402fa11a6d4fd6baf5fbin01/create-connection { "engine_type" : "mysql", "network_type" : "rds", "username" : "root", "is_save_password" : true, "password" : "Gauss_2345", "sql_record_flag" : true, "remarks" : "create by api" }
响应示例
状态码: 200
Success.
{ "connection_id" : "99af0766-c3f4-4e4e-a95e-14a1b070188e" }
状态码
状态码 |
描述 |
---|---|
200 |
Success. |
400 |
Client error. |
500 |
Server error. |
错误码
请参见错误码。