文档首页/ MapReduce服务 MRS/ API参考/ API V2/ 数据连接管理/ 查询数据连接列表
更新时间：2024-12-10 GMT+08:00
查看PDF
分享

查询数据连接列表

功能介绍

查询数据连接列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/data-connectors

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目编号。获取方法，请参见获取项目ID。

约束限制：

不涉及

取值范围：

只能由英文字母和数字组成，且长度为[1-64]个字符。

默认取值：

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

connector_id

否

String

参数解释：

连接ID。

约束限制：

不涉及

取值范围：

只能由英文字母、数字以及“_”和“-”组成，且长度为[1-64]个字符。

默认取值：

不涉及

source_type

否

String

参数解释：

数据源类别。

约束限制：

不涉及

取值范围：

  • RDS_POSTGRES：RDS服务PostgreSQL数据库
  • RDS_MYSQL：RDS服务MySQL数据库
  • gaussdb-mysql：云数据库GaussDB(for MySQL)

默认取值：

不涉及

connector_name

否

String

参数解释：

数据连接名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

limit

否

Integer

参数解释：

每页返回的资源个数。

约束限制：

不涉及

取值范围：

1-1000

默认取值：

不涉及

offset

否

Integer

参数解释：

分页查询起始偏移量。

约束限制：

不涉及

取值范围：

≥0

默认取值：

不涉及

available

否

Boolean

参数解释：

数据连接是否有效。

约束限制：

不涉及

取值范围：

true：连接有效

false：连接无效

默认取值：

不涉及

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释：

数据连接总数。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

data_connectors

Array of DataConnectorDetail objects

参数解释：

数据连接详情列表，请参见表4。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及
表4 DataConnectorDetail

参数

参数类型

描述

connector_name

String

参数解释：

数据连接名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

source_type

String

参数解释：

数据连接类型。

约束限制：

不涉及

取值范围：

  • RDS_POSTGRES：RDS服务PostgreSQL数据库
  • RDS_MYSQL：RDS服务MySQL数据库
  • gaussdb-mysql：云数据库GaussDB(for MySQL)

默认取值：

不涉及

source_info

String

参数解释：

数据源信息，为json格式。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

connector_id

String

参数解释：

数据连接ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

create_time

Long

参数解释：

创建时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

last_update_time

Long

参数解释：

最后更新时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

create_by

String

参数解释：

创建用户ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

create_user

String

参数解释：

创建用户名称。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

tenant_id

String

参数解释：

租户ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

last_update_by

String

参数解释：

最后更新用户ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

status

Integer

参数解释：

数据连接状态。

约束限制：

不涉及

取值范围：

  • -1：已删除
  • 0：正常
  • -2：异常
  • 1：使用中

默认取值：

不涉及

used_clusters

String

参数解释：

使用集群。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

encrypt_type

Integer

参数解释：

加密类型。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

请求示例

无

响应示例

状态码：200

查询数据连接列表成功

{
  "total_count" : 1,
  "data_connectors" : [ {
    "connector_id" : "7d169c6c-ab50-4a56-a5d2-240ca20aabda",
    "connector_name" : "test",
    "create_time" : 1681270961,
    "source_type" : "RDS_MYSQL",
    "source_info" : "{\"rds_instance_id\":\"3ce1ae8af8cd43b2bcbd18b7541bb8b0in01\",\"jdbc_url\":\"jdbc:mysql://192.XXX.XXX.XXX:3306/test?socketTimeout=60000\",\"db_name\":\"test\",\"user_name\":\"root\",\"driver_path\":\"mrs-public/dirvers/mysql-connector-java-5.1.47.jar\"}",
    "last_update_time" : 1681270961,
    "create_by" : "148c89d603e048b291f5940935b38f46",
    "create_user" : "xxx",
    "tenant_id" : "xxxxe662a7e24cc99bfc858c4558dbf6",
    "last_update_by" : "148c89d603e048b291f5940935b38f46",
    "status" : 0,
    "encrypt_type" : 2
  } ]
}

状态码

状态码请参见状态码。

错误码

请参见错误码。

父主题： 数据连接管理