更新时间:2025-11-21 GMT+08:00
分享

查询映射列表 - ShowMapperList

功能介绍

查询映射列表

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/mappings/mappers/search

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间ID

取值范围:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

content-type

String

参数解释:

内容类型

  • application/json;charset=UTF-8 普通API请求的类型

约束限制:

不涉及

取值范围:

  • application/json;charset=UTF-8

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

mapping_id

String

映射id

workspace_id

String

映射id

project_id

String

映射id

dataclass_id

String

映射id

datasource_instance_id

String

映射id

status

String

状态(enabled,disabled)

name

String

名称

has_preprocess_rule

Boolean

是否配置预处理规则

start_time

String

开始时间

end_time

String

结束时间

offset

Integer

参数解释:

偏移量

约束限制:

0-10000

取值范围:

不涉及

默认取值:

0

limit

Integer

参数解释:

当前页码

约束限制:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

total

Integer

总数

offset

Integer

参数解释:

偏移量

约束限制:

0-10000

取值范围:

不涉及

默认取值:

0

limit

Integer

参数解释:

当前页码

约束限制:

不涉及

data

Array of DpeMappingContent objects

分类映射信息集合

表5 DpeMappingContent

参数

参数类型

描述

id

String

映射id

name

String

名称

project_id

String

映射id

workspace_id

String

映射id

dataclass_id

String

映射id

dataclass_name

String

数据类名称

mapper_type_id

String

映射id

mapping_id

String

映射id

create_time

String

创建时间

creator_id

String

创建者id

creator_name

String

创建者名称

update_time

String

更新时间

modifier_id

String

修改者id

modifier_name

String

修改者名称

状态码:400

表6 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

响应示例

状态码

状态码

描述

200

查询映射列表响应

400

请求异常返回报文

错误码

请参见错误码

相关文档