DMS元数据获取表列表

最近更新时间:2024-06-24 01:13:23

我的收藏

1. 接口描述

接口请求域名: dlc.tencentcloudapi.com 。

DMS元数据获取表列表

默认接口请求频率限制:200次/秒。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDMSTables。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表
DbName String 数据库名称
示例值:db1
SchemaName String 数据库schema名称
示例值:schemaName1
Name String 表名称
示例值:tbl1
Catalog String 数据目录
示例值:DataLakeCatalog
Keyword String 查询关键词
示例值:ta
Pattern String 查询模式
示例值:*
Type String 表类型
示例值:EXTERNAL
StartTime String 筛选参数:更新开始时间
示例值:2006-01-02 15:04:05
EndTime String 筛选参数:更新结束时间
示例值:2006-01-02 15:04:05
Limit Integer 分页参数
示例值:10
Offset Integer 分页参数
示例值:0
Sort String 排序字段:create_time:创建时间
示例值:create_time
Asc Boolean 排序字段:true:升序(默认),false:降序
示例值:true

3. 输出参数

参数名称 类型 描述
TableList Array of DMSTableInfo DMS元数据列表信息
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 统计值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DMS查询表列表

输入示例

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

{
    "Name": "name1",
    "Keyword": "key",
    "Pattern": "pattern",
    "Catalog": "DataLakeCatalog",
    "SchemaName": "name",
    "Type": "t1",
    "DbName": "db1"
}

输出示例

{
    "Response": {
        "TableList": [
            {
                "Table": {
                    "ViewOriginalText": "abc",
                    "ViewExpandedText": "abc",
                    "Retention": 0,
                    "Columns": [],
                    "Sds": {
                        "Location": "abc",
                        "InputFormat": "abc",
                        "OutputFormat": "abc",
                        "NumBuckets": 0,
                        "Compressed": true,
                        "StoredAsSubDirectories": true,
                        "SerdeLib": "abc",
                        "SerdeName": "abc",
                        "BucketCols": [
                            "abc"
                        ],
                        "SerdeParams": [
                            {
                                "Key": "abc",
                                "Value": "abc"
                            }
                        ],
                        "Params": [
                            {
                                "Key": "abc",
                                "Value": "abc"
                            }
                        ],
                        "SortCols": {
                            "Col": "abc",
                            "Order": 0
                        },
                        "Cols": [
                            {
                                "Name": "abc",
                                "Description": "abc",
                                "Type": "abc",
                                "Position": 0,
                                "Params": [
                                    {
                                        "Key": "abc",
                                        "Value": "abc"
                                    }
                                ],
                                "IsPartition": true
                            }
                        ],
                        "SortColumns": [
                            {
                                "Col": "abc",
                                "Order": 0
                            }
                        ]
                    },
                    "PartitionKeys": [
                        {
                            "Name": "abc",
                            "Description": "abc",
                            "Type": "abc",
                            "Position": 0,
                            "IsPartition": true
                        }
                    ],
                    "Partitions": [
                        {
                            "DatabaseName": "abc",
                            "SchemaName": "abc",
                            "TableName": "abc",
                            "DataVersion": 0,
                            "Name": "abc",
                            "Params": [],
                            "Values": [
                                "abc"
                            ],
                            "StorageSize": 0,
                            "RecordCount": 0,
                            "CreateTime": "2020-09-22T00:00:00+00:00",
                            "ModifiedTime": "2020-09-22T00:00:00+00:00",
                            "LastAccessTime": "2020-09-22T00:00:00+00:00",
                            "Sds": {
                                "Location": "abc",
                                "InputFormat": "abc",
                                "OutputFormat": "abc",
                                "NumBuckets": 0,
                                "Compressed": true,
                                "StoredAsSubDirectories": true,
                                "SerdeLib": "abc",
                                "SerdeName": "abc",
                                "Params": [],
                                "SerdeParams": [],
                                "SortColumns": [],
                                "BucketCols": [
                                    "abc"
                                ],
                                "SortCols": {
                                    "Col": "abc",
                                    "Order": 0
                                },
                                "Cols": [
                                    {
                                        "Name": "abc",
                                        "Description": "abc",
                                        "Type": "abc",
                                        "Position": 0,
                                        "IsPartition": true
                                    }
                                ]
                            }
                        }
                    ],
                    "Type": "abc",
                    "DbName": "abc",
                    "SchemaName": "abc",
                    "StorageSize": 0,
                    "RecordCount": 0,
                    "LifeTime": 0,
                    "LastAccessTime": "2020-09-22T00:00:00+00:00",
                    "DataUpdateTime": "2020-09-22T00:00:00+00:00",
                    "StructUpdateTime": "2020-09-22T00:00:00+00:00",
                    "Name": "abc"
                },
                "Asset": {
                    "Id": 0,
                    "Name": "abc",
                    "Guid": "abc",
                    "Catalog": "abc",
                    "Description": "abc",
                    "Owner": "abc",
                    "OwnerAccount": "abc",
                    "DataVersion": 0,
                    "CreateTime": "2020-09-22T00:00:00+00:00",
                    "ModifiedTime": "2020-09-22T00:00:00+00:00",
                    "DatasourceId": 0,
                    "Params": [],
                    "PermValues": [],
                    "BizParams": []
                }
            }
        ],
        "TotalCount": 0,
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。