查询实例连接列表
功能介绍
查询实例连接列表。
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/list-connections
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 租户在某一Region下的项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
condition |
否 |
String |
参数解释: 数据库实例地址/实例名称/备注等关键字。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
offset |
否 |
Integer |
参数解释: 索引位置,偏移量。从第一条数据偏移offset条数据后开始查询。例如:该参数指定为1,limit指定为10,则只展示第2~11条数据。 约束限制: 不涉及。 取值范围: [0, 2^31-1] 默认取值: 默认为0(偏移0条数据,表示从第一条数据开始查询)。 |
limit |
否 |
Integer |
参数解释: 查询记录数。例如该参数设定为10,则查询结果最多只显示10条记录。 约束限制: 不涉及。 取值范围: [1, 200] 默认取值: 100。 |
network_type |
否 |
String |
参数解释: 数据库来源类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及 |
datastore_type |
否 |
String |
参数解释: 数据库引擎类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及 |
connection_type |
否 |
String |
参数解释: 连接类型。 约束限制: 不涉及。 取值范围:
默认取值: 不涉及 |
instance_id |
否 |
String |
参数解释: 实例ID。标识实例的唯一标识。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
请求参数
无。
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
total_record |
Integer |
参数解释: 总记录数目。 取值范围: 不涉及。 |
das_conn_info_list |
Array of 表4 objects |
参数解释: 连接信息列表。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
connection_id |
String |
参数解释: 连接ID。 取值范围: 只能由英文字母、数字、中划线组成,且长度为36个字符的UUID。 |
instance_id |
String |
参数解释: 实例ID。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 |
instance_name |
String |
参数解释: 实例名称。 取值范围: 不涉及。 |
network_type |
String |
参数解释: 数据库来源类型。 取值范围:
|
engine_type |
String |
参数解释: 数据库引擎类型。 取值范围:
|
datastore_version |
String |
参数解释: 数据库版本。 取值范围: 不涉及。 |
user_name |
String |
参数解释: 用户名。 取值范围: 不涉及。 |
database_name |
String |
参数解释: 数据库名称。 取值范围: 不涉及。 |
is_save_password |
Boolean |
参数解释: 是否保存密码。 取值范围: 不涉及。 |
ip_address |
String |
参数解释: IP地址。 取值范围: 不涉及。 |
port |
Integer |
参数解释: 端口号。 取值范围: [1,65536] |
remarks |
String |
参数解释: 备注。 取值范围: 不涉及。 |
create_at |
Long |
参数解释: 连接的创建时间。 取值范围: 不涉及。 |
status |
String |
参数解释: 状态。 取值范围:
|
conn_share_type |
String |
参数解释: 连接类型。 取值范围:
|
shared_user_name |
String |
参数解释: 共享人名称。 取值范围: 不涉及。 |
shared_user_id |
String |
参数解释: 共享人ID。 取值范围: 不涉及。 |
expired_time |
Long |
参数解释: 共享过期时间。 取值范围: 不涉及。 |
请求示例
查询实例连接列表。
GET https://das.cn-north-7.myhuaweicloud.com/v3/052041494800d57c2f02c00275b4c247/list-connections?curpage=0&perpage=50&connectionType=NORMAL
响应示例
状态码: 200
Success.
{ "total_record" : 1, "das_conn_info_list" : [ { "engine_type" : "mysql", "datastore_version" : "mysql 5.7.44", "network_type" : "rds", "connection_id" : "bcca4e8e-f0d8-4f96-b359-393a66d29c09", "instance_name" : "rds-mysql-2502", "instance_id" : "364a5d0498974d459782975e8b65bc13in01", "ip_address" : "192.168.0.204", "port" : 3306, "user_name" : "root", "is_save_password" : true, "status" : "NORMAL", "create_at" : 1738745756479, "conn_share_type" : "NORMAL" } ] }
状态码
状态码 |
描述 |
---|---|
200 |
Success. |
400 |
Client error. |
500 |
Server error. |
错误码
请参见错误码。