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":{"DwType":{"description":"数据连接类型,对应表所在的数仓类型,取值可以为DLI、DWS、MRS_HIVE、POSTGRESQL、MRS_SPARK、CLICKHOUSE、MYSQL、ORACLE和DORIS等。","example":"MRS_HIVE","type":"string"},"ModelLevel":{"description":"数据治理分层。\n枚举值:\n  - SDI: 贴源数据层\n  - DWI: 数据整合层\n  - DWR: 数据报告层\n  - DM:  数据集市层","enum":["SDI","DWI","DWR","DM"],"type":"string"},"ShowWorkspaceDetailByIdResult":{"description":"查询物理模型或逻辑模型的工作区空间详情,查询结果。","properties":{"data":{"description":"data,统一的返回结果的最外层数据结构。","properties":{"value":{"$ref":"#/definitions/WorkspaceVO","description":"value,统一的返回结果的外层数据结构。","type":"object"}},"type":"object"}},"type":"object"},"WorkspaceTransformVO":{"properties":{"connection_id":{"description":"转化后物理表所属的数据连接ID。","type":"string"},"database":{"description":"转化后物理表所属的数据库。","type":"string"},"description":{"description":"描述。","maxLength":600,"type":"string"},"dw_type":{"$ref":"#/definitions/DwType"},"ids":{"description":"需要物化的逻辑实体的ID列表,ID字符串。","items":{"type":"string"},"type":"array","uniqueItems":true},"queue":{"description":"转化后物理表所属的队列(仅DLI)。","type":"string"},"schema":{"description":"转化后物理表所属的schema(仅DWS和PostgreSQL)。","type":"string"},"target_model_id":{"description":"所属关系建模的模型ID,ID字符串。","type":"string"},"target_model_name":{"description":"工作区名字。","maxLength":250,"pattern":"^[\\u4e00-\\u9fa5a-zA-Z\\d_]*$","type":"string"},"update_exist_tables":{"default":true,"description":"是否更新已有表。","type":"boolean"}},"required":["dw_type","target_model_name"],"type":"object"},"WorkspaceVO":{"example":{"biz_catalog_ids":null,"create_by":"ei_dgc","create_time":"2022-03-16T15:06:59.333+08:00","databases":null,"description":"this is an example.","dw_type":"UNSPECIFIED","frequent":false,"id":"953670725619867648","is_physical":false,"level":null,"name":"test","top":true,"type":"THIRD_NF","update_by":"ei_dgc","update_time":"2022-03-16T15:06:59.333+08:00"},"properties":{"biz_catalog_ids":{"description":"关联的业务分层的ID列表 {\"l1Ids\":[],\"l2Ids\":[],\"l3Ids\":[]}。","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"},"databases":{"description":"数据库名称数组。","items":{"type":"string"},"type":"array"},"description":{"description":"描述。","maxLength":600,"type":"string"},"dw_type":{"$ref":"#/definitions/DwType"},"frequent":{"default":true,"description":"是否为常用。","type":"boolean"},"id":{"description":"编号,ID字符串。","type":"string"},"is_physical":{"default":true,"description":"是否为物理表。","type":"boolean"},"level":{"$ref":"#/definitions/ModelLevel"},"name":{"description":"工作区名字。","maxLength":250,"pattern":"^[\\u4e00-\\u9fa5a-zA-Z\\d_]*$","type":"string"},"table_model_prefix":{"description":"模型校验前缀,长度不超过100,数字字母下划线组成,字母开头","type":"string"},"top":{"default":true,"description":"分层治理。","type":"boolean"},"type":{"description":"工作区类型枚举。\n枚举值:\n  - THIRD_NF: 关系建模\n  - DIMENSION: 维度建模","enum":["THIRD_NF","DIMENSION"],"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"}},"required":["name","type"],"type":"object"}},"description":null,"group_id":"23bb69798aaf409da161a43a90617121","host":"dayu.cn-north-4.myhuaweicloud.com","id":"29d465abd5eb4d37b3c6e3606ae2e345","info_version":"v1","method":"put","name":"BatchCreateDesignTableModelsFromLogic","parameters":{"contextTypeParam":{"description":"默认值:application/json;charset=UTF-8\n可选,有Body体的情况下必选,没有Body体则无需填写和校验。","in":"header","maxLength":64,"minLength":3,"name":"Content-Type","required":false,"type":"string"},"modelIdParam":{"description":"所属关系建模的模型ID,ID字符串。","in":"path","name":"model_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":{"/v1/{project_id}/design/workspaces/{model_id}/transform":{"put":{"consumes":["application/json;charset=UTF-8"],"description":"转换逻辑模型为物理模型,转换成功则显示转换后的目标模型信息。\n异常:目标模型信息的“id”等属性为null时,则需要调用《获取操作结果》接口查看具体报错信息:GET https://{endpoint}/v1/{project_id}/design/operation-results?operation_type=TRANSFORM_LOGIC_MODEL&operation_id={model_id},其中{model_id}为本接口的路径参数。\n约束与限制:\n  1、target_model_id与target_model_name不对应时,target_model_id优先级高于target_model_name。\n  2、target_model_id与dw_type不对应时,会找不到模型,提示:模型不存在。","operationId":"BatchCreateDesignTableModelsFromLogic","parameters":[{"$ref":"#/parameters/tokenParam"},{"$ref":"#/parameters/workspaceParam"},{"$ref":"#/parameters/tenantIdParam"},{"$ref":"#/parameters/tenantXIdParam"},{"$ref":"#/parameters/contextTypeParam"},{"$ref":"#/parameters/modelIdParam"},{"description":"逻辑实体转换物理表的配置信息。","in":"body","name":"BatchCreateDesignTableModelsFromLogicRequestBody","required":true,"schema":{"$ref":"#/definitions/WorkspaceTransformVO"}}],"produces":["application/json;charset=UTF-8"],"responses":{"200":{"description":"Success,返回data数据是目标物理WorkspaceVO信息,最终的转换结果需要从获取批量操作结果的接口中获取。","schema":{"$ref":"#/definitions/ShowWorkspaceDetailByIdResult"}},"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-1":{"connection_id":"92558783022c4ac88965e045b7c7078c","database":"gaussdb","description":"","dw_type":"DWS","ids":["1238437092523188266"],"schema":"public","target_model_id":"1234524753512017920","target_model_name":"dws0429","update_exist_tables":false},"x-request-examples-description-1":"将model_id为1184439352260976640的逻辑模型转化为物理模型。","x-request-examples-url-1":"PUT https://{endpoint}/v1/{project_id}/design/workspaces/1184439352260976640/transform","x-support-sdk":"Y"}}},"product_short":"DataArtsStudio","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"转换逻辑模型为物理模型","tags":"关系建模接口","uri":null,"version":"2.0"}