文档首页/数据复制服务 DRS/API参考/API v5（公测中）/连接管理/查询连接列表 - ListConnections
更新时间：2025-12-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询连接列表 - ListConnections

功能介绍

查询连接列表，可根据连接类型进行查询。

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/connections

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一Region下的Project ID。

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

表2 Query参数

参数

是否必选

参数类型

描述

connection_id

否

String

连接ID。

db_type

否

String

连接类型。

  • mysql
  • oracle
  • postgresql
  • mongodb

name

否

String

连接名称，忽略大小写。

inst_id

否

String

云上数据库实例ID。

ip

否

String

连接IP。

description

否

String

连接描述。

create_time

否

String

时间区间用“，”分隔。示例：2024-05-17T07:46:00.414Z,2024-05-20T07:46:00.999Z。

enterprise_project_id

否

String

企业项目ID。

offset

否

Integer

偏移量，默认值为0，表示查询该偏移量后面的记录。

limit

否

Integer

查询返回记录的数量限制.默认值为10。

fetch_all

否

Boolean

值为“true”时会使得offset和limit参数失效并返回所有记录。

sort_key

否

String

返回结果按该关键字排序，默认为“created_at”。

sort_dir

否

String

降序或升序（分别对应desc和asc，默认为“desc”）。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

是

String

发送的实体的MIME类型。推荐用户默认使用application/json，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。

X-Auth-Token

是

String

从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Language

否

String

请求语言类型。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

connections

Array of ConnectionResp objects

连接信息列表。

count

Integer

列表中的项目总数，与分页无关。

表5 ConnectionResp

参数

参数类型

描述

connection_id

String

连接ID。

name

String

连接名称。

create_time

Long

连接创建时间，格式为时间戳。

db_type

String

连接类型。

config

ConnectionConfig object

连接的配置项。

endpoint

BaseEndpoint object

数据库基本信息。

vpc

CloudVpcInfo object

数据库实例所在VPC，子网，安全组等信息。

ssl

EndpointSslConfig object

数据库SSL证书信息。

enterprise_project_id

String

企业项目ID。

description

String

描述。

表6 ConnectionConfig

参数

参数类型

描述

driver_name

String

驱动程序名称。

表7 BaseEndpoint

参数

参数类型

描述

id

String

数据库信息ID。

endpoint_name

String

数据库场景类型。取值：

  • oracle：云下自建Oracle数据库。
  • ecs_oracle：华为云ECS自建Oracle数据库。
  • cloud_gaussdbv5：华为云数据库GaussDB分布式。
  • mysql：他云/本地自建MySQL数据库。
  • ecs_mysql：华为云ECS自建MySQL数据库。
  • cloud_mysql：华为云数据库RDS for MySQL。
  • redis：云下自建Redis数据。
  • ecs_redis：华为云ECS自建Redis数据。
  • rediscluster：云下自建Redis集群数据库。
  • ecs_rediscluster：华为云ECS自建Redis集群数据库。
  • cloud_gaussdb_redis：华为云数据库GeminiDB Redis。
  • postgresql: 云下自建PostgreSQL数据库。
  • ecs_postgresql: 华为云ECS自建PostgreSQL数据库。
  • cloud_postgresql: 华为云数据库RDS for PostgreSQL。
  • mongodb: 云下自建MongoDB数据库。
  • ecs_mongodb: 华为云ECS自建MongoDB数据库。
  • cloud_mongodb: 华为云文档数据库服务DDS。

ip

String

数据库IP。约束：- 数据库为自建MongoDB时，数据库IP与端口之间用“:”英文冒号拼接，多个值之间请用“,”英文逗号隔开，最多支持填写3个IP地址或域名。- 数据库为DDS实例时，数据库IP与端口之间用“:”英文冒号拼接，多个IP端口之间请用“,”英文逗号分隔。- 数据库为Redis集群时，请填写源端Redis集群所有分片的IP地址和对应端口，数据库IP与端口之间用“:”英文冒号拼接，多个IP端口之间请用“,”英文逗号分隔，并且推荐填写集群分片的Slave节点的IP地址。最多支持填写32个IP地址或域名，多个值之间请用英文逗号隔开。示例：- MySQL：ip- MongoDB：ip:port,ip:port,ip:port- DDS：ip:port,ip:port - Redis集群：ip:port,ip:port

db_port

String

数据库端口。

约束：输入范围为1-65535之间的整数。

db_user

String

数据库用户名。

db_password

String

数据库密码。

instance_id

String

华为云数据库实例ID。

instance_name

String

华为云数据库实例名称。

db_name

String

指定数据库名称。例如：

  • oracle：serviceName.orcl。

source_sharding

Array of BaseEndpoint objects

物理源库信息。

表8 CloudVpcInfo

参数

参数类型

描述

vpc_id

String

数据库实例所在的虚拟私有云ID，获取方法如下：

方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。

方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询VPC列表。

subnet_id

String

数据库实例所在子网ID，获取方法如下：

方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。

方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。

security_group_id

String

数据库实例所在的安全组ID，获取方法如下：

方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。

方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询安全组列表。

表9 EndpointSslConfig

参数

参数类型

描述

ssl_link

Boolean

是否SSL安全连接。如果数据库启用了SSL安全连接，参数值为true。

ssl_cert_name

String

SSL证书名字。

ssl_cert_key

String

SSL证书内容，用base64加密。

ssl_cert_check_sum

String

SSL证书内容checksum值，后端校验，源库安全连接必选。

ssl_cert_password

String

SSL证书密码，证书文件后缀为.p12时必填。

状态码：400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

查询连接列表示例。

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/connections?name=&ip=&type=&offset=0&limit=10&connection_id=75e4f531-13ff-48c7-bb2f-eb743e5fe26d

响应示例

状态码：200

OK

{
  "connections" : [ {
    "name" : "DRS-mysql",
    "db_type" : "mysql",
    "endpoint" : {
      "endpoint_name" : "mysql",
      "ip" : "127.0.0.1",
      "db_port" : "3306",
      "db_user" : "root"
    },
    "description" : "description",
    "connection_id" : "835e1d79-24ac-411d-a1c8-22c000280659",
    "ssl" : {
      "ssl_link" : false
    },
    "create_time" : 1716879012121,
    "enterprise_project_id" : "0"
  } ],
  "count" : 1
}

状态码：400

Bad Request

{
  "error_code" : "DRS.10000001",
  "error_msg" : "Failed."
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题：连接管理