文档首页/ 数据管理服务 DAS/ API参考/ API（公测中）/ 开发工具/ 查询连接列表 - ListConnection
更新时间：2025-11-28 GMT+08:00
查看PDF
分享

查询连接列表 - ListConnection

功能介绍

查询实例连接列表。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    das::listInstances

    list

    instance

    -

    das:connections:list

    -

URI

GET /v3/{project_id}/connections

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

condition

否

String

参数解释：

数据库实例地址/实例名称/备注等关键字。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

perpage

否

Integer

参数解释：

每页记录数。

约束限制：

不涉及。

取值范围：

[0, 100]，实际取决于查询。

默认取值：

不涉及。

curpage

否

Integer

参数解释：

页码。

约束限制：

不涉及。

取值范围：

[0, 2^31-1]，实际取决于查询。

默认取值：

不涉及。

network_type

否

String

参数解释：

数据库来源类型。

约束限制：

不涉及。

取值范围：

  • rds
  • gaussdb
  • dds
  • ddm

默认取值：

不涉及

datastore_type

否

String

参数解释：

数据库引擎类型。

约束限制：

不涉及。

取值范围：

  • mysql
  • sqlserver
  • postgresql
  • taurus
  • gaussdbv5
  • mongodb
  • ddm

默认取值：

不涉及

connection_type

否

String

参数解释：

连接类型。

约束限制：

不涉及。

取值范围：

  • NORMAL：创建的连接
  • SHARE：他人共享给我的连接

默认取值：

不涉及

instance_id

否

String

参数解释：

实例ID。标识实例的唯一标识。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

请求参数

无。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

total_record

Integer

参数解释：

总记录数目。

取值范围：

不涉及。

das_conn_info_list

Array of 表4 objects

参数解释：

连接信息列表。

取值范围：

不涉及。
表4 das_conn_info_list

参数

参数类型

描述

connection_id

String

参数解释：

连接ID。

取值范围：

只能由英文字母、数字、中划线组成，且长度为36个字符的UUID。

instance_id

String

参数解释：

实例ID。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

instance_name

String

参数解释：

实例名称。

取值范围：

不涉及。

network_type

String

参数解释：

数据库来源类型。

取值范围：

  • rds
  • gaussdb
  • dds
  • ddm

engine_type

String

参数解释：

数据库引擎类型。

取值范围：

  • mysql
  • sqlserver
  • postgresql
  • taurus
  • gaussdbv5
  • mongodb
  • ddm

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

参数解释：

状态。

取值范围：

  • NORMAL：正常
  • INSTANCE_DELETE：实例删除

conn_share_type

String

参数解释：

连接类型。

取值范围：

  • NORMAL：正常连接
  • SHARE：共享连接

shared_user_name

String

参数解释：

共享人名称。

取值范围：

不涉及。

shared_user_id

String

参数解释：

共享人ID。

取值范围：

不涉及。

expired_time

Long

参数解释：

共享过期时间。

取值范围：

不涉及。

请求示例

GET https://das.cn-north-1.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/connections?condition=&curpage=0&perpage=50&network_type=&datastore_type=&connection_type=NORMAL

响应示例

状态码： 200

Success.

{
    "total_record": 1,
    "das_conn_info_list": [
        {
            "engine_type": "mysql",
            "datastore_version": "mysql 8.0.41",
            "network_type": "rds",
            "connection_id": "179e525e-0e9c-4dcc-9dd7-ee2f36121e23",
            "instance_name": "rds-9d46",
            "instance_id": "a85e88ccd82d48828eefb112076d3a92in01",
            "ip_address": "192.168.0.90",
            "port": 3306,
            "user_name": "root",
            "is_save_password": true,
            "status": "NORMAL",
            "instance_type": "Single",
            "create_at": 1762220419781,
            "conn_share_type": "NORMAL",
            "service_type": "STANDARD"
        }
    ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 开发工具

相关文档