获取数据详情 - getDataset
功能介绍
本接口用于获取数据集详情。
调用方法
请参见如何调用API。
URI
GET /v1/agents/datasets/{dataset_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
dataset_id |
是 |
String |
数据集id。 支持数字，英文字母，下划线，长度32。 样例：2257599e68e74b648185da2d90ee3f26 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用接口获取用户Token接口获取。 |
|
X-Language |
是 |
String |
根据自己偏好的语言来获取不同语言的返回内容,zh-cn或者en_us |
|
Content-Type |
是 |
String |
消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
数据集id。 支持数字，英文字母，下划线，长度0-32 |
|
name |
String |
数据集名称。 支持英文字母，数字，下划线，特殊符号，只能以英文字母开头，特殊符号不包括?!.*?_$ 长度0-128 |
|
description |
String |
描述 |
|
columns |
Array of AgDatasetColumnVo objects |
数据集字段信息 |
|
connector_id |
String |
连接器id。 支持数字，英文字母，下划线，长度0-32 |
|
connector_name |
String |
连接器名称。 支持英文字母，数字，下划线，特殊符号，只能以英文字母开头，特殊符号不包括?!.*?_$ 长度0-128 |
|
data_type |
String |
连接器数据类型 1.RDS--云数据库类型 2.MYSQL--MySQL类型 3.DWS--高斯数据库类型 4.MRS--MapReduce数据类型 5.ORACLE--ORACLE数据类型 6.LOCAL_CSV--本地数据类型 |
|
ag_dataset_table |
AgDatasetTableVo object |
数据集表信息 |
|
ag_dataset_local |
AgDatasetLocalVo object |
本地数据集信息 |
|
ext_columns |
Array of AgDatasetColumnVo objects |
额外字段信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data_id |
String |
数据集id。 支持数字，英文字母，下划线，长度0-32 |
|
db_schema |
String |
schema名称 |
|
table_name |
String |
表名 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data_id |
String |
数据集id。 支持数字，英文字母，下划线，长度0-32 |
|
file_type |
String |
数据集类型 |
|
delimiter |
String |
csv文件分隔符 |
|
is_header_exist |
Boolean |
数据文件是否包含表头 |
|
data_file_path |
String |
数据文件地址 |
|
id_file_path |
String |
id文件地址 |
|
config_file_path |
String |
配置文件地址 |
|
auto_generate_data |
Boolean |
是否自动生成数据，即纵向联邦学习样本对齐之后的流程是否使用样本对其结果自动过滤。 |
|
ext |
LocalDatasetExtEntity object |
扩展信息，包含multihot配置信息，样例："[{"features":"x1,x2,x3","field_size":50},{"features":"x4,x5,x6","field_size":120}]" |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
features |
Array of strings |
用“,”连接的一组MultiHot特征 |
|
field_size |
Integer |
一组特征的取值种类总数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
comments |
String |
字段备注 |
|
data_id |
String |
数据集id。 支持数字，英文字母，下划线，长度0-32。 |
|
column_name |
String |
字段名称 |
|
data_type |
String |
字段类型 |
|
sql_col_privacy_type |
String |
sql数据集字段隐私分类。 1.UNIQUE_ID--唯一标识 2.SENSITIVE--敏感 3.NON_SENSITIVE--非敏感 |
|
fl_label_type |
String |
联邦学习字段标签分类 |
|
privacy_policy |
String |
字段数据处理隐私策略。 1.MASK--掩码 2.NONE--不处理 |
|
privacy_policy_ext |
String |
字段数据隐私处理具体描述 |
|
feature_type |
String |
特征类型 1.CONTINUOUS--连续型 2.DISCRETE--离散型 3.MULTIHOT--multihot型 |
|
field_size |
Integer |
只有离散类型特征支持该属性，表示离散特征取值范围 |
请求示例
获取数据集详情
get https://x.x.x.x:12345/v1/agents/datasets/{dataset_id}
响应示例
状态码：200
获取数据详情成功
{
"id" : "d839d96befe74d5d8ae74689cfdad2e1",
"name" : "rds_test",
"description" : "is a test",
"columns" : [ {
"comments" : "企业号（企业社会信用代码）",
"data_id" : "d839d96befe74d5d8ae74689cfdad2e1",
"column_name" : "credit_no",
"data_type" : "STRING",
"sql_col_privacy_type" : "NON_SENSITIVE",
"privacy_policy" : "NONE"
}, {
"comments" : "企业名称",
"data_id" : "d839d96befe74d5d8ae74689cfdad2e1",
"column_name" : "ent_name",
"data_type" : "STRING",
"sql_col_privacy_type" : "NON_SENSITIVE",
"privacy_policy" : "NONE"
} ],
"connector_id" : "49dd0fc0bae2402c8824154f5896317f",
"connector_name" : "rds",
"data_type" : "RDS",
"ag_dataset_table" : {
"data_id" : "d839d96befe74d5d8ae74689cfdad2e1",
"db_schema" : "demo1",
"table_name" : "dim_enterprise"
},
"ext_columns" : [ ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
获取数据详情成功 |
|
401 |
操作无权限 |
|
500 |
内部服务器错误 |
