1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
本接口(DescribeDatasourceConnection)用于查询数据源信息
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeDatasourceConnection。 |
Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DatasourceConnectionIds.N | 否 | Array of String | 连接ID列表,指定要查询的连接ID 示例值:[10001,10002] |
Filters.N | 否 | Array of Filter | 过滤条件,当前支持的过滤键为:DatasourceConnectionName(数据源连接名)。 DatasourceConnectionType (数据源连接连接类型) |
Offset | 否 | Integer | 偏移量,默认为0 示例值:0 |
Limit | 否 | Integer | 返回数量,默认20,最大值100 示例值:10 |
SortBy | 否 | String | 排序字段,支持如下字段类型,create-time(默认,创建时间)、update-time(更新时间) 示例值:create-time |
Sorting | 否 | String | 排序方式,desc表示正序,asc表示反序, 默认为desc 示例值:asc |
StartTime | 否 | String | 筛选字段:起始时间 示例值:2006-01-02 15:04:05 |
EndTime | 否 | String | 筛选字段:截止时间 示例值:2006-01-02 15:04:05 |
DatasourceConnectionNames.N | 否 | Array of String | 连接名称列表,指定要查询的连接名称 示例值:['test'] |
DatasourceConnectionTypes.N | 否 | Array of String | 连接类型,支持Mysql/HiveCos/Kafka/DataLakeCatalog 示例值:['Mysql'] |
HiveVersion.N | 否 | Array of String | 返回指定hive版本的数据源,该参数指定后,会过滤掉该参数指定版本以外的hive数据源,非hive数据源正常返回 示例值:['2.3.5'] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 数据连接总数 示例值:100 |
ConnectionSet | Array of DatasourceConnectionInfo | 数据连接对象集合 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 test
输入示例
输出示例
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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InternalError.DBError | 数据库错误。 |
InvalidParameter.DatasourceTypeError | 数据源类型错误。 |