1. 接口描述
接口请求域名: lowcode.tencentcloudapi.com 。
获取数据源详情列表
默认接口请求频率限制:300次/秒。
                推荐使用 API Explorer
            
            点击调试
        
                API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
            
        2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 | 
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeDataSourceList。 | 
| Version | 是 | String | 公共参数,本接口取值:2021-01-08。 | 
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 | 
| PageSize | 是 | Integer | 每页条数 示例值:10 | 
| PageIndex | 是 | Integer | 页码 示例值:1 | 
| EnvId | 是 | String | 环境 id 示例值:lowcode -wa123454 | 
| Appids.N | 否 | Array of String | 应用id数组 示例值:["app-wasds","app-wsdfasd"] | 
| DataSourceIds.N | 否 | Array of String | 数据源id数组 示例值:["data-zylntekm","data-zylntekn"] | 
| DataSourceNames.N | 否 | Array of String | 数据源名称数组 示例值:["name1","name2"] | 
| DataSourceType | 否 | String | 数据源类型 database-自建数据源;cloud-integration-自定义数据源 示例值:database | 
| QueryOption | 否 | DataSourceQueryOption | 数据源模糊查询参数 示例值:{"LikeName":" data-3w6wEhrF","LikeTitle":" 时间轴区块数据"} | 
| ViewIds.N | 否 | Array of String | 数据源视图Id数组 示例值:234233 | 
| AppLinkStatus | 否 | Integer | 查询未关联应用的数据源,0:未关联,该参数配合 AppIds 参数一块使用 示例值:1 | 
| QueryBindToApp | 否 | Integer | 查询应用绑定数据源: 0: 否,1: 是 示例值:0 | 
| QueryConnector | 否 | Integer | 查询连接器 0 数据模型 1 连接器 2 自定义连接器 示例值:0 | 
| NotQuerySubTypeList.N | 否 | Array of String | 废弃中 示例值:lowcode -wa123454 | 
| ChannelList.N | 否 | Array of String | 查询channelList 示例值:channelList | 
| QueryDataSourceRelationList | 否 | Boolean | 是否查询数据源关联关系 示例值:true | 
| DbInstanceType | 否 | String | db实例类型 示例值:MYSQL | 
| DatabaseTableNames.N | 否 | Array of String | 数据库表名列表 示例值:database | 
| QuerySystemModel | 否 | Boolean | 是否查询系统模型,默认为true,需要显示设置为False才能过滤系统模型 示例值:true | 
3. 输出参数
| 参数名称 | 类型 | 描述 | 
|---|---|---|
| Data | DataSourceDetailItems | data 数据 | 
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 | 
4. 示例
示例1 DescribeDataSourceList
查询数据源列表
输入示例
POST / HTTP/1.1
Host: lowcode.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataSourceList
<公共请求参数>
{
    "PageSize": 10,
    "PageIndex": 1,
    "EnvId": "lowcode-4jT6kVY",
    "Appids": [
        "data-4jT6kVY"
    ],
    "DataSourceIds": [
        "data-4jT6kVY"
    ],
    "DataSourceNames": [
        "4jT6kVY"
    ],
    "DataSourceType": "mysql",
    "QueryOption": {
        "LikeName": "4jT6kVY",
        "LikeTitle": "用户"
    },
    "ViewIds": [
        "4jT6kVY"
    ],
    "AppLinkStatus": 0,
    "QueryBindToApp": 0,
    "QueryConnector": 0,
    "NotQuerySubTypeList": [
        "d4jT6kVY"
    ],
    "ChannelList": [
        "4jT6kVY"
    ],
    "QueryDataSourceRelationList": true,
    "DbInstanceType": "mysql",
    "DatabaseTableNames": [
        "sys_user"
    ],
    "QuerySystemModel": true
}输出示例
{
    "Response": {
        "Data": {
            "Rows": [
                {
                    "Id": "data-4jT6kVY",
                    "Title": "用户",
                    "Name": "sys_user",
                    "Type": "database",
                    "Description": "内置数据源",
                    "Schema": "{\"x-primary-column\":\"name\",\"x-kind\":\"tcb\",\"name\":\"sys_user\",\"x-defaultMethods\":[\"wedaCreate\"]}",
                    "CmsProject": "data-4jT6kVY",
                    "PkgId": "lowcode-4jT6kVY",
                    "SchemaVersion": "2.0",
                    "CreatorId": "sys_user_1",
                    "CreatedAt": "sys",
                    "UpdatedAt": "sys",
                    "EnvId": "lowcode-4jT6kVY",
                    "DataSourceVersion": "data-4jT6kVY",
                    "AppUsageList": [
                        {
                            "Id": "data-4jT6kVY",
                            "Title": "用户",
                            "EditStatusUse": 0,
                            "PreviewStatusUse": 0,
                            "OnlineStatusUse": 0,
                            "DataSourceId": "data-4jT6kVY"
                        }
                    ],
                    "PublishedAt": "sys",
                    "ChildDataSourceIds": [
                        "data-4jT6kVY"
                    ],
                    "Fun": "{\"prviewPublishAt\":\"2024-11-19T17:28:57.919+0800\",\"onlinePublishAt\":\"2024-11-19T17:28:30.989+0800\",\"previewVersion\":2,\"onlineVersion\":2}",
                    "ScfStatus": 1,
                    "Methods": "data-4jT6kVY",
                    "ChildDataSourceNames": [
                        "data-4jT6kVY"
                    ],
                    "IsNewDataSource": 0,
                    "ViewId": "view-67vvgoe840",
                    "Configuration": "data-4jT6kVY",
                    "TemplateCode": "data-4jT6kVY",
                    "Source": 0,
                    "PublishVersion": "data-4jT6kVY",
                    "PublishViewId": "data-4jT6kVY",
                    "SubType": "data-4jT6kVY",
                    "AuthStatus": 0,
                    "AuthInfo": {
                        "AuthUser": "sys"
                    },
                    "PublishStatus": 0,
                    "UpdateVersion": 0,
                    "RelationFieldList": [
                        {
                            "Field": "abcdata-4jT6kVY",
                            "Format": "data-4jT6kVY",
                            "RelateDataSourceName": "data-4jT6kVY"
                        }
                    ],
                    "DbInstanceType": "mysql",
                    "PreviewTableName": "sys_user_pre",
                    "PublishedTableName": "sys_user",
                    "DbSourceType": "mysql"
                }
            ],
            "Count": 1
        },
        "RequestId": "1234_23232sdssasd"
    }
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 | 
|---|---|
| AuthFailure | CAM签名/鉴权错误。 | 
| FailedOperation | 操作失败。 | 
| FailedOperation.LowcodeUserNotExist | 低码用户不存在。 | 
| InternalError | 内部错误。 | 
| InvalidParameter | 参数错误。 | 
| InvalidParameterValue | 参数取值错误。 | 
| ResourceNotFound | 资源不存在。 |