华为云用户手册

响应 响应样例 { "total": 1, "publish_messages": [ { "id": "343a6d4c0ad108376ebd060c9c33cc33", "api_id": "47046fe7830c1be77cb0dc23bd86afa5", "instance_id": "c2e27497562ed193583378e052248003", "instance_name": "cluster_test_001", "api_status": "API_STATUS_CREATED", "api_debug": "API_DEBUG_WAITING" } ]} 响应参数说明 参数名 参数类型 说明 total Integer 符合条件的调试信息 publish_messages Array of ApiPublishDTO objects 本次返回的API调试信息 表1 ApiPublishDTO 参数 参数类型 描述 id String 发布编号 api_id String api编号 instance_id String 集群编号 instance_name String 集群名称 api_status String api状态 枚举值： API_STATUS_CREATED API_STATUS_PUBLISH_WAIT_REVIEW API_STATUS_PUBLISH_REJECT API_STATUS_PUBLISHED API_STATUS_WAITING_STOP API_STATUS_STOPPED API_STATUS_RECOVER_WAIT_REVIEW API_STATUS_WAITING_OFFLINE API_STATUS_OFFLINE api_debug String api调试状态 枚举值： API_DEBUG_WAITING API_DEBUG_FAILED API_DEBUG_SUC CES S

URL URI格式 GET /v1/{project_id}/service/apis/{api_id}/debug-info 参数说明 参数名 是否必选 参数类型 说明 project_id 是 String 项目编号。获取方法请参见项目ID和帐号ID。 api_id 是 String API编号。 offset 否 Integer 查询起始坐标, 即跳过前X条数据。默认值：0。取值范围：[0, MAX_INTEGER) limit 否 Integer 查询条数, 即查询Y条数据，默认值：10。建议取值范围：[1, 100]

URL URI格式 GET /v1/{project_id}/service/apis/{api_id}/publish-info[?offset,limit] 参数说明 参数名 是否必选 参数类型 说明 project_id 是 String 项目编号。获取方法请参见项目ID和帐号ID。 api_id 是 String API编号。 offset 否 Integer 查询起始坐标, 即跳过前X条数据。默认值：0。取值范围：[0, MAX_INTEGER) limit 否 Integer 查询条数, 即查询Y条数据，默认值：10。建议取值范围：[1, 100]

响应 响应样例 { "total": 1, "publish_messages": [ { "id": "343a6d4c0ad108376ebd060c9c33cc33", "api_id": "47046fe7830c1be77cb0dc23bd86afa5", "instance_id": "c2e27497562ed193583378e052248003", "instance_name": "cluster_test_001", "api_status": "API_STATUS_CREATED", "api_debug": "API_DEBUG_WAITING" } ]} 表1 响应Body参数 参数 参数类型 描述 total Integer 总数 publish_messages Array of ApiPublishDTO objects 发布信息列表 表2 ApiPublishDTO 参数 参数类型 描述 id String 发布编号 api_id String api编号 instance_id String 集群编号 instance_name String 集群名称 api_status String api状态 枚举值： API_STATUS_CREATED API_STATUS_PUBLISH_WAIT_REVIEW API_STATUS_PUBLISH_REJECT API_STATUS_PUBLISHED API_STATUS_WAITING_STOP API_STATUS_STOPPED API_STATUS_RECOVER_WAIT_REVIEW API_STATUS_WAITING_OFFLINE API_STATUS_OFFLINE api_debug String api调试状态 枚举值： API_DEBUG_WAITING API_DEBUG_FAILED API_DEBUG_SUCCESS

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 id Long id name String name category_id Long 目录ID dimension String Completeness:完整性,Uniqueness:唯一性,Timeliness:及时性,Validity:有效性,Accuracy:准确性,Consistency:一致性 type String 规则类型，Field:字段级规则,Table:表级规则,Database:库级规则,Cross-field:跨字段级规则,Customize:自定义规则 system_template Boolean 是否为系统模板 sql_info String 定义关系 abnormal_table_template String 异常表模板 result_description String 结果说明 create_time Long 创建时间,13位时间戳(精确到毫秒) creator String 创建者,System代表系统自带 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DQC.0000，请求处理成功 error_msg String 错误信息 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DQC.0000，请求处理成功 error_msg String 错误信息

