1. 接口描述
接口请求域名: wedata.tencentcloudapi.com 。
查询数据资产列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeDataAssets。 |
| Version | 是 | String | 公共参数,本接口取值:2021-08-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| RequestFromSource | 否 | String | 请求来源,WEB 前端;CLIENT 客户端 示例值:Web |
| Filters.N | 否 | Array of Filter | 过滤字段名称 Name 取值如下 keyword 搜索关键字 bizCatalogIds 表示目录分类取值 DataAssetType 数据资产类型枚举取值:ALL-全部类型、TABLE-数据表 DatasourceType 数据源类型 datasourceIds 数据源ID列表 DatabaseName 数据库名称 InCharge 负责人 ProjectId 项目ID Label 标签 ProjectId 数据资产归属的项目ID AssetLevel 等级 取值:ALL-全部,40-核心,30-重要,20-一般,10-临时 OwnerMe 我负责的 PermissionMe 我有权限的 MyFavorite 我收藏的 |
| OrderFields.N | 否 | Array of OrderField | 排序字段列表 取值: Name: Table-按表名,LikeCount-按热度 Direction: ASC, DESC |
| PageNumber | 否 | Integer | 页码,配合pageSize使用 示例值:1 |
| PageSize | 否 | Integer | 每页数目,配合pageNumber使用 示例值:10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DataSetRecords | Array of DataSetRecord | 数据资产记录列表 注意:此字段可能返回 null,表示取不到有效值。 |
| TotalCount | Integer | 总数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
| PageNumber | Integer | 页码 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| PageSize | Integer | 每页数目 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
| IndicatorRecords | Array of IndicatorBaseInfo | 指标列表 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询资产信息
查询资产信息
输入示例
POST / HTTP/1.1
Host: wedata.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataAssets
<公共请求参数>
{
"PageNumber": 1,
"PageSize": 1
}
输出示例
{
"Response": {
"DataSetRecords": [
{
"AssetId": "uvt******k4w",
"AssetLevel": 20,
"AssetStatus": 0,
"BizCatalogIds": [],
"BizCatalogNames": [],
"ClusterId": "emr-m7o0zu6k",
"CreateTime": "2024-04-19T15:47:02+08:00",
"DatabaseId": "y******3Yw",
"DatabaseName": "box",
"DatasourceId": 9263,
"DatasourceName": "hive_******88",
"Description": null,
"Environment": "prod",
"HeatValue": 0,
"InCharge": null,
"IsView": false,
"LabelNames": [],
"LifeTime": null,
"MetaCrawlType": "TABLE",
"MsType": "HIVE",
"OperateOption": {
"FavoriteCount": 1,
"HasFavorite": false,
"HasPermission": false,
"OtherOperate": "ProjectIdNull"
},
"ProjectDisplayName": null,
"ProjectId": null,
"ProjectName": null,
"Schema": null,
"StorageSize": 0,
"StorageSizeWithUnit": "0B",
"TableId": "uvt******k4w",
"TableName": "biao",
"TableNameCn": null,
"TableNameEn": null,
"TablePropertyScore": {
"Average": 0,
"DayTime": "2024-08-06T11:16:52+08:00",
"Integrity": 0,
"Normative": 0,
"Safety": 0,
"Stability": 0,
"TableId": "uvt******k4w",
"Timeliness": 0
},
"TableRecordFieldSet": [],
"TechnologyType": "HIVE"
}
],
"PageNumber": 1,
"PageSize": 1,
"RequestId": "f4ea1692-e5f5-4666-9cc0-3db66bb21518",
"TotalCount": 231017
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ConnectionTimeOutError | 连接超时 |
| InternalError | 内部错误。 |