帮你快速理解、总结文档立即下载
文档中心>API 中心>大数据智能体工作台 DataBuddy>Catalog 相关接口>查询view详情

查询view详情

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

本页目录：

1. 接口描述

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

查询view详情

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

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

2. 输入参数

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

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

数据目录名


示例值：DataLakeCatalog
SchemaName 是 String

数据库名


示例值：default
ViewName 是 String

View名称


示例值：order_partition_view
WorkspaceId 否 String

调用时所在workspace唯一id


示例值：231434145236852
FetchOption 否 FetchOption

数据获取选项，可选，控制是否返回权限信息及按权限过滤

3. 输出参数

参数名称 类型 描述
Data GetViewRsp

view详情


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

4. 示例

示例1 查询view详情

输入示例

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

{
    "CatalogName": "DataLakeCatalog",
    "SchemaName": "default",
    "ViewName": "order_partition_view"
}

输出示例

{
    "Response": {
        "RequestId": "b5a9e27a-358e-45f1-89c5-c56ce24d10df",
        "Data": {
            "View": {
                "Audit": {
                    "CreatedAt": "1761055227671",
                    "Creator": "1290245077@qq.com",
                    "LastModifiedAt": "0",
                    "LastModifier": ""
                },
                "Columns": [
                    {
                        "Comment": "",
                        "FieldSetting": "",
                        "IsPrimaryKey": false,
                        "Name": "order_id_col",
                        "Type": "long"
                    },
                    {
                        "Comment": "",
                        "FieldSetting": "",
                        "IsPrimaryKey": false,
                        "Name": "customer_id_col",
                        "Type": "long"
                    },
                    {
                        "Comment": "",
                        "FieldSetting": "",
                        "IsPrimaryKey": false,
                        "Name": "quantity_col",
                        "Type": "integer"
                    }
                ],
                "Comment": "订单分区视图",
                "MetaOwner": {
                    "FullName": "DataLakeCatalog.default.order_partition_view",
                    "Owner": "1290245077@qq.com",
                    "OwnerType": "user"
                },
                "Name": "order_partition_view",
                "Properties": [
                    {
                        "Key": "comment",
                        "Value": "订单分区视图"
                    },
                    {
                        "Key": "create_engine_version",
                        "Value": "Spark 3.5.3-dlc"
                    },
                    {
                        "Key": "engine_version",
                        "Value": "Spark 3.5.3-dlc"
                    }
                ]
            }
        }
    }
}

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 参数不正确
ResourceNotFound.CatalogNotFound 指定的 Catalog 不存在
ResourceNotFound.SchemaNotFound 指定的Schema不存在
ResourceNotFound.ViewNotFound 指定的视图不存在
中国站