ListTagMetaAsset - 获取DataAgent协作空间数据中心添加库表信息

更新时间:
复制为 MD 格式

获取DataAgent协作空间数据中心添加库表信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

Tid

integer

租户 ID。

说明

取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息

3***

TagName

string

标签名字,需要获取 DataAgent 协作空间下的库表信息,传递格式为 sys::DMS-DA::${DataAgentRegionId}::space:${DataAgentWorkspaceId}

sys::DMS-DA::cn-hangzhou::space:abcde

MetaType

string

  • 获取库列表,传递为 META_DATABASE

  • 当获取某个库详情的表列表,传递为 META_TABLE

META_DATABASE

MetaParentId

string

资产对应的父级 MetaId:

  • 当获取 DataAgent 数据中心左侧库列表,此值无需传递

  • 当获取某个库详情的表列表,此值传递为 对应的 dbId

123456

SearchKey

string

搜索关键词,支持模糊搜索。

test

PageNumber

integer

分页参数,第几页。

1

PageSize

integer

分页参数,每页数据量。

50

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931

ErrorCode

string

错误码,请求异常时返回。

UnknownError

ErrorMessage

string

调用失败时,返回的出错信息。

UnknownError

Success

boolean

请求是否成功,返回值如下:

  • true:请求成功

  • false:请求失败

true

Data

array<object>

返回的数据信息。

array<object>

返回的数据信息。

MetaType

string

  • META_DATABASE:库信息

  • META_TABLE:表信息

META_DATABASE

MetaEntityAttrs

object

MetaType=META_DATABASE 时包含如下信息:

  • schemaName:库名,PG 系为 schema 名

  • catalogName:PG 系为库名

  • dbId:DMS dbId

  • instanceResourceId:实例资源 id,如果是 RDS,此值为 RDS 实例 id

  • dbType:DMS dbType MetaType=META_TABLE 时包含如下信息:

  • schemaName:库名,PG 系为 schema 名

  • catalogName:PG 系为库名

  • dbId:DMS dbId

  • dbType:DMS dbType

  • tableName:表名

  • tableSchemaName:表架构名,SQLServer 下才有效

{"schemaName": "test"}

TotalCount

integer

满足条件的记录总数。

100

示例

正常返回示例

JSON格式

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": [
    {
      "MetaType": "META_DATABASE",
      "MetaEntityAttrs": {
        "schemaName": "test"
      }
    }
  ],
  "TotalCount": 100
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情