1. 接口描述
接口请求域名: dlc.tencentcloudapi.com 。
本接口(DescribeViews)用于查询数据视图列表。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeViews。 |
Version | 是 | String | 公共参数,本接口取值:2021-01-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
DatabaseName | 是 | String | 列出该数据库下所属数据表。 示例值:database1 |
Limit | 否 | Integer | 返回数量,默认为10,最大值为100。 示例值:20 |
Offset | 否 | Integer | 数据偏移量,从0开始,默认为0。 示例值:0 |
Filters.N | 否 | Array of Filter | 过滤条件,如下支持的过滤类型,传参Name应为其一 view-name - String - (过滤条件)数据表名称,形如:view-001。 view-id - String - (过滤条件)view id形如:12342。 |
DatasourceConnectionName | 否 | String | 数据库所属的数据源名称 示例值:COSDataCatalog |
Sort | 否 | String | 排序字段 示例值:test |
Asc | 否 | Boolean | 排序规则,true:升序;false:降序 示例值:false |
StartTime | 否 | String | 按视图更新时间筛选,开始时间,如2021-11-11 00:00:00 示例值:2021-11-11 00:00:00 |
EndTime | 否 | String | 按视图更新时间筛选,结束时间,如2021-11-12 00:00:00 示例值:2021-11-11 00:00:00 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ViewList | Array of ViewResponseInfo | 视图对象列表。 |
TotalCount | Integer | 实例总数。 示例值:21 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询视图列表
输入示例
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeViews
<公共请求参数>
{
"Limit": 1,
"Offset": 0,
"DatabaseName": "testdb",
"Sort": "name",
"Asc": true,
"StartTime": "2021-11-11 00:00:00",
"EndTime": "2021-11-18 00:00:00"
}
输出示例
{
"Response": {
"RequestId": "c1d840f1-2df8-4ef4-9e44-02db58f24475",
"TotalCount": 1,
"ViewList": [
{
"ViewBaseInfo": {
"DatabaseName": "testdb",
"ViewName": "v1",
"UserAlias": "testUser",
"UserSubUin": "100019878767"
},
"Columns": [],
"Properties": [
{
"Key": "presto_view",
"Value": "true"
},
{
"Key": "presto_query_id",
"Value": "20210901_123510_00000_9jg5j"
},
{
"Key": "transient_lastDdlTime",
"Value": "1630499714051"
},
{
"Key": "comment",
"Value": "Presto View"
},
{
"Key": "presto_version",
"Value": "0.242.1-DLC-rc11-6fe2f42"
}
],
"CreateTime": "1630499714000",
"ModifiedTime": "1630499714000"
}
]
}
}
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.InternalSystemException | 业务系统异常,请重试或提工单联系我们。 |
InvalidParameter | 参数错误。 |
InvalidParameter.DatasourceConnectionNotUnique | 数据源连接已存在,请重试,或者提交工单联系我们 |
InvalidParameter.InvalidTimeParameter | 日期参数异常,如结束时间早于开始时间 |
ResourceNotFound.DatasourceNotFound | 数据源连接不存在,请重试,或者提交工单联系我们 |
UnsupportedOperation.UnsupportedDatasourceConnectionType | 不支持当前数据连接类型,当前仅支持: DataLakeCatalog/Mysql/HiveCos/HiveHdfs/HiveCHdfs/PostgreSql/SqlServer/ClickHouse |