1. 接口描述
接口请求域名： wedata.tencentcloudapi.com 。
数据源详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDataSourceList。 |
| Version | 是 | String | 公共参数，本接口取值：2021-08-20。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| PageNumber | 否 | Integer | 页码 示例值：0 |
| PageSize | 否 | Integer | 返回数量 示例值：10 |
| OrderFields.N | 否 | Array of OrderField | 排序配置 |
| Filters.N | 否 | Array of Filter | 可选过滤条件，Filter可选配置(参考): "Name": { "type": "string", "description": "数据源名称" }, "Type": { "type": "string", "description": "类型" }, "ClusterId": { "type": "string", "description": "集群id" }, "CategoryId": { "type": "string", "description": "分类，项目或空间id" } |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | DataSourceInfoPage | 数据源列表 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 样例
查询数据源
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataSourceList
<公共请求参数>
{
"PageNumber": 0,
"PageSize": 10
}输出示例
{
"Response": {
"Data": {
"PageNumber": 1,
"PageSize": 10,
"Rows": [
{
"AppId": 1986419,
"Author": false,
"AuthorityProjectName": null,
"AuthorityUserName": null,
"BizParams": null,
"BizParamsString": "",
"Category": "DB",
"ClusterId": "d6sdfg-b0d1-4b2c-b0bb-3f19654f9ff0b0",
"ClusterName": null,
"CreateTime": 1712823453266555,
"DataSourceStatus": "Available",
"DatabaseName": "emall",
"Deliver": false,
"Description": "",
"DevelopmentId": null,
"DevelopmentParams": null,
"Display": "emall",
"Edit": false,
"ID": 563511,
"Instance": null,
"ModifiedTime": 1712264523812655,
"Name": "emall",
"OwnerAccount": "100034623548673",
"OwnerAccountName": "allenbguasdo",
"OwnerProjectId": "153160969233490365952",
"OwnerProjectIdent": "project1",
"OwnerProjectName": "[project1]",
"Params": null,
"ParamsString": "{\"vport\":\"63348\",\"connectType\":\"public\",\"ip\":\"156.16.156.156\",\"publicPort\":\"6658\",\"publicIp\":\"189.15.15\",\"type\":\"MYSQL\",\"authorityType\":\"true\",\"deployType\":\"CONNSTR_PUBLICDB\",\"url\":\"jdbc:mysql://156.15.161.65:63258/emall\",\"vurl\":\"jdbc:mysql://68.23.265.86:63618/emall\",\"password\":\"********\",\"vpcTenantId\":\"131506509\",\"port\":\"65113\",\"passwordEncrypt\":\"40de7fbe6ad34c9d581af31416ef2a6c\",\"publicUrl\":\"jdbc:mysql://32.13.26.23:66413/emall\",\"vip\":\"156.168.95.62\",\"db\":\"emall\",\"username\":\"sdggds\"}",
"ProductId": "59111",
"Region": "ap-beijing",
"ShowType": "MySQL",
"Status": 2,
"Type": "MYSQL"
}
],
"TotalCount": 1,
"TotalPageNumber": null
},
"RequestId": "44266d40-5822-48b3-bf0f-74f5b06d98eb"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| OperationDenied.UserNotInWhitelistError | 用户不在白名单。 |