数据湖计算 DLC 查询用户vpc连接信息

1. 接口描述

接口请求域名： dlc.tencentcloudapi.com 。

查询用户vpc到引擎网络的连接

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeUserVpcConnection。
Version	是	String	公共参数，本接口取值：2021-01-25。
Region	是	String	公共参数，详见产品支持的地域列表。
EngineNetworkId	是	String	引擎网络ID 示例值：DataEngine-Network-xxx
DataEngineIds.N	否	Array of String	引擎ID集合示例值：["DataEngine-mjmxxx"]
UserVpcEndpointIds.N	否	Array of String	终端节点ID集合示例值：["vpce-h4czuhxx"]

3. 输出参数

参数名称	类型	描述
UserVpcConnectionInfos	Array of UserVpcConnectionInfo	用户vpc连接信息注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询用户连接信息

查询用户连接信息

输入示例

POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserVpcConnection
<公共请求参数>

{
    "EngineNetworkId": "DataEngine-Network-xxx"
}

输出示例

{
    "Response": {
        "RequestId": "ac4fff9d-b8a8-429c-88fb-c9cfaac1ec5a",
        "UserVpcConnectionInfos": [
            {
                "AccessConnectionInfos": [
                    "jdbc:hive2://10.0.0.14:10009/?kyuubi.engine.type=TRINO;kyuubi.session.engine.trino.connection.url=http://127.0.0.1:8080;kyuubi.session.engine.trino.connection.catalog=hive;kyuubi.operation.incremental.collect=true",
                    "jdbc:presto://10.0.0.14:10999/?sessionProperties=cluster:keyiliu_presto;region:{Region};database:{DatabaseName};catalog:hive&extraCredentials=secretkey:{SecretKey};secretid:{SecretId}"
                ],
                "UserVpcEndpointId": "vpce-7m3bgkj4",
                "UserVpcEndpointName": "rickytest",
                "UserVpcId": "vpc-dk19yfij"
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InternalError.DBError	数据库错误。
InvalidParameter	参数错误。

查询用户vpc连接信息

本页目录：