DMS元数据更新表

最近更新时间:2025-02-20 01:30:30

我的收藏

1. 接口描述

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

DMS元数据更新表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:AlterDMSTable。
Version String 公共参数,本接口取值:2021-01-25。
Region String 公共参数,详见产品支持的 地域列表
CurrentName String 当前名称
示例值:name1
CurrentDbName String 当前数据库名称
示例值:db1
Asset Asset 基础对象
Type String 表类型
示例值:EXTERNAL
DbName String 数据库名称
示例值:db1
StorageSize Integer 存储大小
示例值:1
RecordCount Integer 记录数量
示例值:1
LifeTime Integer 生命周期
示例值:10
DataUpdateTime Timestamp ISO8601 数据更新时间
示例值:2021-01-01 12:12:12
StructUpdateTime Timestamp ISO8601 结构更新时间
示例值:2021-01-01 12:12:12
LastAccessTime Timestamp ISO8601 最后访问时间
示例值:2021-01-01 12:12:12
Sds DMSSds 存储对象
Columns.N Array of DMSColumn
PartitionKeys.N Array of DMSColumn 分区键值
ViewOriginalText String 视图文本
示例值:select 1
ViewExpandedText String 视图文本
示例值:select 1
Partitions.N Array of DMSPartition 分区
Name String 当前表名
示例值:table1
DatasourceConnectionName String 数据源连接名
示例值:DataLakeCatalog

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改表

输入示例

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

{
    "CurrentName": "table3",
    "CurrentDbName": "database1",
    "Asset": {
        "Name": "table3",
        "Catalog": "DataLakeCatalog",
        "Description": "alter description",
        "Params": [
            {
                "Key": "param1",
                "Value": "default param"
            }
        ],
        "BizParams": [
            {
                "Key": "bizparam1",
                "Value": "default bizparam"
            }
        ]
    },
    "Type": "EXTERNAL",
    "DbName": "database1",
    "Sds": {
        "Location": "cons://********",
        "InputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat",
        "OutputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
        "NumBuckets": 0,
        "Compressed": false,
        "StoredAsSubDirectories": false,
        "SerdeLib": "org.apache.hadoop.hive.serde2.OpenCSVSerde",
        "SerdeName": "serde1",
        "BucketCols": [
            "col1"
        ],
        "SerdeParams": [
            {
                "Key": "serde",
                "Value": "1"
            }
        ],
        "Params": [
            {
                "Key": "param1",
                "Value": "default param"
            }
        ]
    },
    "Columns": [
        {
            "Name": "id",
            "Description": "alter col",
            "Type": "int",
            "IsPartition": true
        }
    ],
    "PartitionKeys": [
        {
            "Name": "dt",
            "Description": "default description",
            "Type": "int",
            "Position": 1,
            "BizParams": [
                {
                    "Key": null,
                    "Value": null
                }
            ],
            "IsPartition": true
        }
    ],
    "Partitions": [
        {
            "DatabaseName": "database1",
            "TableName": "table3",
            "DataVersion": 1,
            "Name": "dt2",
            "Values": [
                "1"
            ],
            "Params": [
                {
                    "Key": null,
                    "Value": null
                }
            ],
            "Sds": {
                "Location": "cosn://********",
                "InputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat",
                "OutputFormat": "org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat",
                "NumBuckets": 0,
                "Compressed": false,
                "StoredAsSubDirectories": null,
                "SerdeLib": "org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe",
                "SerdeName": "serde2",
                "BucketCols": [
                    "col2"
                ],
                "SerdeParams": [
                    {
                        "Key": null,
                        "Value": null
                    }
                ],
                "Params": [
                    {
                        "Key": "param3",
                        "Value": "default param"
                    }
                ],
                "SortCols": {
                    "Col": null,
                    "Order": null
                },
                "Cols": [
                    {
                        "Name": "column1",
                        "Description": "default column",
                        "Type": "int",
                        "Position": 1,
                        "Params": [
                            {
                                "Key": "param1",
                                "Value": "default param"
                            }
                        ],
                        "BizParams": [
                            {
                                "Key": "bizparam1",
                                "Value": "default bizparam"
                            }
                        ],
                        "IsPartition": false
                    }
                ]
            }
        }
    ],
    "Name": "table3",
    "DatasourceConnectionName": "DataLakeCatalog"
}

输出示例

{
    "Response": {
        "RequestId": "********-****-****-****-237bfeec9223"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

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