响应示例 状态码： 200 Success { "id" : "1045431715138617345", "name" : "test", "category_id" : 0, "dimension" : "Completeness", "type" : "Table", "system_template" : false, "sql_info" : "select count(*) from ${Schema_Table1}", "abnormal_table_template" : "select count(*) from ${Schema_Table1}", "result_description" : "总条数", "create_time" : 1640678720014, "creator" : "test"}

请求示例 更新规则模板名称为test的规则模板，模板id为0，目录id为0，纬度id为1，模板中的sql内容为select count(*) from ${Schema_Table1}，发布操作默认为false，结果说明为总条数，描述为test。 PUT /v2/0833a5737480d53b2f25c010dc1a7b88/quality/rule-templates/1045431715138617345{ "id" : "1045431715138617345", "name" : "test", "directory_id" : "0", "dimension_id" : 1, "description" : "test", "sql_info" : "select count(*) from ${Schema_Table1}", "result_description" : "总条数", "publish" : true, "origin_name" : "test", "abnormal_table_template" : "select count(*) from ${Schema_Table1}", "user_define_version_name" : "V1.1", "version_num" : 0, "status" : 1}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 workspace 是 String workspace 信息 X-Auth-Token 是 String token 表3 请求Body参数 参数 是否必选 参数类型 描述 id 否 String template id name 否 String template name directory_id 否 Long 目录 dimension_id 否 Integer 维度ID, 1:完整性,2:唯一性,3:及时性,4:有效性,5:准确性,6:一致性 description 否 String 描述 sql_info 否 String 模板中的sql内容 最小长度：0 result_description 否 String 结果说明 publish 否 Boolean 是否是发布操作， true：发布新版本 false：普通的保存操作 缺省值：false origin_name 否 String 修改前的模板名 abnormal_table_template 否 String 异常表模板 最小长度：0 user_define_version_name 否 String 用户自定义版本名 缺省值：V1.0 version_num 否 Long 获取模板信息时候的版本号 status 否 Integer 规则模板状态,0表示下线1表示已发布

