帮你快速理解、总结文档立即下载
文档中心>大数据智能体工作台 DataBuddy>API 文档>Catalog 相关接口>资产统一搜索

资产统一搜索

最近更新时间：2026-10-26 01:56:49
我的收藏

本页目录：

1. 接口描述

接口请求域名： databuddy.tencentcloudapi.com 。

资产统一搜索

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：SearchAsset。
Version 是 String 公共参数，本接口取值：2026-07-15。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-jakarta, ap-shanghai, ap-singapore, ap-tokyo 。
WorkspaceId 是 String

工作空间ID


示例值：17678671667189298
MaxResults 否 Integer

最大结果条数，默认30，可选30～50


示例值：1
Keyword 否 String

关键字


示例值：order
AssetTypes.N 否 Array of String

资产类型列表，类型参见ListEntityTypeMetas的返回


示例值：["shecha"]
PageToken 否 String

分页token信息，取上一页返回NextPageToken


示例值：token123
Owner.N 否 Array of String

按资产负责人检索

  • my 我负责的(包含my时其他uin不生效)
  • uin 指定用户uin

示例值：["my"]
TagIds.N 否 Array of Integer

标签IDs，可通过 ListTags 获取


示例值：[1]
TagValueIds.N 否 Array of Integer

标签值IDs，可通过 ListTags 获取


示例值：[1]
ModifiedTime 否 String

更新时间，13位时间戳


示例值：1764228776000
CatalogNames.N 否 Array of String

数据目录列表


示例值：["string"]
WorkspacePaths.N 否 Array of String

工作空间路径筛选(非catalog类资产)


示例值：["/path/to/workspace"]
EnableHybridSearch 否 Boolean

是否开启混合搜索


示例值：true
FieldTagIds.N 否 Array of Integer

字段标签ID列表（可选）。使用场景：根据字段上打的标签检索资产（表），返回包含该字段标签的资产。与 TagIds 的区别：TagIds 是表级标签过滤，FieldTagIds 是字段级标签过滤。规格要求：int64 数组，最多支持 20 个标签 ID 同时过滤。可通过 ListTags 获取


示例值：[1]
OrderBys.N 否 Array of OrderBy

排序，为空时默认按相关度倒排序

Name:
PopularityQuantity 热度

Direction:
Desc 降序
Asc 升序

3. 输出参数

参数名称 类型 描述
Data SearchAssetRsp

返回信息


注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 资产统一搜索

输入示例

POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchAsset
<公共请求参数>

{
    "WorkspaceId": "17678671667189298",
    "MaxResults": 1,
    "Keyword": "order"
}

输出示例

{
    "Response": {
        "Data": {
            "Items": [
                {
                    "Aliases": [],
                    "AssetGuid": "hooke.zhangyue_test.order_detail_0@*********_ap-guangzhou_TABLE",
                    "AssetId": "hooke.zhangyue_test.order_detail_0",
                    "AssetName": "order_detail_0",
                    "AssetType": "TABLE",
                    "CatalogSource": "CONNECTION",
                    "Comment": "",
                    "FieldInfo": [
                        {
                            "Comment": "",
                            "Content": "",
                            "Lang": "",
                            "Name": "order_id",
                            "SampleValues": [],
                            "Type": "long"
                        }
                    ],
                    "FieldTags": [],
                    "FullName": "hooke.zhangyue_test.order_detail_0",
                    "HighlightingInfo": {
                        "AliasFragments": [],
                        "AssetName": "<em>order</em>_detail_0",
                        "CodeFragments": [],
                        "Comment": "",
                        "FullName": "",
                        "TagFragments": [],
                        "TextFragments": [
                            {
                                "Comment": "",
                                "Content": "",
                                "Lang": "",
                                "Name": "<em>order</em>_id",
                                "Type": "long"
                            }
                        ]
                    },
                    "ModifiedTime": "1790129153387",
                    "Owner": {
                        "Type": 0,
                        "UserId": "",
                        "UserName": ""
                    },
                    "Popularity": "1",
                    "PopularityQuantity": "0",
                    "Properties": [],
                    "Tags": [],
                    "UserActivityInfo": {
                        "IsFavorite": false,
                        "LastViewTime": ""
                    },
                    "WorkspaceId": "",
                    "WorkspacePath": ""
                }
            ],
            "NextPageToken": "eyJzZWFyY2hBZnRlclZhbHVlcyI6WzE4LjE5NTgxNiwiaG9va2Uuemhhbmd5dWVfdGVzdC5vcmRlcl9kZXRhaWxfMEAyNjAwNzM0OTNfYXAtZ3Vhbmd6aG91X1RBQkxFIl19"
        },
        "RequestId": "14c44330-20d2-441e-95f7-12c3b56d56e0"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
InternalError.BizException 业务逻辑错误
InternalError.FailedOperation 操作失败
InvalidParameter.InvalidParameter 参数不正确
中国站