huawei-cloud-api-definitions-DataArtsStudio 0.1.20250411

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json;charset=UTF-8\"]","definitions":{"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"},"CatalogAttributeVO":{"properties":{"alias":{"description":"别名。","type":"string"},"createBy":{"description":"创建人。","type":"string"},"createTime":{"description":"创建时间,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。","type":"string"},"dataOwner":{"description":"数据主体。","type":"string"},"dataOwnerList":{"description":"数据主体列表。","items":{"type":"string"},"type":"array"},"description":{"description":"描述。","type":"string"},"l1":{"description":"是否为L1层。主题域分组。","type":"boolean"},"l2":{"description":"是否为L2层。主题域。","type":"boolean"},"l3":{"description":"是否为L3层。业务对象。","type":"boolean"},"level":{"description":"主题所属层级。","type":"string"},"name":{"description":"名称。","type":"string"},"nameEng":{"description":"英文名称。","type":"string"},"ordinal":{"description":"顺序编号。主题返回时根据此编号由小到大排序。","type":"integer"},"owner":{"description":"责任人。","type":"string"},"parent":{"description":"父节点。","properties":{"id":{"description":"父节点ID。","type":"string"}},"type":"object"},"parentId":{"description":"父节点ID。","type":"string"},"path":{"description":"路径。用“/”作为分隔,如:运营领域/云学院/云学院培训方案。","type":"string"},"qualifiedName":{"description":"资产名称。","type":"string"},"self_defined_fields":{"description":"自定义项。主题的自定义属性项。","items":{"$ref":"#/definitions/SelfDefinedFieldVO"},"maxItems":10,"type":"array"},"tenantId":{"description":"租户ID。获取方式参考此接口的路径参数“project_id”获取。","type":"string"},"updateBy":{"description":"更新人。","type":"string"},"updateTime":{"description":"更新时间,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。","type":"string"}},"required":["path","qualifiedName","level","name","nameEng","description","dataOwnerList","dataOwner"],"type":"object"},"CatalogEntityVO":{"properties":{"attributes":{"$ref":"#/definitions/CatalogAttributeVO","description":"属性列表。"},"typeName":{"default":"BusinessCatalog","description":"类型名称,填写“BusinessCatalog”即可(业务分层)。","type":"string"}},"required":["attributes"],"type":"object"},"CatalogParamsVO":{"example":{"entity":{"attributes":{"alias":"demo","dataOwner":"","dataOwnerList":["ei_dlg"],"description":"","level":"L3","name":"wewe","nameEng":"wewe","parent":{"id":"864523016602812416"},"path":"we","qualifiedName":"wewe@Business"},"typeName":"BusinessCatalog"}},"properties":{"entity":{"$ref":"#/definitions/CatalogEntityVO","description":"catalog实体。"}},"required":["entity"],"type":"object"},"CatalogVO":{"description":"主题目录。","properties":{"alias":{"description":"别名。","type":"string"},"children":{"description":"下层子目录,只读。","items":{"$ref":"#/definitions/CatalogVO"},"readOnly":true,"type":"array"},"children_num":{"description":"拥有子流程的数量,不包括子流程的子流程,前端不传。","type":"integer"},"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_department":{"description":"数据域。","type":"string"},"data_owner":{"description":"数据所有者。","type":"string"},"data_owner_list":{"description":"数据所有者集合。","type":"string"},"description":{"description":"描述信息。","maxLength":2000,"type":"string"},"from_public":{"description":"是否来自公共层。","type":"boolean"},"guid":{"description":"guid,自动生成。","type":"string"},"id":{"description":"主题ID,ID字符串。","type":"string"},"level":{"description":"层级信息。","type":"integer"},"name_ch":{"description":"中文名称。","maxLength":600,"type":"string"},"name_en":{"description":"英文名称。","maxLength":600,"type":"string"},"new_biz":{"$ref":"#/definitions/BizVersionManageVO"},"ordinal":{"description":"序号。","type":"integer"},"owner":{"description":"责任人。","maxLength":4000,"type":"string"},"parent_id":{"description":"父目录ID,木有则为根目录,ID字符串。","type":"string"},"path":{"description":"路径信息。","type":"string"},"qualified_id":{"description":"认证ID,自动生成。","type":"string"},"qualified_name":{"description":"扩展名。","type":"string"},"self_defined_fields":{"description":"属性自定义项。","items":{"$ref":"#/definitions/SelfDefinedFieldVO"},"maxItems":10,"type":"array"},"status":{"$ref":"#/definitions/BizStatusEnum"},"swap_order_id":{"description":"同层排序,目标节点的ID,ID字符串。","type":"string"},"update_by":{"description":"更新人。","type":"string"},"update_time":{"description":"更新时间,只读,格式遵循RFC3339,精确到秒,UTC时区,即yyyy-mm-ddTHH:MM:SSZ,如1970-01-01T00:00:00Z。","format":"date-time","readOnly":true,"type":"string"}},"type":"object"},"CreateSubjectResult":{"description":"创建主题,创建结果。","properties":{"data":{"description":"data,统一的返回结果的最外层数据结构。","properties":{"value":{"$ref":"#/definitions/CatalogVO","description":"value,统一的返回结果的外层数据结构。","type":"object"}},"type":"object"}},"type":"object"},"SelfDefinedFieldVO":{"description":"表自定义项。","properties":{"fd_name_ch":{"description":"自定义项中文名。","maxLength":200,"type":"string"},"fd_name_en":{"description":"自定义项英文名。","maxLength":200,"type":"string"},"fd_value":{"description":"属性值。","type":"string"},"not_null":{"description":"是否必填。","type":"boolean"}},"type":"object"}},"description":null,"group_id":"23bb69798aaf409da161a43a90617121","host":"dayu.cn-north-4.myhuaweicloud.com","id":"94c6af21693f448ca1f2f70761fae85c","info_version":"v1","method":"post","name":"CreateSubject","parameters":{"contextTypeParam":{"description":"默认值:application/json;charset=UTF-8\n可选,有Body体的情况下必选,没有Body体则无需填写和校验。","in":"header","maxLength":64,"minLength":3,"name":"Content-Type","required":false,"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/subjects":{"post":{"description":"创建主题。","operationId":"CreateSubject","parameters":[{"$ref":"#/parameters/tokenParam"},{"$ref":"#/parameters/workspaceParam"},{"$ref":"#/parameters/tenantIdParam"},{"$ref":"#/parameters/tenantXIdParam"},{"$ref":"#/parameters/contextTypeParam"},{"description":"catalog参数。","in":"body","name":"CreateSubjectRequestBody","required":true,"schema":{"$ref":"#/definitions/CatalogParamsVO"}}],"produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"Success,返回data数据是entity详情。","schema":{"$ref":"#/definitions/CreateSubjectResult"}},"400":{"$ref":"#/responses/400"},"401":{"$ref":"#/responses/401"},"403":{"$ref":"#/responses/403"},"404":{"$ref":"#/responses/404"}},"summary":"创建主题","tags":["主题管理接口"],"x-api-type":"doc-open","x-is-registered":"Y","x-request-examples-1":{"entity":{"attributes":{"alias":"","createTime":1713576437311,"dataOwner":"dataOwner","dataOwnerList":["ei_dayu_y00321344_01"],"description":"this is a demo.","level":"L1","name":"test_create_catalog","nameEng":"test_create_catalog","path":"test_create_catalog","qualifiedName":"test_create_catalog@Business","self_defined_fields":[],"updateTime":1713576437311},"typeName":"BusinessCatalog"}},"x-request-examples-description-1":"根据请求参数创建主题。","x-request-examples-url-1":"POST https://{endpoint}/v2/{project_id}/design/subjects","x-support-sdk":"Y"}}},"product_short":"DataArtsStudio","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建主题","tags":"主题管理接口","uri":null,"version":"2.0"}