本接口用于查询已创建数据源的列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| SearchKey | string | 否 | 数据源的名称或 ID。 | sourcename |
| Types | array | 否 | 数据源类型的集合。 | |
| string | 否 | 数据源的类型。 | MYSQL_PUBLIC | |
| SortField | string | 否 | 数据源排序的字段，包括 gmtCreate（默认值）和 gmtModified。 | gmtCreate |
| Order | string | 否 | 数据源排序的顺序，包括 | descend |
| PageNumber | string | 否 | 页序号，分页查询时生效。 | 1 |
| PageSize | string | 否 | 页大小，分页查询时生效。 | 10 |
返回参数
附录
Kafka
{
"connExtraAttributes":{
"endpoint":"xxx.xxx.xxx.1:2883",
"username":null,
"enableSSL":null,
"enableSASL":null,
"saslMechanism":null,
"disableIdentificationAlgorithm":false
}
}
| 参数 | 类型 | 描述 |
|---|---|---|
| endpoint | string | 服务地址。 |
| username | string | 用户名。当您选择认证方式为 PLAIN、SCRAM-SHA-256 和 SCRAM-SHA-512 时，该参数必填。 |
| enableSSL | boolean | 是否开启 SSL 认证。如果开启，则需要上传授信证书。 |
| enableSASL | boolean | 是否开启 SASL 认证。 |
| saslMechanism | KafkaSaslMechanisnEnum | 加密方式，包括 PLAIN、SCRAM-SHA-256、SCRAM-SHA-512 和 KERBEROS。 |
| disableIdentificationAlgorithm | boolean | SSL 加密时，是否开启主机名验证。 |
DataHub
{
"connExtraAttributes":{
"endpoint":"xxx.xxx.xxx.1:2883",
"project":"detx***"
}
}
| 参数 | 类型 | 描述 |
|---|---|---|
| endpoint | string | 服务地址。 |
| project | string | 项目的名称。 |
RocketMQ
{
"connExtraAttributes":{
"endpoint":"xxx.xxx.xxx.1:2883",
"endpointType":null,
"version":null
}
}
| 参数 | 类型 | 描述 |
|---|---|---|
| endpoint | string | 服务地址。 |
| endpointType | CloudRocketMQEndpoint.Type | 服务地址的类型。 |
| version | CloudRocketMQInst.Version | RocketMQ 的版本。 |
OceanBase
{
"connExtraAttributes":{
"cluster":"xgez***",
"tenant":"gexr**",
"isLogicSource":false,
"useLogProxy":true,
"drcUser":"tes***",
"configUrl":"http://xxx.xxx.xxx.1:2883/service****",
"logProxyIp":"xxx.xxx.xxx.2",
"logProxyPort":2883,
"noUserAuth":false
}
}
| 参数 | 类型 | 描述 |
|---|---|---|
| cluster | string | 集群的名称。 |
| tenant | string | 租户的名称。 |
| isLogicSource | boolean | 是否为逻辑数据源。 |
| useLogProxy | boolean | 是否使用 LogProxy。 |
| drcUser | string | drc_user 的配置。 |
| configUrl | string | 用于获取 OceanBase 数据库底层服务器的真实地址。 |
| logProxyIp | string | LogProxy 服务的 IP 地址。 |
| logProxyPort | integer | LogProxy 服务的端口。 |
| noUserAuth | boolean | 对于同步 DataWorks 的接口，数据源是 OMS 自动生成的。如果没有用户账号和密码，则不能连接用户的 OceanBase 数据库。 |
TiDB
{
"connExtraAttributes":{
"kafkaId":"e_edz****",
"kafkaTopic":"test**",
"kafkaName":"denz***"
}
}
| 参数 | 类型 | 描述 |
|---|---|---|
| kafkaId | string | 绑定的 Kafka 数据源的 ID。 |
| kafkaTopic | string | 绑定的 Kafka Topic 的名称。 |
| kafkaName | string | 绑定的 Kafka 数据源的名称。 |
示例
正常返回示例
JSON格式
{
"Success": true,
"ErrorDetail": {
"Code": "CM-RESOAT1111",
"Level": "ERROR",
"Message": "A system error occurred.",
"ExtraContext": {
"key": "null"
},
"MessageMcmsKey": "null",
"MessageMcmsContext": {
"key": "null"
},
"Reason": "null",
"ReasonMcmsKey": "null",
"ReasonMcmsContext": {
"key": "null"
},
"Proposal": "null",
"ProposalMcmsKey": "null",
"ProposalMcmsContext": {
"key": "null"
},
"UpstreamErrorDetail": "null"
},
"Code": "INNER_ERROR",
"Message": "A system error occurred.",
"Advice": "Contact the administrator. ",
"RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 132,
"Cost": "28",
"Data": [
{
"Id": "e_4w****v",
"Name": "RATION***1DBUTF11",
"Type": "MYSQL_PUBLIC",
"Role": "MASTER",
"Owner": "admin",
"Tenant": "tenant_name",
"Cluster": "cluster_name",
"Schema": "schema_name",
"VpcId": "vpc_t4***",
"Ip": "xxx.xxx.xxx.1",
"Port": 2883,
"UserName": "user_name",
"Region": "cn-beijing",
"Description": "test",
"OracleSid": "null",
"OracleNlsLengthSemantics": "null",
"OperatingSystem": "Linux",
"Version": "4.1.0",
"Timezone": "+08:00",
"Charset": "utf8mb4",
"ResourceOwner": "178641****05809",
"GmtCreate": "2023-07-13T20:27:28.000+00:00",
"GmtModified": "2023-07-13T20:37:28.000+00:00",
"PartnerId": "null",
"ConnExtraAttributes": "null"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-07 | API 内部配置变更，不影响调用 | 查看变更详情 |