1. 接口描述
接口请求域名: databuddy.tencentcloudapi.com 。
获取view列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:ListViews。 |
| Version | 是 | String | 公共参数,本接口取值:2026-07-15。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-chongqing, ap-guangzhou, ap-jakarta, ap-shanghai, ap-singapore, ap-tokyo 。 |
| CatalogName | 是 | String | 数据目录名 示例值:s**a0710 |
| SchemaName | 是 | String | 数据库名 示例值:information_schema |
| WorkspaceId | 是 | String | 调用时所在workspace唯一id 示例值:17836526087487468 |
| MaxResults | 否 | Integer | 最大结果条数,默认10 示例值:100 |
| PageToken | 否 | String | 分页token 示例值:eyJvZmZzZXQiOjd9 |
| FetchOption | 否 | FetchOption | 数据获取选项,可选,控制是否返回权限信息及按权限过滤 |
| ConnectionId | 否 | String | 数据源连接ID,可选(融合版新增字段)。非空→走分析版路径,空/缺省→走专业版TcLake路径。可通过 ListConnections 获取 示例值:capi_test_connection |
| CatalogSource | 否 | String | 数据目录来源,可选(Setats融合新增字段)。取值:METALAKE(专业版tclake)/ CONNECTION(分析版Linked Catalog)/ SETATS(Setats元数据)。路由优先级:显式非空CatalogSource > 非空ConnectionId(视为CONNECTION)> 默认METALAKE;CatalogSource非空时ConnectionId将被忽略。 示例值:METALAKE |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | ListViewsRsp | 操作结果 注意:此字段可能返回 null,表示取不到有效值。 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取view列表
获取view列表
输入示例
POST / HTTP/1.1
Host: databuddy.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListViews
<公共请求参数>
{
"CatalogName": "s***a*0710",
"SchemaName": "information_schema",
"MaxResults": 100,
"WorkspaceId": "17836526087487468"
}
输出示例
{
"Response": {
"Data": {
"Items": [
{
"AssetGuid": "tcc***l*g.v1.uid32789*23*359412846*@**00734**_ap-*ua*gzhou_VIEW",
"Audit": {
"CreatedAt": "1783652632924",
"Creator": "70000*1***1*",
"CreatorName": "**dat**0******@tencent.com",
"LastModifiedAt": "1783652640433",
"LastModifier": "700*0**64***",
"LastModifierName": "*e*ata30*****1@tencent.com"
},
"Columns": [
{
"Comment": "metalake name",
"FieldSetting": "",
"IsPrimaryKey": false,
"Name": "metalake_name",
"Tags": [],
"Type": "string"
}
],
"Comment": "catalog_privileges",
"MetaOwner": {
"FullName": "svmgao0710.information_schema.catalog_privileges",
"Owner": "700*0*1*4*1*",
"OwnerName": "***********st1@tencent.com",
"OwnerType": "user"
},
"Name": "catalog_privileges",
"Properties": [
{
"Key": "tccatalog.identifier",
"Value": "tccatalog.v1.uid3278902383594128462"
}
],
"Tags": []
}
],
"NextPageToken": ""
},
"RequestId": "20704381-273a-431f-bc1d-ecaa5923314f"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.BizException | 业务逻辑错误 |
| InternalError.FailedOperation | 操作失败 |
| InvalidParameter.InvalidParameter | 参数不正确 |
| ResourceNotFound.CatalogNotFound | 指定的 Catalog 不存在 |
| ResourceNotFound.SchemaNotFound | 指定的Schema不存在 |