数据湖计算 DLC DMS元数据获取分区-API 文档-文档中心-腾讯云

1. 接口描述

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

DMS元数据获取分区

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDMSPartitions。
Version	是	String	公共参数，本接口取值：2021-01-25。
Region	是	String	公共参数，详见产品支持的地域列表。
DatabaseName	是	String	数据库名示例值：db1
TableName	是	String	表名称示例值：table1
SchemaName	否	String	schema名称示例值：schema1
Name	否	String	名称示例值：name1
Values.N	否	Array of String	单个分区名称，精准匹配示例值：["aa", "bb"]
PartitionNames.N	否	Array of String	多个分区名称，精准匹配示例值：["a1", "b1"]
PartValues.N	否	Array of String	多个分区字段的匹配，模糊匹配示例值：["a2", "a3"]
Filter	否	String	过滤SQL 示例值：a = 1 and b =2
MaxParts	否	Integer	最大分区数量示例值：1
Offset	否	Integer	翻页跳过数量示例值：100
Limit	否	Integer	页面数量示例值：10
Expression	否	String	表达式示例值：base64()

3. 输出参数

参数名称	类型	描述
Partitions	Array of DMSPartition	分区信息
Total	Integer	总数示例值：100
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询表分区

查询表分区

输入示例

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

{
    "Name": "abc",
    "TableName": "abc",
    "PartValues": [
        "abc"
    ],
    "Values": [
        "abc"
    ],
    "DatabaseName": "abc",
    "PartitionNames": [
        "abc"
    ],
    "SchemaName": "abc"
}

输出示例

{
    "Response": {
        "Partitions": [
            {
                "DatabaseName": "abc",
                "SchemaName": "abc",
                "TableName": "abc",
                "DataVersion": 0,
                "Name": "abc",
                "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",
                "Params": [
                    {
                        "Key": "abc",
                        "Value": "abc"
                    }
                ],
                "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,
                            "IsPartition": true,
                            "BizParams": [],
                            "Params": []
                        }
                    ],
                    "SortColumns": [
                        {
                            "Col": "abc",
                            "Order": 0
                        }
                    ]
                }
            }
        ],
        "Total": 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。

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	内部错误。
InvalidParameter	参数错误。
ResourceNotFound	资源不存在。
UnauthorizedOperation	未授权操作。