DMS元数据获取表

最近更新时间：2024-03-12 01:25:52

我的收藏

本页目录：

1. 接口描述

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

DMS元数据获取表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDMSTable。
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

3. 输出参数

参数名称	类型	描述
Asset	Asset	基础对象注意：此字段可能返回 null，表示取不到有效值。
ViewOriginalText	String	视图文本注意：此字段可能返回 null，表示取不到有效值。示例值：select 1
ViewExpandedText	String	视图文本注意：此字段可能返回 null，表示取不到有效值。示例值：select 1
Retention	Integer	hive维护版本注意：此字段可能返回 null，表示取不到有效值。示例值：1
Sds	DMSSds	存储对象注意：此字段可能返回 null，表示取不到有效值。
PartitionKeys	Array of DMSColumn	分区列注意：此字段可能返回 null，表示取不到有效值。
Partitions	Array of DMSPartition	分区注意：此字段可能返回 null，表示取不到有效值。
Type	String	表类型注意：此字段可能返回 null，表示取不到有效值。示例值：EXTERNAL
DbName	String	数据库名称注意：此字段可能返回 null，表示取不到有效值。示例值：db1
SchemaName	String	Schame名称注意：此字段可能返回 null，表示取不到有效值。示例值：schema1
StorageSize	Integer	存储大小注意：此字段可能返回 null，表示取不到有效值。示例值：1
RecordCount	Integer	记录数量注意：此字段可能返回 null，表示取不到有效值。示例值：0
LifeTime	Integer	生命周期注意：此字段可能返回 null，表示取不到有效值。示例值：1
LastAccessTime	Timestamp ISO8601	最后访问时间注意：此字段可能返回 null，表示取不到有效值。示例值：2020-01-01 11:11:11
DataUpdateTime	Timestamp ISO8601	数据更新时间注意：此字段可能返回 null，表示取不到有效值。示例值：2020-01-01 11:11:11
StructUpdateTime	Timestamp ISO8601	结构更新时间注意：此字段可能返回 null，表示取不到有效值。示例值：2020-01-01 11:11:11
Columns	Array of DMSColumn	列注意：此字段可能返回 null，表示取不到有效值。
Name	String	表名称注意：此字段可能返回 null，表示取不到有效值。示例值：table1
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询表

输入示例

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

{
    "Name": "xx",
    "Keyword": "xx",
    "Pattern": "xx",
    "Catalog": "xx",
    "SchemaName": "xx",
    "Type": "xx",
    "DbName": "xx"
}

输出示例

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

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InternalError.InternalSystemException	业务系统异常，请重试或提工单联系我们。
InvalidParameter	参数错误。
ResourceNotFound	资源不存在。
UnauthorizedOperation	未授权操作。

上一篇: DMS元数据获取分区下一篇: DMS元数据获取表列表