数据湖计算 DLC
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 数据湖计算 DLC > API 文档 > 元数据相关接口 > DMS元数据获取库

DMS元数据获取库

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

我的收藏

本页目录：

1. 接口描述

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

DMS元数据获取库

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeDMSDatabase。
Version 是 String 公共参数，本接口取值：2021-01-25。
Region 是 String 公共参数，详见产品支持的 地域列表。
Name 否 String 数据库名称
示例值：name
SchemaName 否 String schema名称
示例值：xxxx
Pattern 否 String 匹配规则
示例值：*

3. 输出参数

参数名称 类型 描述
Name String 数据库名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：n1
SchemaName String schema名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：schema1
Location String 存储地址
注意：此字段可能返回 null，表示取不到有效值。
示例值：cosn://123
Asset Asset 数据对象
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DMS元数据获取库

输入示例

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

{
    "Name": "Name1",
    "SchemaName": "Schema1",
    "Pattern": "*"
}

输出示例

{
    "Response": {
        "RequestId": "xx",
        "Name": "Name1",
        "SchemaName": "Schema1",
        "Location": "cosn://123",
        "Asset": {
            "Id": 1,
            "Name": "Name1",
            "Guid": "xxxx-xxxx-xxx-xxx",
            "Catalog": "DataLakeCatalog",
            "Description": "Description",
            "Owner": "root",
            "OwnerAccount": "root",
            "PermValues": [
                {
                    "Key": "key1",
                    "Value": "v1"
                }
            ],
            "Params": [
                {
                    "Key": "key1",
                    "Value": "v1"
                }
            ],
            "BizParams": [
                {
                    "Key": "key1",
                    "Value": "v1"
                }
            ],
            "DataVersion": 1,
            "CreateTime": "2021-01-01 12:12:12",
            "ModifiedTime": "2021-01-01 12:12:12",
            "DatasourceId": 1
        }
    }
}

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 未授权操作。
中国站