响应 响应样例 {"backend_config": null,"create_time": 1589186805000,"datasource_config": {"access_mode": "SQL","backend_paras": [{"condition": "CONDITION_TYPE_EQ","mapping": "a1","name": "p"},{"condition": "CONDITION_TYPE_EQ","mapping": "a3","name": "q"},{"condition": "CONDITION_TYPE_EQ","mapping": "a2","name": "h"}],"connection_id": "8a94809170fa181e0170fd2cbb610007","database": "default","order_paras": [{"field": "a1","name": "o1","optional": false,"order": 1,"sort": "ASC"},{"field": "a2","name": "o2","optional": true,"order": 2,"sort": "CUSTOM"}],"pagination": "DEFAULT","queue": "default","response_paras": [{"description": "","example_value": "","field": "a1","name": "a1x","type": "REQUEST_PA RAM ETER_TYPE_STRING"},{"description": "","example_value": "","field": "a2","name": "a2","type": "REQUEST_PARAMETER_TYPE_STRING"},{"description": "","example_value": "1","field": "a3","name": "a3","type": "REQUEST_PARAMETER_TYPE_NUMBER"}],"sql": null,"type": " DLI "},"description": "update","host": "e7c91cd2d4714e81807b7d4c273f791c.apig.xxxxxx.apis.com","id": "f2108870c3867c3080cf5dfcc1f1a66c","log_flag": true,"manager": "test","name": "testOpenApi_create_configuration_update","path": "/testOpenApi_configuration/{p}","protocol": "PROTOCOL_TYPE_HTTP","publish_type": "PUBLISH_TYPE_PRIVATE","request_paras": [{"default_value": "","description": "","example_value": "","name": "h","necessary": false,"position": "REQUEST_PARAMETER_POSITION_HEADER","type": "REQUEST_PARAMETER_TYPE_STRING"},{"default_value": null,"description": "123","example_value": null,"name": "p","necessary": true,"position": "REQUEST_PARAMETER_POSITION_PATH","type": "REQUEST_PARAMETER_TYPE_NUMBER"},{"default_value": null,"description": "","example_value": null,"name": "q","necessary": true,"position": "REQUEST_PARAMETER_POSITION_QUERY","type": "REQUEST_PARAMETER_TYPE_NUMBER"}],"request_type": "REQUEST_TYPE_GET","update_time": 1589202148000,"create_user": "abc","debug_status": "API_DEBUG_SUCCESS","group_id": "123","hosts": null,"status": "API_STATUS_CREATED"} 响应Body参数 参数 参数类型 描述 id String API的ID name String API名称 group_id String API所属分组的ID description String API 描述 protocol String API 访问协议 枚举值： PROTOCOL_TYPE_HTTP PROTOCOL_TYPE_HTTPS publish_type String 发布类型，公开或者私有 枚举值： PUBLISH_TYPE_PUBLIC PUBLISH_TYPE_PRIVATE log_flag Boolean 是否开启日志记录 path String API的访问路径 host String 共享版域名 hosts InstanceHostDTO object 专享版域名 request_type String API访问方式 枚举值： REQUEST_TYPE_POST REQUEST_TYPE_GET create_user String API创建者 create_time Long 创建时间 update_time Long 更新时间 manager String API 审核人名称 status String API的状态 枚举值： API_STATUS_CREATED API_STATUS_PUBLISH_WAIT_REVIEW API_STATUS_PUBLISH_REJECT API_STATUS_PUBLISHED API_STATUS_WAITING_STOP API_STATUS_STOPPED API_STATUS_RECOVER_WAIT_REVIEW API_STATUS_WAITING_OFFLINE API_STATUS_OFFLINE API_STATUS_OFFLINE_WAIT_REVIEW type String API 类型 枚举值： API_SPECIFIC_TYPE_CONFIGURATION API_SPECIFIC_TYPE_SCRIPT API_SPECIFIC_TYPE_REGISTER debug_status String API调试状态 枚举值： API_DEBUG_WAITING API_DEBUG_FAILED API_DEBUG_SUCCESS request_paras Array of RequestPara objects API请求参数 datasource_config DatasourceConfig object 数据源配置 backend_config BackendConfig object 后端配置 表1 InstanceHostDTO 参数 参数类型 描述 instance_id String 集群id instance_name String 集群名 intranet_host String 内网地址 external_host String 外网地址 domains Array of strings 网关域名 表2 RequestPara 参数 参数类型 描述 name String 参数名 position String 参数的位置 枚举值： REQUEST_PARAMETER_POSITION_PATH REQUEST_PARAMETER_POSITION_HEADER REQUEST_PARAMETER_POSITION_QUERY type String 参数的类型 枚举值： REQUEST_PARAMETER_TYPE_NUMBER REQUEST_PARAMETER_TYPE_STRING description String 参数的描述 necessary Boolean 参数是否必填 example_value String 实例值 default_value String 默认值 表3 DatasourceConfig 参数 参数类型 描述 type String 数据源的类型 枚举值： MYSQL DLI DWS HIVE HBASE connection_name String 数据连接名称 connection_id String 数据连接ID database String 数据库名 datatable String 数据表名称 table_id String 数据表ID queue String DLI的队列名称 access_type String 取数方式 枚举值： SCRIPT CONFIGURAITON access_mode String 获取数据的模式 枚举值： SQL ROW_KEY PREFIX_FILTER pagination String 枚举值： DEFAULT CUSTOM sql String 脚本模式下的sql语句 backend_paras Array of ApiRequestPara objects API后端参数 response_paras Array of ApiResponsePara objects 配置类API返回参数 order_paras Array of DatasourceOrderPara objects 排序参数 表4 ApiRequestPara 参数 参数类型 描述 name String 参数名称 mapping String 映射字段 condition String 操作符 枚举值： CONDITION_TYPE_EQ CONDITION_TYPE_NE CONDITION_TYPE_GT CONDITION_TYPE_GE CONDITION_TYPE_LT CONDITION_TYPE_LE CONDITION_TYPE_LIKE CONDITION_TYPE_LIKE_L CONDITION_TYPE_LIKE_R 表5 ApiResponsePara 参数 参数类型 描述 name String 参数名 field String 绑定的表字段 type String 参数类型 枚举值： REQUEST_PARAMETER_TYPE_NUMBER REQUEST_PARAMETER_TYPE_STRING description String 参数描述 example_value String 参数示例值 表6 DatasourceOrderPara 参数 参数类型 描述 name String 排序参数名称 field String 对应的参数字段 optional Boolean 是否可选 sort String 排序方式 枚举值： ASC DESC CUSTOM order Integer 排序参数顺序 表7 BackendConfig 参数 参数类型 描述 type String 后端请求类型 枚举值： REQUEST_TYPE_POST REQUEST_TYPE_GET protocol String 后端请求协议类型 枚举值： PROTOCOL_TYPE_HTTP PROTOCOL_TYPE_HTTPS host String 后端host timeout Integer 后端超时时间 path String 后端请求Path backend_paras Array of BackendRequestPara objects API后端参数 constant_paras Array of BackendConstant objects 后端常量参数 表8 BackendRequestPara 参数 参数类型 描述 name String api请求参数名称 position String 参数位置 枚举值： REQUEST_PARAMETER_POSITION_PATH REQUEST_PARAMETER_POSITION_HEADER REQUEST_PARAMETER_POSITION_QUERY backend_para_name String 对应的后端参数 表9 BackendConstant 参数 参数类型 描述 name String 常量参数名 type String 常量参数类型 枚举值： REQUEST_PARAMETER_TYPE_NUMBER REQUEST_PARAMETER_TYPE_STRING position String 常量参数位置 枚举值： REQUEST_PARAMETER_POSITION_PATH REQUEST_PARAMETER_POSITION_HEADER REQUEST_PARAMETER_POSITION_QUERY description String 常量参数描述 value String 常量参数值

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id Long ID name String 作业名称 description String 作业描述 category_id Long 所属目录ID level String SUGGEST:提示, MINOR:一般, MAJOR:严重, FATAL:致命 alarm_condition String 统一告警条件 alarm_notify Boolean 是否开启通知告警 alarm_notify_type String TRIGGER_ALARM:触发告警, RUN_SUCCESS:运行成功, TRIGGER_ALARM_AND_RUNNING_SUCCESS:触发告警和运行成功 alarm_notify_topic String 通知主题名 schedule_type String 调度类型，ONCE：单次调度，PERIODIC：周期性调度 schedule_start_date String 调度开始日期 schedule_end_date String 调度结束日期 schedule_period String 调度周期，MINUTE:按分钟调度，HOUR:按小时调度，DAY:按天调度，WEEK:按周调度 schedule_interval String 调度间隔，注意：当调度周期为分钟、小时、天时，间隔时间为数字；而当调度周期为周时，调度间隔为星期的英文，如：每周一、周二调度时，schedule_interval为"MONDAY,TUESDAY" schedule_start_time String 调度开始时间 schedule_end_time String 调度结束时间 create_time Long 最近运行时间,13位时间戳(精确到毫秒) last_run_time Long 最近运行时间,13位时间戳(精确到毫秒) sub_rules Array of QualityTaskRuleDetailForOpenApi objects 子规则 schedule_cron String 调度cron表达式 表4 QualityTaskRuleDetailForOpenApi 参数 参数类型 描述 id Long 子规则ID sub_rule_name String 子规则名称 type String SingleDatabase:库级规则，SingleTable:表级规则,SingleColumn:字段级规则,CrossColumn:跨字段规则,Customize:自定义规则 template_id Long 规则模板ID connection String 数据连接ID connection_type String 数据连接类型 databases String 数据库名，当存在多个值时以逗号分隔 sql String 自定义规则中的SQL脚本，系统内置规则时返回 tables String 表名，当存在多个值时以逗号分隔 reference_tables String 跨字段规则中的参考表名，当存在多个值时以逗号分隔 columns String 字段名，当存在多个值时以逗号分隔 reference_columns String 跨字段规则中的参考字段名，当存在多个值时以逗号分隔 ignore_error Boolean 是否忽视规则错误 dimension String 维度 queue String DLI队列 regular_expression String 当规则模板为正则表达式校验时的正则表达式 template_arguments String 模板参数 weight Integer 规则权重 calculation_range String 计算范围 calculation_range_sql String 计算范围SQL alarm_condition String 告警表达式 export_abnormal_table Boolean 是否导出异常数据 abnormal_table_database String 异常表数据库 abnormal_table_schema String 异常表Schema abnormal_table String 异常字段所在的表 abnormal_table_prefix String 异常表前缀 abnormal_table_suffix String 异常表后缀 abnormal_table_columns String 异常字段名，当存在多个值时以逗号分隔 abnormal_table_sql String 异常表SQL abnormal_table_out_config Boolean 异常表是否输出规则配置 abnormal_table_include_null_value Boolean 异常表是否包含空值 abnormal_table_out_data_number Integer 异常表输出行数, 0代表全量输出 score_switch Boolean 是否开启质量评分 score_schema String 质量评分表所在schema score_table String 质量评分表名 score_expression String 质量评分表达式 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DQC.0000，请求处理成功 error_msg String 错误信息 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DQC.0000，请求处理成功 error_msg String 错误信息

