调用ListViewDetails获取视图详细列表-数据湖构建-阿里云

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /dlf/v1/{catalogId}/databases/{database}/view-details HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
catalogId	string	是	数据目录 ID。	clg-paimon-xxx
database	string	是	数据库名称。	database_name

请求参数

名称	类型	必填	描述	示例值
maxResults	integer	否	一次获取的最大记录数	1000
pageToken	string	否	翻页令牌，用于获取下一页数据。如果响应结果中没有提供，则传空字符串（""）或空字符（''）。	""
viewNamePattern	string	否	视图模糊匹配名。	view%

返回参数

名称	类型	描述	示例值
	object	ListViewDetailsResponse
viewDetails	array	视图列表。
	View	视图详情。
nextPageToken	string	翻页令牌，用于获取下一页数据。当返回 null 时，表示当前查询的是最后一页结果。	“”

示例

正常返回示例

JSON格式

{
  "viewDetails": [
    {
      "schema": {
        "fields": [
          {
            "name": "order_id",
            "description": "description",
            "id": 1,
            "type": {
              "type": "STRING",
              "fields": [
                {
                  "name": "order_id",
                  "description": "description",
                  "id": 1,
                  "type": {
                    "type": "STRING",
                    "fields": [
                      {
                        "name": "order_id",
                        "description": "description",
                        "id": 1,
                        "type": {
                          "type": "STRING",
                          "fields": []
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ],
        "query": "",
        "dialects": {
          "key": ""
        },
        "comment": "",
        "options": {
          "key": ""
        }
      },
      "owner": "",
      "createdAt": 0,
      "updatedBy": "",
      "createdBy": "",
      "name": "",
      "id": "",
      "updatedAt": 0
    }
  ],
  "nextPageToken": "“”"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。