Model Statistics
Function
Statistics in a single model.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/design/table-models/statistic
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain the project ID, see Project ID and Account ID. |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| model_id | No | String | ID of the relational model based on which statistics are queried. The ID is a string. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This field is mandatory for authentication using tokens. |
| workspace | Yes | String | Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID. |
| X-Project-Id | No | String | Project ID. For details about how to obtain the project ID, see Project ID and Account ID. This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios. |
| Content-Type | No | String | Default value: application/json;charset=UTF-8 This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| data | data object | data: unified outermost data structure of the returned result. |
| Parameter | Type | Description |
|---|---|---|
| value | TableModelStatisticVO object | value: unified outer data structure of the returned result. |
| Parameter | Type | Description |
|---|---|---|
| total | StatisticStandardCoverageVO object | Number of logical entities. |
| published | StatisticStandardCoverageVO object | Number of released logical entities. |
| sync_total | SyncStatusStatisticVO object | Indicates the overall synchronization status. |
| physical_table | SyncStatusStatisticVO object | Table creation status. |
| technical_asset | SyncStatusStatisticVO object | Synchronization status of technology assets. |
| business_asset | SyncStatusStatisticVO object | Service asset synchronization status. |
| meta_data_link | SyncStatusStatisticVO object | Asset association status. |
| data_quality | SyncStatusStatisticVO object | Quality job status. |
| Parameter | Type | Description |
|---|---|---|
| all_col_num | String | Total number of fields, which is a string |
| col_num | String | Number of associated standard fields, which is a string |
| coverage | Double | Standard coverage. |
| details | Array of AllTableVO objects | Array of reference tables. |
| Parameter | Type | Description |
|---|---|---|
| id | String | L1 ID, which is a string |
| name | String | L1 name. |
| tb_logic_guid | String | GUID of the logical entity after the table is released. |
| quality_id | String | Quality ID. |
| reversed | Boolean | Indicates whether it is reverse. |
| partition_conf | String | Partition expression. |
| dirty_out_switch | Boolean | Indicates whether to output abnormal data. |
| dirty_out_database | String | Abnormal data output library. |
| dirty_out_prefix | String | Prefix of an exception table. |
| dirty_out_suffix | String | Suffix of an exception table. |
| tb_guid | String | GUID of the physical table after the table is released. |
| code | String | Code. |
| create_by | String | Creator. |
| tenant_id | String | Tenant ID. |
| description | String | Description. |
| status | String | Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
| biz_type | String | Business entity type. Options:
|
| create_time | String | Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
| update_time | String | Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
| db_name | String | Indicates the database name. |
| dw_type | String | Data connection type, which corresponds to the type of the data warehouse where the table is located. The value can be DWS, MRS_HIVE, POSTGRESQL, MRS_SPARK, CLICKHOUSE, MYSQL, ORACLE, or DORIS. |
| queue_name | String | Queue required for executing SQL statements through the DLI data connection. This parameter is mandatory when the data connection type is DLI. |
| schema | String | Required by the DWS type. |
| l1 | String | Chinese name of the subject area group. This parameter is read-only and does not need to be set when you create or update a subject area group. |
| l2 | String | Chinese name of the subject area. This parameter is read-only and does not need to be set during creation and update. |
| l3 | String | Chinese name of the business object. This parameter is read-only and does not need to be set during creation and update. |
| l1_id | String | Subject area group ID, which is a read-only string |
| l2_id | String | Subject area ID. This parameter is read-only and does not need to be set during creation and update. |
| l3_id | String | Business object ID, which is a read-only string |
| new_biz | BizVersionManageVO object | Service version management. This parameter is read-only. |
| physical_table | String | Synchronization status. Options:
|
| dev_physical_table | String | Synchronization status. Options:
|
| technical_asset | String | Synchronization status. Options:
|
| business_asset | String | Synchronization status. Options:
|
| meta_data_link | String | Synchronization status. Options:
|
| data_quality | String | Synchronization status. Options:
|
| dlf_task | String | Synchronization status. Options:
|
| materialization | String | Synchronization status. Options:
|
| publish_to_dlm | String | Synchronization status. Options:
|
| summary_status | String | Synchronization status. Options:
|
| standard_count | String | Standard quantity, which is a read-only string |
| alias | String | Alias |
| api_id | String | API ID of the SDR table. |
| workspace_id | String | Workspace ID |
| workspace_name | String | Workspace name |
| dev_version | String | Development environment version, which is a read-only string |
| prod_version | String | Production environment version, which is a read-only string |
| dev_version_name | String | Version name of the development environment, which is read-only |
| prod_version_name | String | Version name of the production environment, which is read-only |
| env_type | String | Type of the development and production environment. Options:
|
| Parameter | Type | Description |
|---|---|---|
| id | String | Field ID, which is a string |
| biz_type | String | Business entity type. Options:
|
| biz_id | String | Business ID, which is a string |
| biz_info | String | Business object information. |
| status | String | Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
| biz_version | Integer | Service version, which is read-only. |
| create_time | String | Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
| update_time | String | Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
| Parameter | Type | Description |
|---|---|---|
| success | String | Number of synchronized data records, which is a string |
| failed | String | Number of failures, which is a string |
| running | String | Number of data records being synchronized, which is a string |
| other | String | Number of unsynchronized data records, which is a string |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code, for example, DS.6000, indicating that the request fails to be processed. |
| error_msg | String | Error message |
| data | Object | Returned data information. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code, for example, DS.6000, indicating that the request fails to be processed. |
| error_msg | String | Error message |
| data | Object | Returned data information. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code, for example, DS.6000, indicating that the request fails to be processed. |
| error_msg | String | Error message |
| data | Object | Returned data information. |
Example Requests
Relational modeling statistics.
GET https://{endpoint}/v2/{project_id}/design/table-models/statistic Example Responses
Status code: 200
This operation succeeds, and the returned data is 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"
}
}
}
} Status code: 400
BadRequest
{
"error_code" : "DS.60xx",
"error_msg" : "The user request is illegal."
} Status code: 401
Unauthorized
{
"error_code" : "DS.60xx",
"error_msg" : "User authentication failed."
} Status code: 403
Forbidden
{
"error_code" : "DS.60xx",
"error_msg" : "The user does not have permission to call this API."
} Status Codes
| Status Code | Description |
|---|---|
| 200 | This operation succeeds, and the returned data is TableModelStatisticVO. |
| 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.