请求示例 修改API名为testApi，发布类型为PUBLISH_TYPE_PRIVATE的API接口。 { "name" : "testApi", "manager" : "admin", "description" : "", "protocol" : "PROTOCOL_TYPE_HTTP", "publish_type" : "PUBLISH_TYPE_PRIVATE", "log_flag" : false, "path" : "/testApi/{a}", "request_type" : "REQUEST_TYPE_GET", "tags" : [ "标签1", "标签2" ], "visibility" : "WORKSPACE", "request_paras" : [ { "name" : "a", "position" : "REQUEST_PARAMETER_POSITION_PATH", "type" : "REQUEST_PARAMETER_TYPE_NUMBER", "description" : "", "necessary" : false, "example_value" : "", "default_value" : "" }, { "name" : "b", "position" : "REQUEST_PARAMETER_POSITION_HEADER", "type" : "REQUEST_PARAMETER_TYPE_NUMBER", "description" : "", "necessary" : false, "example_value" : "", "default_value" : "" }, { "name" : "c", "position" : "REQUEST_PARAMETER_POSITION_QUERY", "type" : "REQUEST_PARAMETER_TYPE_NUMBER", "description" : "", "necessary" : false, "example_value" : "", "default_value" : "" } ], "backend_config" : { "type" : "REQUEST_TYPE_GET", "protocol" : "PROTOCOL_TYPE_HTTP", "timeout" : "100", "host" : "www.baidu.com", "path" : "/testApi/{d}/{g}", "backend_paras" : [ { "name" : "a", "position" : "REQUEST_PARAMETER_POSITION_PATH", "backend_para_name" : "d" }, { "name" : "b", "position" : "REQUEST_PARAMETER_POSITION_QUERY", "backend_para_name" : "e" }, { "name" : "c", "position" : "REQUEST_PARAMETER_POSITION_HEADER", "backend_para_name" : "f" } ], "constant_paras" : [ { "name" : "g", "type" : "REQUEST_PARAMETER_TYPE_NUMBER", "position" : "REQUEST_PARAMETER_POSITION_PATH", "description" : "", "value" : "1" }, { "name" : "h", "type" : "REQUEST_PARAMETER_TYPE_NUMBER", "position" : "REQUEST_PARAMETER_POSITION_QUERY", "description" : "", "value" : "1" }, { "name" : "j", "type" : "REQUEST_PARAMETER_TYPE_NUMBER", "position" : "REQUEST_PARAMETER_POSITION_HEADER", "description" : "", "value" : "1" } ] }}

