模型统计信息
功能介绍
单个模型中的统计信息。
调用方法
请参见如何调用API。
URI
GET /v2/{project_id}/design/table-models/statistic
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方法请参见项目ID和账号ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
model_id |
否 |
String |
依据关系建模的模型ID查询统计信息，ID字符串。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
IAM Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） 使用Token认证时必选。 |
|
workspace |
是 |
String |
工作空间ID，获取方法请参见实例ID和工作空间ID。 |
|
X-Project-Id |
否 |
String |
项目ID，获取方法请参见项目ID和账号ID。 多project场景采用AK/SK认证的接口请求，则该字段必选。 |
|
Content-Type |
否 |
String |
默认值：application/json;charset=UTF-8 可选，有Body体的情况下必选，没有Body体则无需填写和校验。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
data object |
data，统一的返回结果的最外层数据结构。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
StatisticStandardCoverageVO object |
逻辑实体数量。 |
|
published |
StatisticStandardCoverageVO object |
已发布逻辑实体数量。 |
|
sync_total |
SyncStatusStatisticVO object |
同步整体状态。 |
|
physical_table |
SyncStatusStatisticVO object |
创建表状态。 |
|
technical_asset |
SyncStatusStatisticVO object |
技术资产同步状态。 |
|
business_asset |
SyncStatusStatisticVO object |
业务资产同步状态。 |
|
meta_data_link |
SyncStatusStatisticVO object |
资产关联状态。 |
|
data_quality |
SyncStatusStatisticVO object |
质量作业状态。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
all_col_num |
String |
字段总数，ID字符串。 |
|
col_num |
String |
关联标准字段数，ID字符串。 |
|
coverage |
Double |
标准覆盖率。 |
|
details |
Array of AllTableVO objects |
引用表数组。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
l1的ID，ID字符串。 |
|
name |
String |
l1名称。 |
|
tb_logic_guid |
String |
表发布后对应的逻辑实体guid。 |
|
quality_id |
String |
质量ID。 |
|
reversed |
Boolean |
是否是逆向的。 |
|
partition_conf |
String |
分区表达式。 |
|
dirty_out_switch |
Boolean |
异常数据输出开关。 |
|
dirty_out_database |
String |
异常数据输出库。 |
|
dirty_out_prefix |
String |
异常表前缀。 |
|
dirty_out_suffix |
String |
异常表后缀。 |
|
tb_guid |
String |
表发布后对应的物理表guid。 |
|
code |
String |
编码。 |
|
create_by |
String |
创建人。 |
|
tenant_id |
String |
租户ID。 |
|
description |
String |
描述。 |
|
status |
String |
实体的发布状态，只读，创建和更新时无需填写。 枚举值：
|
|
biz_type |
String |
业务实体类型。 枚举值：
|
|
create_time |
String |
创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 |
|
update_time |
String |
更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 |
|
db_name |
String |
数据库名。 |
|
dw_type |
String |
数据连接类型，对应表所在的数仓类型，取值可以为DWS、MRS_HIVE、POSTGRESQL、MRS_SPARK、CLICKHOUSE、MYSQL、ORACLE和DORIS等。 |
|
queue_name |
String |
dli数据连接执行sql所需的队列，数据连接类型为DLI时必须。 |
|
schema |
String |
DWS类型需要。 |
|
l1 |
String |
主题域分组中文名，只读，创建和更新时无需填写。 |
|
l2 |
String |
主题域中文名，只读，创建和更新时无需填写。 |
|
l3 |
String |
业务对象中文名，只读，创建和更新时无需填写。 |
|
l1_id |
String |
主题域分组ID，只读，ID字符串。 |
|
l2_id |
String |
主题域ID，只读，创建和更新时无需填写。 |
|
l3_id |
String |
业务对象ID，只读，ID字符串。 |
|
new_biz |
BizVersionManageVO object |
业务版本管理，只读。 |
|
physical_table |
String |
同步状态。 枚举值：
|
|
dev_physical_table |
String |
同步状态。 枚举值：
|
|
technical_asset |
String |
同步状态。 枚举值：
|
|
business_asset |
String |
同步状态。 枚举值：
|
|
meta_data_link |
String |
同步状态。 枚举值：
|
|
data_quality |
String |
同步状态。 枚举值：
|
|
dlf_task |
String |
同步状态。 枚举值：
|
|
materialization |
String |
同步状态。 枚举值：
|
|
publish_to_dlm |
String |
同步状态。 枚举值：
|
|
summary_status |
String |
同步状态。 枚举值：
|
|
standard_count |
String |
标准数量，只读，ID字符串。 |
|
alias |
String |
别名。 |
|
api_id |
String |
汇总表API ID。 |
|
workspace_id |
String |
工作空间ID。 |
|
workspace_name |
String |
工作空间名称。 |
|
dev_version |
String |
开发环境版本，只读，ID字符串。 |
|
prod_version |
String |
生产环境版本，只读，ID字符串。 |
|
dev_version_name |
String |
开发环境版本名称，只读。 |
|
prod_version_name |
String |
生产环境版本名称，只读。 |
|
env_type |
String |
开发生产环境类型。 枚举值：
|
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
ID信息，ID字符串。 |
|
biz_type |
String |
业务实体类型。 枚举值：
|
|
biz_id |
String |
业务ID，ID字符串。 |
|
biz_info |
String |
业务对象信息。 |
|
status |
String |
实体的发布状态，只读，创建和更新时无需填写。 枚举值：
|
|
biz_version |
Integer |
业务版本，只读。 |
|
create_time |
String |
创建时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 |
|
update_time |
String |
更新时间，只读，格式遵循RFC3339，精确到秒，UTC时区，即yyyy-mm-ddTHH:MM:SSZ，如1970-01-01T00:00:00Z。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
success |
String |
成功数，ID字符串。 |
|
failed |
String |
失败数，ID字符串。 |
|
running |
String |
同步中，ID字符串。 |
|
other |
String |
未同步数，ID字符串。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，如DS.6000，请求处理失败。 |
|
error_msg |
String |
错误信息。 |
|
data |
Object |
返回的数据信息。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，如DS.6000，请求处理失败。 |
|
error_msg |
String |
错误信息。 |
|
data |
Object |
返回的数据信息。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码，如DS.6000，请求处理失败。 |
|
error_msg |
String |
错误信息。 |
|
data |
Object |
返回的数据信息。 |
请求示例
关系建模统计信息。
GET https://{endpoint}/v2/{project_id}/design/table-models/statistic响应示例
状态码：200
Success，返回data数据是TableModelStatisticVO信息。
{
"data" : {
"value" : {
"total" : {
"all_col_num" : "2",
"col_num" : "20",
"coverage" : 0.15,
"details" : null
},
"published" : {
"all_col_num" : "2",
"col_num" : "20",
"coverage" : 0.15,
"details" : null
},
"sync_total" : {
"success" : "1",
"failed" : "1",
"running" : "0",
"other" : "0"
},
"physical_table" : {
"success" : "2",
"failed" : "0",
"running" : "0",
"other" : "0"
},
"technical_asset" : {
"success" : "1",
"failed" : "1",
"running" : "0",
"other" : "0"
},
"business_asset" : {
"success" : "2",
"failed" : "0",
"running" : "0",
"other" : "0"
},
"meta_data_link" : {
"success" : "1",
"failed" : "1",
"running" : "0",
"other" : "0"
},
"data_quality" : {
"success" : "2",
"failed" : "0",
"running" : "0",
"other" : "0"
}
}
}
}状态码：400
BadRequest
{
"error_code" : "DS.60xx",
"error_msg" : "The user request is illegal."
}状态码：401
Unauthorized
{
"error_code" : "DS.60xx",
"error_msg" : "User authentication failed."
}状态码：403
Forbidden
{
"error_code" : "DS.60xx",
"error_msg" : "The user does not have permission to call this API."
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Success，返回data数据是TableModelStatisticVO信息。 |
|
400 |
BadRequest |
|
401 |
Unauthorized |
|
403 |
Forbidden |
