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 示例值：["datasource-testid1","datasource-testid2"] |
| 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 | 连接名称列表，指定要查询的连接名称 示例值：['name'] |
| 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
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDatasourceConnection
<公共请求参数>
{
"DatasourceConnectionIds": [
"f329n1"
],
"Filters": [
{
"Name": "filter",
"Values": [
"normal"
]
}
],
"Offset": 0,
"Limit": 0,
"SortBy": "time",
"Sorting": "desc",
"StartTime": "2006-01-02 15:04:05",
"EndTime": "2006-01-02 15:04:05",
"DatasourceConnectionNames": [
"connection_1"
],
"DatasourceConnectionTypes": [
"connection_1"
],
"HiveVersion": [
"2.1.1"
]
}输出示例
{
"Response": {
"TotalCount": 0,
"ConnectionSet": [
{
"Id": 0,
"DatasourceConnectionId": "datasourceId",
"DatasourceConnectionName": "datasourceName",
"DatasourceConnectionDesc": "desc",
"DatasourceConnectionType": "noraml",
"DatasourceConnectionConfig": {
"Mysql": {
"JdbcUrl": "jdbc://xxxx:3306",
"User": "userName",
"Password": "sMKind1",
"Location": {
"VpcId": "g5i12",
"VpcCidrBlock": "jk09",
"SubnetId": "netJ098",
"SubnetCidrBlock": "subnet109"
},
"DbName": "dev",
"InstanceId": "instance2",
"InstanceName": "instanceName"
},
"Hive": {
"MetaStoreUrl": "jdbc://xxxmetasotre:3306",
"Type": "normal",
"User": "admin",
"HighAvailability": true,
"BucketUrl": "ins-1vogaxgk",
"HdfsProperties": "hdfs",
"Location": {
"VpcId": "JO21Ijk",
"VpcCidrBlock": "vpc908",
"SubnetId": "sub1",
"SubnetCidrBlock": "subblock1"
},
"Mysql": {
"JdbcUrl": "ins-1vogaxgk",
"Password": "admin",
"Location": {
"VpcId": "877d6fb03",
"VpcCidrBlock": "77d6fb03",
"SubnetId": "3c140219",
"SubnetCidrBlock": "b241-90"
},
"DbName": "db1",
"InstanceId": "3c103",
"InstanceName": "417d6fb03"
},
"InstanceId": "77d6fb03",
"InstanceName": "7d6fb03",
"HiveVersion": "2.1.1",
"KerberosInfo": {
"Krb5Conf": "config",
"KeyTab": "_t",
"ServicePrincipal": "3c1403"
},
"KerberosEnable": true
},
"Kafka": {
"InstanceId": "3c140219"
},
"OtherDatasourceConnection": {
"Location": {
"VpcId": "3c14b03",
"VpcCidrBlock": "d6fb03",
"SubnetId": "d8981h",
"SubnetCidrBlock": "s8u1d"
}
},
"PostgreSql": {
"InstanceId": "3c103",
"InstanceName": "0000154cb-10",
"JdbcUrl": "xxx.tencentcloudapi.com",
"User": "admin",
"Password": "user",
"DbName": "db1",
"Location": {
"VpcId": "vpc_h98f1",
"VpcCidrBlock": "vpc_851",
"SubnetId": "subnet_9hv48h7",
"SubnetCidrBlock": "block_129fu2"
}
},
"SqlServer": {
"InstanceId": "instance_v984r",
"InstanceName": "instance_v49n",
"JdbcUrl": "xxx.tencentcloudapi.com",
"User": "admin",
"Password": "password",
"DbName": "db1"
},
"ClickHouse": {
"InstanceId": "instance_vn491",
"InstanceName": "instacen_v49r",
"JdbcUrl": "xxx.tencentcloudapi.com",
"User": "user",
"Password": "password",
"DbName": "db1",
"Location": {
"VpcId": "vpc_v498n",
"VpcCidrBlock": "block_vj489",
"SubnetId": "subnet_c948",
"SubnetCidrBlock": "cidr_c39n"
}
},
"Elasticsearch": {
"InstanceId": "instance_c49n",
"InstanceName": "instance_m4c9",
"User": "user",
"Password": "password",
"DbName": "db1",
"Location": {
"VpcId": "vpc_12em0",
"VpcCidrBlock": "block_49n",
"SubnetId": "subnet_c4n9n",
"SubnetCidrBlock": "block_c49un"
},
"ServiceInfo": [
{
"Ip": "127.0.0.1",
"Port": 0
}
]
},
"TCHouseD": {
"InstanceId": "instance_n59",
"InstanceName": "instance_v49",
"JdbcUrl": "xxx.tencentcloudapi.com",
"User": "admin",
"Password": "password",
"DbName": "db1",
"Location": {
"VpcId": "vpc_d92n",
"VpcCidrBlock": "cird_vm390",
"SubnetId": "subnet_1d09",
"SubnetCidrBlock": "block_v49j"
}
},
"TDSQLPostgreSql": {
"InstanceId": "instance_n59",
"InstanceName": "instance_v49",
"JdbcUrl": "xxx.tencentcloudapi.com",
"User": "admin",
"Password": "password",
"DbName": "db1",
"Location": {
"VpcId": "vpc_d92n",
"VpcCidrBlock": "cird_vm390",
"SubnetId": "subnet_1d09",
"SubnetCidrBlock": "block_v49j"
}
}
},
"State": 0,
"Region": "shanghai",
"AppId": "3jc9839n94n",
"CreateTime": "2006-01-02 15:04:05",
"UpdateTime": "2006-01-02 15:04:05",
"Message": "success",
"DataEngines": [
{
"DataEngineName": "engine_nuf1n9",
"QuotaId": "quota_1j918",
"EngineType": "normal",
"ClusterType": "cluster_1",
"State": 0,
"CreateTime": 0,
"UpdateTime": 0,
"Size": 0,
"Mode": 0,
"MinClusters": 0,
"MaxClusters": 0,
"AutoResume": true,
"SpendAfter": 0,
"CidrBlock": "cidr_dm1oi",
"DefaultDataEngine": true,
"Message": "success",
"DataEngineId": "engine_1md1",
"SubAccountUin": "cj082j90n",
"ExpireTime": "2006-01-02 15:04:05",
"IsolatedTime": "2006-01-02 15:04:05",
"ReversalTime": "2006-01-02 15:04:05",
"UserAlias": "alis",
"TagList": [
{
"TagKey": "mfoi1ji",
"TagValue": "f1i00f"
}
],
"Permissions": [
"suceess"
],
"AutoSuspend": true,
"CrontabResumeSuspend": 0,
"CrontabResumeSuspendStrategy": {
"ResumeTime": "2006-01-02 15:04:05",
"SuspendTime": "2006-01-02 15:04:05",
"SuspendStrategy": 0
},
"EngineExecType": "tpye1",
"RenewFlag": 0,
"AutoSuspendTime": 0,
"NetworkConnectionSet": [
{
"Id": 0,
"AssociateId": "f01j",
"HouseId": "mv01n",
"DatasourceConnectionId": "connect_vn94n",
"State": 0,
"CreateTime": 0,
"UpdateTime": 0,
"Appid": 0,
"HouseName": "house_j9c82n",
"DatasourceConnectionName": "connection_1m9dn1",
"NetworkConnectionType": 0,
"Uin": "x9982jz",
"SubAccountUin": "m0cm9nxun20",
"NetworkConnectionDesc": "noraml",
"DatasourceConnectionVpcId": "vpc_19d8n1",
"DatasourceConnectionSubnetId": "subnet_c19n",
"DatasourceConnectionCidrBlock": "block_21j0",
"DatasourceConnectionSubnetCidrBlock": "cidr_1m2in"
}
],
"UiURL": "xxx.tencentcloudapi.com",
"ResourceType": "normal",
"ImageVersionId": "2.1.1",
"ChildImageVersionId": "2.1.1",
"ImageVersionName": "2.1.1",
"StartStandbyCluster": true,
"ElasticSwitch": true,
"ElasticLimit": 0,
"DefaultHouse": true,
"MaxConcurrency": 0,
"TolerableQueueTime": 0,
"UserAppId": 0,
"UserUin": "vm0i2m",
"SessionResourceTemplate": {
"DriverSize": "200",
"ExecutorSize": "6",
"ExecutorNums": 1,
"ExecutorMaxNumbers": 1
},
"AutoAuthorization": true
}
],
"UserAlias": "admin",
"NetworkConnectionSet": [
{
"Id": 0,
"AssociateId": "4d7a-4f21",
"HouseId": "cfb78a9",
"DatasourceConnectionId": "7dbb774578a9",
"State": 0,
"CreateTime": 0,
"UpdateTime": 0,
"Appid": 0,
"HouseName": "7cfb78a9",
"DatasourceConnectionName": "connnction",
"NetworkConnectionType": 0,
"Uin": "ecfb78a9",
"SubAccountUin": "78a9",
"NetworkConnectionDesc": "normal",
"DatasourceConnectionVpcId": "vpc_1md9",
"DatasourceConnectionSubnetId": "subnet_101n1",
"DatasourceConnectionCidrBlock": "block_vj9381",
"DatasourceConnectionSubnetCidrBlock": "cird_bn29n"
}
],
"ConnectivityState": 1,
"ConnectivityTips": "admin"
}
],
"RequestId": "7dbb7745-4d7a-4f21-b863-4971ecfb78a9"
}
}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 | 数据源类型错误。 |