请求消息 请求样例 授予编号为908489209a320df61607355c57c82882的APP在截止时间为2021-01-01T10:00:00.000Z的有效期内访问编号为47046fe7830c1be77cb0dc23bd86afa5的API的权利。 { "api_id": "47046fe7830c1be77cb0dc23bd86afa5", "instance_id": "APIG", "app_id": "908489209a320df61607355c57c82882", "apply_type": "APPLY_TYPE_AUTHORIZE", "time": "2021-01-01T10:00:00.000Z"} 请求参数说明 参数名 是否必选 参数类型 说明 api_id 否 String api编号 instance_id 否 String 数据服务专享版集群编号 app_id 否 String 应用编号 apply_type 否 String 操作类型 APPLY_TYPE_AUTHORIZE：API主动授权 APPLY_TYPE_API_CANCEL_AUTHORIZE：API解除授权 APPLY_TYPE_APP_CANCEL_AUTHORIZE：APP解除授权 APPLY_TYPE_APPLY：APP申请授权 APPLY_TYPE_RENEW：APP申请续约 time 否 String 截止时间，ISO格式(+0时区)，最小时间精度为小时。APP解除授权无需此参数。

功能介绍 API主动授权：API审核人可发起，API主动授权成功后，在有效期内，APP即可访问该API。API授权包含授权和续约两部分功能。 授权：授权会给予APP在有效期内访问API的权利。 续约：续约会更新授权有效期，仅支持延长有效期，不能减少。 API解除授权：API审核人可发起，解除API对APP的授权关系。解除授权后，APP将不再能够调用该API。API解除已授权的APP关系，需要为APP预留至少2天的准备时间。 APP解除授权：APP所有者可发起，解除API对APP的授权关系。解除授权后，APP将不再能够调用该API。APP解除自己的授权关系，无需预留准备时间。 APP申请授权：APP所有者可发起，APP申请API后，待API的审核人完成审核，APP即可访问该API。授权会给予APP在有效期内访问API的权利，需要API审核。 APP申请续约：APP所有者可发起，续约会更新授权有效期，仅支持延长有效期，不能减少，需要API审核。 申请自己的API推荐采用API主动授权/续约，无需审核。 自己的应用推荐采用APP解除授权，无需预留准备时间。

