huawei-cloud-api-definitions-DataArtsStudio 0.1.20250411

{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"AllTableVO":{"description":"总览表。","properties":{"alias":{"description":"别名。","type":"string"},"api_id":{"description":"汇总表API ID。","type":"string"},"biz_type":{"$ref":"#/definitions/BizTypeEnum"},"business_asset":{"$ref":"#/definitions/SyncStatusEnum","description":"业务资产同步状态,只读。","readOnly":true},"code":{"description":"编码。","type":"string"},"create_by":{"description":"创建人。","type":"string"},"create_time":{"description":"创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。","format":"date-time","readOnly":true,"type":"string"},"data_quality":{"$ref":"#/definitions/SyncStatusEnum","description":"质量作业状态,只读。","readOnly":true},"db_name":{"description":"数据库名。","type":"string"},"description":{"description":"描述。","maxLength":200,"type":"string"},"dev_physical_table":{"$ref":"#/definitions/SyncStatusEnum","description":"开发环境创建表状态","readOnly":true},"dev_version":{"description":"开发环境版本,ID字符串。","readOnly":true,"type":"string"},"dev_version_name":{"description":"开发环境版本名称","readOnly":true,"type":"string"},"dirty_out_database":{"description":"异常数据输出库。","type":"string"},"dirty_out_prefix":{"description":"异常表前缀。","type":"string"},"dirty_out_suffix":{"description":"异常表后缀。","type":"string"},"dirty_out_switch":{"default":false,"description":"异常数据输出开关。","type":"boolean"},"dlf_task":{"$ref":"#/definitions/SyncStatusEnum","description":"数据开发作业状态,只读。","readOnly":true},"dw_type":{"$ref":"#/definitions/DwType","description":"数据连接类型,只读。","readOnly":true},"env_type":{"$ref":"#/definitions/EnvTypeEnum","readOnly":true},"id":{"description":"l1的ID,ID字符串。","type":"string"},"l1":{"$ref":"#/definitions/l1","description":"主题域分组。"},"l1_id":{"description":"主题域分组ID,只读,ID字符串。","readOnly":true,"type":"string"},"l2":{"$ref":"#/definitions/l2","description":"主题域。"},"l2_id":{"$ref":"#/definitions/l2_id","description":"主题域ID。"},"l3":{"$ref":"#/definitions/l3","description":"业务对象。"},"l3_id":{"description":"业务对象ID,只读,ID字符串。","readOnly":true,"type":"string"},"materialization":{"$ref":"#/definitions/SyncStatusEnum","description":"码表数值落库状态,只读。","readOnly":true},"meta_data_link":{"$ref":"#/definitions/SyncStatusEnum","description":"资产关联状态,只读。","readOnly":true},"name":{"description":"l1名称。","type":"string"},"new_biz":{"$ref":"#/definitions/BizVersionManageVO"},"partition_conf":{"description":"分区表达式。","type":"string"},"physical_table":{"$ref":"#/definitions/SyncStatusEnum","description":"生产环境创建表状态","readOnly":true},"prod_version":{"description":"生产环境版本,ID字符串。","readOnly":true,"type":"string"},"prod_version_name":{"description":"生产环境版本名称","readOnly":true,"type":"string"},"publish_to_dlm":{"$ref":"#/definitions/SyncStatusEnum","description":"DLM API生成状态,只读。","readOnly":true},"quality_id":{"description":"质量ID。","type":"string"},"queue_name":{"description":"dli数据连接执行sql所需的队列,数据连接类型为DLI时必须。","type":"string"},"reversed":{"default":false,"description":"是否是逆向的。","type":"boolean"},"schema":{"description":"DWS类型需要。","type":"string"},"standard_count":{"description":"标准数量,只读,ID字符串。","readOnly":true,"type":"string"},"status":{"$ref":"#/definitions/BizStatusEnum"},"summary_status":{"$ref":"#/definitions/SyncStatusEnum","description":"同步整体状态,只读。","readOnly":true},"tb_guid":{"description":"表发布后对应的物理表guid。","type":"string"},"tb_logic_guid":{"description":"表发布后对应的逻辑实体guid。","type":"string"},"technical_asset":{"$ref":"#/definitions/SyncStatusEnum","description":"技术资产同步状态,只读。","readOnly":true},"tenant_id":{"description":"租户ID。","type":"string"},"update_time":{"description":"更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。","format":"date-time","readOnly":true,"type":"string"},"workspace_id":{"description":"工作空间ID。","type":"string"},"workspace_name":{"description":"工作空间名称。","type":"string"}},"type":"object"},"BizStatusEnum":{"description":"实体的发布状态,只读,创建和更新时无需填写。\n枚举值:\n  - DRAFT: 草稿\n  - PUBLISH_DEVELOPING: 发布待审核\n  - PUBLISHED: 已发布\n  - OFFLINE_DEVELOPING: 下线待审核\n  - OFFLINE: 已下线\n  - REJECT: 已驳回","enum":["DRAFT","PUBLISH_DEVELOPING","PUBLISHED","OFFLINE_DEVELOPING","OFFLINE","REJECT"],"example":"PUBLISHED","readOnly":true,"type":"string"},"BizTypeEnum":{"description":"业务实体类型。\n枚举值:\n - AGGREGATION_LOGIC_TABLE: 汇总表\n - ATOMIC_INDEX: 原子指标\n - ATOMIC_METRIC: 原子指标(新)\n - BIZ_CATALOG: 流程架构目录\n - BIZ_METRIC: 业务指标\n - CODE_TABLE: 码表\n - COMMON_CONDITION: 通用限定\n - COMPOSITE_METRIC: 复合指标(新)\n - COMPOUND_METRIC: 复合指标\n - CONDITION_GROUP: 限定分组\n - DEGENERATE_DIMENSION: 退化维度\n - DERIVATIVE_INDEX: 衍生指标\n - DERIVED_METRIC: 衍生指标(新)\n - DIMENSION: 维度\n - DIMENSION_ATTRIBUTE: 维度属性\n - DIMENSION_HIERARCHIES: 维度层级\n - DIMENSION_LOGIC_TABLE: 维度表\n - DIMENSION_TABLE_ATTRIBUTE: 维度属性\n - DIRECTORY: 目录\n - FACT_ATTRIBUTE: 事实表属性\n - FACT_DIMENSION: 事实表维度\n - FACT_LOGIC_TABLE: 事实表\n - FACT_MEASURE: 事实表度量\n - FUNCTION: 函数\n - INFO_ARCH: 信息架构(批量修改主题使用)\n - MODEL: 模型\n - QUALITY_RULE: 质量规则\n - SECRECY_LEVEL: 密级\n - STANDARD_ELEMENT: 数据标准\n - STANDARD_ELEMENT_TEMPLATE: 数据标准模板\n - SUBJECT: 主题\n - SUMMARY_DIMENSION_ATTRIBUTE: 汇总表维度属性\n - SUMMARY_INDEX: 汇总表指标属性\n - SUMMARY_TIME: 汇总表时间周期属性\n - TABLE_MODEL: 关系模型(逻辑模型/物理模型)\n - TABLE_MODEL_ATTRIBUTE: 关系模型属性(逻辑模型/物理模型)\n - TABLE_MODEL_LOGIC: 逻辑实体\n - TABLE_TYPE: 表类型\n - TAG: 标签\n - TIME_CONDITION: 时间限定","enum":["AGGREGATION_LOGIC_TABLE","ATOMIC_INDEX","ATOMIC_METRIC","BIZ_CATALOG","BIZ_METRIC","CODE_TABLE","COMMON_CONDITION","COMPOSITE_METRIC","COMPOUND_METRIC","CONDITION_GROUP","DEGENERATE_DIMENSION","DERIVATIVE_INDEX","DERIVED_METRIC","DIMENSION","DIMENSION_ATTRIBUTE","DIMENSION_HIERARCHIES","DIMENSION_LOGIC_TABLE","DIMENSION_TABLE_ATTRIBUTE","DIRECTORY","FACT_ATTRIBUTE","FACT_DIMENSION","FACT_LOGIC_TABLE","FACT_MEASURE","FUNCTION","INFO_ARCH","MODEL","QUALITY_RULE","SECRECY_LEVEL","STANDARD_ELEMENT","STANDARD_ELEMENT_TEMPLATE","SUBJECT","SUMMARY_DIMENSION_ATTRIBUTE","SUMMARY_INDEX","SUMMARY_TIME","TABLE_MODEL","TABLE_MODEL_ATTRIBUTE","TABLE_MODEL_LOGIC","TABLE_TYPE","TAG","TIME_CONDITION"],"example":"TABLE_MODE","type":"string"},"BizVersionManageVO":{"default":null,"description":"业务版本管理,只读。","properties":{"biz_id":{"description":"业务ID,ID字符串。","type":"string"},"biz_info":{"description":"业务对象信息。","type":"string"},"biz_type":{"$ref":"#/definitions/BizTypeEnum"},"biz_version":{"description":"业务版本,只读。","readOnly":true,"type":"integer"},"create_time":{"description":"创建时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。","format":"date-time","readOnly":true,"type":"string"},"id":{"description":"ID信息,ID字符串。","type":"string"},"status":{"$ref":"#/definitions/BizStatusEnum"},"update_time":{"description":"更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。","format":"date-time","readOnly":true,"type":"string"}},"readOnly":true,"type":"object"},"CountStandardsResult":{"description":"标准覆盖率统计信息,统计结果。","properties":{"data":{"description":"data,统一的返回结果的最外层数据结构。","properties":{"value":{"$ref":"#/definitions/StatisticStandardCoverageVO","description":"value,统一的返回结果的外层数据结构。","type":"object"}},"type":"object"}},"type":"object"},"DwType":{"description":"数据连接类型,对应表所在的数仓类型,取值可以为DLI、DWS、MRS_HIVE、POSTGRESQL、MRS_SPARK、CLICKHOUSE、MYSQL、ORACLE和DORIS等。","example":"MRS_HIVE","type":"string"},"EnvTypeEnum":{"description":"开发生产环境类型。\n枚举值:\n  - INVALID_TYPE: 无效环境\n  - DEV_TYPE: 开发环境\n  - PROD_TYPE: 生产环境\n  - DEV_PROD_TYPE: 开发生产环境","enum":["INVALID_TYPE","DEV_TYPE","PROD_TYPE","DEV_PROD_TYPE"],"type":"string"},"StatisticStandardCoverageVO":{"properties":{"all_col_num":{"description":"字段总数,ID字符串。","type":"string"},"col_num":{"description":"关联标准字段数,ID字符串。","type":"string"},"coverage":{"description":"标准覆盖率。","format":"double","type":"number"},"details":{"description":"引用表数组。","items":{"$ref":"#/definitions/AllTableVO"},"type":"array"}},"type":"object"},"SyncStatusEnum":{"description":"同步状态。\n枚举值:\n  - NO_NEED: 未同步\n  - CREATE_SUCCESS: 创建成功\n  - CREATE_FAILED: 创建失败\n  - UPDATE_SUCCESS: 更新成功\n  - UPDATE_FAILED: 更新失败\n  - SUMMARY_SUCCESS: 整体成功\n  - SUMMARY_FAILED: 整体失败\n  - RUNNING: 整体运行\n  - OFFLINE: 已下线","enum":["NO_NEED","CREATE_SUCCESS","CREATE_FAILED","UPDATE_SUCCESS","UPDATE_FAILED","SUMMARY_SUCCESS","SUMMARY_FAILED","RUNNING","OFFLINE"],"example":"CREATE_SUCCESS","type":"string"},"l1":{"description":"主题域分组中文名,只读,创建和更新时无需填写。","example":"城市交通","readOnly":true,"type":"string"},"l2":{"description":"主题域中文名,只读,创建和更新时无需填写。","example":"行程记录","readOnly":true,"type":"string"},"l2_id":{"description":"主题域ID,只读,创建和更新时无需填写。","example":"873232716601204736","readOnly":true,"type":"string"},"l3":{"description":"业务对象中文名,只读,创建和更新时无需填写。","example":"标准记录","readOnly":true,"type":"string"}},"description":null,"group_id":"23bb69798aaf409da161a43a90617121","host":"dayu.cn-north-4.myhuaweicloud.com","id":"5b0003845354401fb42e5838ea432914","info_version":"v1","method":"get","name":"CountStandards","parameters":{"bizTypeParam":{"description":"按业务类型查询,可选业务类型有:ATOMIC_INDEX(原子指标)、DERIVATIVE_INDEX(衍生指标)、DIMENSION(维度)、TIME_CONDITION(时间限定)、DIMENSION_LOGIC_TABLE(维度表)、FACT_LOGIC_TABLE(事实表)、AGGREGATION_LOGIC_TABLE(汇总表)、TABLE_MODEL(关系建模表)、CODE_TABLE(码表)、STANDARD_ELEMENT)(数据标准)、BIZ_METRIC(业务指标)、COMPOUND_METRIC(复合指标)、SUBJECT(主题)、ATOMIC_METRIC(原子指标(新))、DERIVED_METRIC(衍生指标(新))、COMPOSITE_METRIC(复合指标(新))。","in":"query","name":"biz_type","required":false,"type":"string"},"contextTypeParam":{"description":"默认值:application/json;charset=UTF-8\n可选,有Body体的情况下必选,没有Body体则无需填写和校验。","in":"header","maxLength":64,"minLength":3,"name":"Content-Type","required":false,"type":"string"},"idParam":{"description":"实体ID,ID字符串。","in":"path","name":"id","required":true,"type":"string"},"tenantIdParam":{"description":"项目ID,获取方法请参见[项目ID和账号ID](projectid_accountid.xml)。","in":"path","maxLength":64,"minLength":3,"name":"project_id","required":true,"type":"string"},"tenantXIdParam":{"description":"项目ID,获取方法请参见[项目ID和账号ID](projectid_accountid.xml)。\n\n多project场景采用AK/SK认证的接口请求,则该字段必选。","in":"header","maxLength":64,"minLength":3,"name":"X-Project-Id","required":false,"type":"string"},"tokenParam":{"description":"IAM Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)\n使用Token认证时必选。","in":"header","maxLength":4096,"minLength":0,"name":"X-Auth-Token","required":true,"type":"string"},"workspaceParam":{"description":"工作空间ID,获取方法请参见[实例ID和工作空间ID](dataartsstudio_02_0350.xml)。","in":"header","maxLength":64,"minLength":3,"name":"workspace","required":true,"type":"string"}},"paths":{"/v2/{project_id}/design/definitions/statistic/{id}":{"get":{"description":"查看某个数据标准在所有模型字段中的覆盖率,即使用该标准的字段占总字段的百分比。","operationId":"CountStandards","parameters":[{"$ref":"#/parameters/tokenParam"},{"$ref":"#/parameters/workspaceParam"},{"$ref":"#/parameters/tenantIdParam"},{"$ref":"#/parameters/tenantXIdParam"},{"$ref":"#/parameters/contextTypeParam"},{"$ref":"#/parameters/idParam"},{"$ref":"#/parameters/bizTypeParam"}],"produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"Success,返回data数据是StatisticStandardCoverageVO信息。","schema":{"$ref":"#/definitions/CountStandardsResult"}},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"}},"summary":"标准覆盖率统计信息","tags":["概览"],"x-api-type":"doc-open","x-is-registered":"Y","x-request-examples-description-1":"查看ID为1186622399320305665的数据标准的表属性覆盖率。","x-request-examples-url-1":"GET https://{endpoint}/v2/{project_id}/design/definitions/statistic/1186622399320305665?biz_type=STANDARD_ELEMENT","x-support-sdk":"Y"}}},"product_short":"DataArtsStudio","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"标准覆盖率统计信息","tags":"概览","uri":null,"version":"2.0"}