Obtaining Model Statistics
Function
This API is used to obtain model statistics.
URI
GET /v2/{project_id}/design/table-models/statistic
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
model_id |
No |
Long |
Model ID used to query the workspace |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
total |
StatisticStandardCoverageVO object |
Number of logical entities |
|
published |
StatisticStandardCoverageVO object |
Number of published logical entities |
|
sync_total |
SyncStatusStatisticVO object |
Overall synchronization status |
|
physical_table |
SyncStatusStatisticVO object |
Table creation status |
|
technical_asset |
SyncStatusStatisticVO object |
Technical asset synchronization status |
|
business_asset |
SyncStatusStatisticVO object |
Logical asset synchronization status |
|
meta_data_link |
SyncStatusStatisticVO object |
Asset association status |
|
data_quality |
SyncStatusStatisticVO object |
Quality job status |
|
Parameter |
Type |
Description |
|---|---|---|
|
all_col_num |
Long |
Total number of fields |
|
col_num |
Long |
Number of associated standard fields |
|
coverage |
Double |
Standard coverage rate |
|
details |
Array of AllTableVO objects |
Overview table |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
Long |
l1 ID |
|
name |
String |
L1 name |
|
tb_logic_guid |
String |
GUID of the logical entity corresponding to the published table |
|
quality_id |
String |
Quality ID |
|
reversed |
Boolean |
Whether the table is reversed Default: false |
|
partition_conf |
String |
Partition expression |
|
dirty_out_switch |
Boolean |
Whether to export dirty data Default: false |
|
dirty_out_database |
String |
Database to which dirty data will be exported |
|
dirty_out_prefix |
String |
Prefix of an abnormal table |
|
dirty_out_suffix |
String |
Suffix of an abnormal table |
|
tb_guid |
String |
GUID of the physical table corresponding to the published table |
|
code |
String |
Code |
|
create_by |
String |
Creator |
|
tenant_id |
String |
Tenant ID |
|
description |
String |
Description Maximum: 200 |
|
status |
String |
Business statuses Enumeration values:
|
|
biz_type |
String |
Business types Enumeration values:
|
|
create_time |
String |
Creation time |
|
update_time |
String |
Update time |
|
db_name |
String |
Database name |
|
dw_type |
String |
Data connection type |
|
queue_name |
String |
Queue required for a DLI data connection to execute SQL statements. This parameter is mandatory for DLI data connections. |
|
schema |
String |
Schema, which is required for DWS |
|
l1 |
String |
Subject area group |
|
l2 |
String |
Subject area |
|
l3 |
String |
Business object |
|
l1_id |
Long |
Subject area group ID |
|
l2_id |
String |
Subject area ID |
|
l3_id |
Long |
Business object ID |
|
new_biz |
BizVersionManageVO object |
Business version management |
|
physical_table |
String |
Table creation status Enumeration values:
|
|
technical_asset |
String |
Technical asset synchronization status Enumeration values:
|
|
business_asset |
String |
Logical asset synchronization status Enumeration values:
|
|
meta_data_link |
String |
Asset association status Enumeration values:
|
|
data_quality |
String |
Quality job status Enumeration values:
|
|
dlf_task |
String |
Data development job status Enumeration values:
|
|
materialization |
String |
Storage status of the lookup table value Enumeration values:
|
|
publish_to_dlm |
String |
DLM API generation status Enumeration values:
|
|
summary_status |
String |
Overall synchronization status Enumeration values:
|
|
standard_count |
Long |
Number of standards |
|
alias |
String |
Alias |
|
api_id |
String |
Summary table API ID |
|
workspace_id |
String |
Workspace ID |
|
workspace_name |
String |
Workspace name |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
Long |
ID information |
|
biz_type |
String |
Business types Enumeration values:
|
|
biz_id |
Long |
Business ID |
|
biz_info |
String |
Business object information |
|
status |
String |
Business statuses Enumeration values:
|
|
biz_version |
Integer |
Business version |
|
create_time |
String |
Creation time |
|
update_time |
String |
Update time |
|
Parameter |
Type |
Description |
|---|---|---|
|
success |
Long |
Successful |
|
failed |
Long |
Failed |
|
running |
Long |
Synchronizing |
|
other |
Long |
Unsynchronized |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code, for example, DS.000 which indicates that the request was successfully processed. |
|
error_msg |
String |
Error message |
|
data |
Object |
Returned data |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code, for example, DS.000 which indicates that the request was successfully processed. |
|
error_msg |
String |
Error message |
|
data |
Object |
Returned data |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code, for example, DS.000 which indicates that the request was successfully processed. |
|
error_msg |
String |
Error message |
|
data |
Object |
Returned data |
Example Requests
None
Example Responses
Status code: 200
The operation succeeds. TableModelStatisticVO is returned.
{
"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"
}
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
The operation succeeds. TableModelStatisticVO is returned. |
|
400 |
BadRequest |
|
401 |
Unauthorized |
|
403 |
Forbidden |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.