请求消息 请求样例 授予编号为908489209a320df61607355c57c82882的APP在截止时间为2021-01-01T10:00:00.000Z前拥有访问该api的权利。 {"app_ids":["908489209a320df61607355c57c82882"],"time":"2021-01-01T10:00:00.000Z"} 请求参数说明 参数名 是否必选 参数类型 说明 app_ids 否 String[] app的编号列表 time 否 String 截止时间，ISO格式(+0时区)。app在截止时间前拥有访问该api的权利。最小时间精度为小时。

URL URI格式 POST /v1/{project_id}/service/apis/{api_id}/instances/{instance_id}/authorize 参数说明 参数名 是否必选 参数类型 说明 project_id 是 String 项目编号。获取方法请参见项目ID和帐号ID。 api_id 是 String API编号。 instance_id 是 String 数据服务专享版集群编号。

响应参数 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最小长度：1 最大长度：1024 error_code String dayu异常码 最小长度：1 最大长度：1024 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最小长度：1 最大长度：1024 error_code String dayu异常码 最小长度：1 最大长度：1024

响应示例 状态码： 200 Success，成功添加工作空间用户 { "message" : null, "is_success" : true} 状态码： 400 { "error_code" : "DAYU.4402", "error_msg" : "The operation failed, detail msg {0}."} 状态码： 500 { "error_code" : "DAYU.3531", "error_msg" : "Internal server error: {0}"}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token 最小长度：0 最大长度：4096 表3 请求Body参数 参数 是否必选 参数类型 描述 type 是 Integer 用户类型，0:添加用户;1:添加用户组 最小值：0 最大值：1 user_ids 否 Array of ApigIamUserDto objects 用户列表信息 groups 否 Array of Group objects 用户组列表信息 roles_ids 是 Array of ApigRole objects 空间角色列表 表4 ApigIamUserDto 参数 是否必选 参数类型 描述 user_id 否 String 用户id user_name 否 String 用户名 domain_id 否 String 租户id domain_name 否 String 租户名 is_domain_owner 否 Boolean 是否是空间拥有者 表5 Group 参数 是否必选 参数类型 描述 id 否 String 用户组id 最小长度：1 最大长度：128 name 否 String 用户组名 最小长度：1 最大长度：128 表6 ApigRole 参数 是否必选 参数类型 描述 role_id 否 String 角色id，r00001：管理员；r00002：开发者；r00003：运维者；r00004：访客 最小长度：1 最大长度：128

