文档首页/湖仓构建 LakeFormation/API参考/API/LakeCat类API/Connection/列举连接 - ListConnections
更新时间：2026-03-24 GMT+08:00
查看PDF
分享

列举连接 - ListConnections

功能介绍

列举连接。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /v1/{project_id}/instances/{instance_id}/connections

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

instance_id

是

String

LakeFormation实例ID。创建实例时自动生成。例如：2180518f-42b8-4947-b20b-adfc53981a25。

表2 Query参数

参数

是否必选

参数类型

描述

connection_name_pattern

否

String

连接名称通配符。只能包含中文、字母、数字和_|*.-特殊字符，且长度为1~128个字符。

limit

否

Integer

查询返回条数。默认值为10。最小值为0，最大值为1000。

marker

否

String

查询的起始记录ID。最小长度为0，最大长度为256。

reverse_page

否

Boolean

是否倒序查询。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

Array of strings

租户token。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

connections

Array of Connection objects

连接信息列表。

page_info

PagedInfo object

分页信息。

表5 Connection

参数

参数类型

描述

connection_name

String

连接名称

connection_type

String

连接类型：HIVE_METASTORE-HiveMetastore连接

connection_status

Integer

表状态，0表示正常，1表示删除中，2表示已删除，3表示恢复中，4表示清除中，5表示更新中，6表示删除失败，7表示创建中，8表示操作失败。

connection_id

String

连接ID

parameters

Map<String,String>

连接参数

description

String

描述信息

owner

String

连接所有者

owner_type

String

所有者类型：USER-用户、GROUP-组、ROLE-角色。

owner_auth_source_type

String

所有者来源：IAM-云用户、SAML-联邦、LDAP-ld用户、LOCAL-本地用户、AGENTTENANT-委托、OTHER-其它。

create_time

String

创建时间

update_time

String

修改时间

表6 PagedInfo

参数

参数类型

描述

current_count

Integer

本次返回的对象个数。最小值为0，最大值为2000。

next_marker

String

下一页查询地址。当不存在下一页，则值为null，当值为null时，响应Body无该参数。

previous_marker

String

上一页查询地址。当不存在上一页，则值为null，当值为null时，响应Body无该参数。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码：403

表9 响应Body参数

参数

参数类型

描述

error

Error object

错误信息。

error_code

String

错误码。

error_msg

String

错误描述。

title

String

标题。

表10 Error

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

title

String

标题。

message

String

错误信息。

code

String

状态码。

状态码：404

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码：408

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

状态码：500

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

solution_msg

String

解决方案描述。

请求示例

GET https://{endpoint} /v1/{project_id}/instances/{instance_id}/connections

响应示例

状态码：200

OK

{
  "connections" : [ {
    "connection_name" : "hive_connection",
    "connection_type" : "HIVE_METASTORE",
    "connection_id" : "123456",
    "parameters" : {
      "additionalProp1" : "true",
      "additionalProp2" : "true",
      "additionalProp3" : "true"
    },
    "description" : "This is a connection.",
    "owner" : "user",
    "owner_type" : "USER",
    "owner_auth_source_type" : "IAM",
    "create_time" : "2025-01-19T03:10:14.000+00:00",
    "update_time" : "2025-02-19T03:10:14.000+00:00"
  } ],
  "page_info" : {
    "current_count" : 2000,
    "next_marker" : "006f492b-xxxx",
    "previous_marker" : "003e6eba-xxxx"
  }
}

状态码：400

Bad Request

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码：404

Not Found

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

状态码：408

Request Timeout

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码：500

Internal Server Error

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

408

Request Timeout

500

Internal Server Error

错误码

请参见错误码。

父主题：Connection

相关文档