请求示例 { "user_ids" : [ { "user_id" : "2d032145d82546b5b83cd7a6fd7d0afc", "user_name" : "ei_dayu_n30011721", "domain_id" : "0833a5736980d53b0f22c0102ffcbfc0", "domain_name" : "ei_dayu_y00321344_01", "is_domain_owner" : "false" } ], "roles_ids" : [ { "role_id" : "r00003" } ], "type" : 0}

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio 工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 分类名称 description 否 String 分类描述 create_user 否 String 分类创建者 create_time 否 Number 分类创建时间 update_time 否 Number 分类更新时间 update_user 否 String 分类更新者 guid 否 String 分类的guid标志

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String IAM Token workspace 是 String DataArts Studio工作空间ID 表3 请求Body参数 参数 是否必选 参数类型 描述 guids 是 Array of strings 数据资产list classification 是 OpenClassification object 分类信息 表4 OpenClassification 参数 是否必选 参数类型 描述 name 是 String 分类名称 description 否 String 分类描述 create_user 否 String 分类创建者 create_time 否 Number 分类创建时间 update_time 否 Number 分类更新时间 update_user 否 String 分类更新者 guid 否 String 分类的guid标志

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息

响应示例 状态码： 200 Success，返回data数据是 StatisticInfo 信息 { "data" : { "value" : { "atomic_index" : { "increase" : 0, "total" : 1, "standard_coverage" : null }, "derivative_index" : { "increase" : 1, "total" : 4, "standard_coverage" : null }, "compound_metric" : { "increase" : 0, "total" : 0, "standard_coverage" : null }, "biz_index" : { "increase" : 0, "total" : 2, "standard_coverage" : null }, "dimension" : { "increase" : 0, "total" : 4, "standard_coverage" : null }, "condition_group" : null, "time_condition" : { "increase" : 0, "total" : 14, "standard_coverage" : null }, "common_condition" : null, "dimension_logic_table" : { "increase" : 0, "total" : 4, "standard_coverage" : null }, "fact_logic_table" : { "increase" : 0, "total" : 1, "standard_coverage" : 0.1429 }, "aggregation_logic_table" : { "increase" : 1, "total" : 4, "standard_coverage" : null }, "data_standard" : { "increase" : 1, "total" : 5, "standard_coverage" : null }, "table_model" : { "increase" : 5, "total" : 9, "standard_coverage" : 0.027 }, "lookup_table" : { "increase" : 1, "total" : 4, "standard_coverage" : null }, "pending_review" : 0, "my_applications" : 0 } }}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Object 返回的数据信息 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DS.000，请求处理成功 error_msg String 错误信息 data Object 返回的数据信息

响应示例 状态码： 200 Success，返回data数据是 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" } } }}