华为云用户手册

响应示例 状态码： 200 Success { "id" : 1012384820829081600, "name" : "test", "dimension" : "Uniqueness", "sql_info" : "select count(*) from ${Schema_Table1}", "category_id" : 0, "type" : "Table", "system_template" : false, "create_time" : 1661412950486, "creator" : "ei", "result_description" : "row : ${1}"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id Integer 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 定义关系 result_description String 结果说明 create_time Long 创建时间,13位时间戳(精确到毫秒) creator String 创建者,System代表系统自带 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DQC.0000，请求处理成功 error_msg String 错误信息 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DQC.0000，请求处理成功 error_msg String 错误信息

响应示例 状态码： 200 Success 返回的是InstanceVO { "count" : 1, "resources" : [ { "id" : 1012385458115825700, "name" : "test", "category_id" : 1012384968858652700, "schedule_status" : "NOT_START", "schedule_period" : null, "schedule_interval" : null, "create_time" : 1661413102000, "last_run_time" : 1661413281000, "creator" : "ei" } ]}

URI GET /v2/{project_id}/quality/quality-tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 只能获取所属project的任务执行结果列表 表2 Query参数 参数 是否必选 参数类型 描述 category_id 否 Long 目录ID name 否 String name schedule_status 否 String 调度状态 UNKNOWN:未知,NOT_START:未启动,SCHEDULING:调度中,FINISH_SUC CES S:正常结束,KILL:手动停止,RUNNING_EXCEPTION:运行失败 枚举值： UNKNOWN NOT_START SCHEDULING FINISH_SUCCESS KILL RUNNING_EXCEPTION start_time 否 Long 最近运行时间查询区间的开始时间,13位时间戳(精确到毫秒) end_time 否 Long 最近运行时间查询区间的结束时间,13位时间戳(精确到毫秒) creator 否 String 创建人 limit 否 Long 分页条数,最大值为100 最小值：0 最大值：100 缺省值：10 offset 否 Long 分页偏移量,最小值0 最小值：0 缺省值：0

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 总条数 resources Array of QualityTaskOverviewVO objects 分页数据 表5 QualityTaskOverviewVO 参数 参数类型 描述 id Long id name String name category_id Long 目录ID schedule_status String 调度状态 UNKNOWN:未知,NOT_START:未启动,SCHEDULING:调度中,FINISH_SUCCESS:正常结束,KILL:手动停止,RUNNING_EXCEPTION:运行失败 schedule_period String 调度周期 MINUTE:按分钟调度,HOUR:按小时调度,DAY:按天调度,WEEK:按周调度 schedule_interval String 调度间隔 当调度周期为分钟、小时、天时，返回数值字符串，当调度周期为周时，返回具体的调度星期信息如（MONDAY,THURSDAY） create_time Long 创建时间,13位时间戳(精确到毫秒) last_run_time Long 最近运行时间,13位时间戳(精确到毫秒) creator String 创建者 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DQC.0000，请求处理成功 error_msg String 错误信息 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DQC.0000，请求处理成功 error_msg String 错误信息

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 当前数据连接schema记录数 最小值：0 最大值：100 dw_id String 数据连接id 最小长度：1 最大长度：128 database String 数据库名称 最小长度：1 最大长度：128 schemas Array of SchemasList objects schema列表 表5 SchemasList 参数 参数类型 描述 schema_name String schema名称 最小长度：1 最大长度：128 description String schema描述 最小长度：1 最大长度：128 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最小长度：1 最大长度：1024 error_code String dayu异常码 最小长度：1 最大长度：1024 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最小长度：1 最大长度：1024 error_code String dayu异常码 最小长度：1 最大长度：1024

响应示例 状态码： 200 Success，返回schemas列表 { "dw_id" : "9b18c0ad6ef5404caef4e6cbaccdae6f", "database" : "postgres", "schemas" : [ { "schema_name" : "dm_autotest", "description" : "" }, { "schema_name" : "dbadmin", "description" : "" }, { "schema_name" : "public", "description" : "gs_roach_stop_backup" }, { "schema_name" : "schame", "description" : "" }, { "schema_name" : "utl_file", "description" : "" }, { "schema_name" : "utl_raw", "description" : "" } ], "total_count" : 6} 状态码： 400 { "error_code" : "DAYU.4402", "error_msg" : "The operation failed, detail msg {0}."} 状态码： 500 { "error_code" : "DAYU.3531", "error_msg" : "Internal server error: {0}"}

URI GET /v2/{project_id}/{connection_id}/schemas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 最小长度：1 最大长度：128 connection_id 是 String 数据连接id 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 database_name 是 String 数据库名称 最小长度：1 最大长度：128 limit 否 String 数据条数限制 最小长度：1 最大长度：16 offset 否 String 偏移量 最小长度：1 最大长度：16

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 个数 resources Array of InstanceOverviewVo objects resources 表5 InstanceOverviewVo 参数 参数类型 描述 id Long id name String 名称 task_id Long task id task_type String QUALITY_TASK:质量作业,CONSISTENCY_TASK:对账作业 run_status String RUNNING:运行中,FAILED:失败,ALARMING:报警,SUCCESS:正常 notify_status String NOT_TRIGGERED:未触发,SUCCESS:成功,FAILED:失败 start_time Long 开始时间 end_time Long 结束时间 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DQC.0000，请求处理成功 error_msg String 错误信息 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DQC.0000，请求处理成功 error_msg String 错误信息

响应示例 状态码： 200 Success { "count" : 2, "resources" : [ { "id" : 1012386207306600400, "name" : "test-1", "task_id" : 1012385458115825700, "task_type" : "QUALITY_TASK", "run_status" : "SUCCESS", "notify_status" : "NOT_TRIGGERED", "start_time" : 1661413281000, "end_time" : 1661413381000 }, { "id" : 1012386190504218600, "name" : "test-0", "task_id" : 1012386182149165000, "task_type" : "CONSISTENCY_TASK", "run_status" : "SUCCESS", "notify_status" : "NOT_TRIGGERED", "start_time" : 1661413277000, "end_time" : 1661413380000 } ]}

URI GET /v2/{project_id}/quality/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 只能获取所属project的任务执行结果列表 表2 Query参数 参数 是否必选 参数类型 描述 name 否 String 规则名称 task_type 否 String 任务实例类型 QUALITY_TASK:质量作业 CONSISTENCY_TASK:对账作业 枚举值： QUALITY_TASK CONSISTENCY_TASK run_status 否 String 状态, RUNNING:运行中,FAILED:失败,ALARMING:报警,SUCCESS:正常,SUSPENDING:暂停中,UNKNOWN:未定义 枚举值： SUCCESS FAILED RUNNING ALARMING notify_status 否 String 通知状态 NOT_TRIGGERED:未触发,SUCCESS:成功,FAILED:失败 枚举值： SUCCESS FAILED NOT_TRIGGERED start_time 否 Long 最近运行时间查询区间的开始时间,13位时间戳(精确到毫秒) end_time 否 Long 最近运行时间查询区间的结束时间,13位时间戳(精确到毫秒) limit 否 Integer 每页显示的条目数量,最大值为100 offset 否 Integer 分页偏移量

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 总数量 resources Array of SubInstanceResult objects resources 表4 SubInstanceResult 参数 参数类型 描述 sub_rule_id String 子规则ID sub_instance_instance_id String 子规则实例ID abnormal_table_status String 异常表任务状态 UNSUPPORTED:不支持异常表,READY：准备中,RUNNING：运行中,FAILED：失败,SUCCESS：成功 results Array of objects 结果集 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DQC.0000，请求处理成功 error_msg String 错误信息

响应示例 状态码： 200 Success { "count" : 2, "resources" : [ { "sub_rule_id" : "1012386182602149888", "sub_instance_instance_id" : "1012386190718128129", "abnormal_table_status" : "UNSUPPORTED", "results" : [ { "Total Rows" : "4", "Status" : "false", "Name" : "1_database.dqc_test2" } ] }, { "sub_rule_id" : "1012386182631510017", "sub_instance_instance_id" : "1012386190718128128", "abnormal_table_status" : "UNSUPPORTED", "results" : [ { "Total Rows" : "4", "Status" : "false", "Name" : "1_database.dqc_test2" } ] } ]}

URI GET /v1/{project_id}/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页记录数。默认20 最小值：1 最大值：100 offset 否 Integer 数据偏移量。默认0 最小值：0 最大值：2147483647

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 billing_check Boolean 是否需要账单 最小长度：1 最大长度：128 count Integer 返回记录总数 最小值：0 最大值：2147483647 commodity_order_lists Array of ApigCommodityOrder objects 返回实例列表 表5 ApigCommodityOrder 参数 参数类型 描述 project_id String 实例所属项目id 最小长度：1 最大长度：128 order_id String CBC订单id 最小长度：1 最大长度：128 region_id String 当前所属region Id 最小长度：1 最大长度：128 resource_id String 实例id 最小长度：1 最大长度：128 resource_name String 实例名称 最小长度：1 最大长度：128 subscription_id String CBC订购id 最小长度：1 最大长度：128 resource_type String 资源类型，hws.resource.type.dayu 最小长度：1 最大长度：128 resource_spec_code String 产品规格编码(即实例类型编码)，例如dayu.starter，dayu.basic，dayu.advanced等。可通过查询其他实例信息进行获取。 最小长度：1 最大长度：128 product_id String CBC产品id，未安装CBC的环境无需这个值 最小长度：1 最大长度：128 order_type String 订单类型标识符 最小长度：1 最大长度：128 charge_type String 支付选项，留空 最小长度：1 最大长度：128 is_auto_renew Integer 自动续费标识，当前实例为按需支付时必填，0代表不续费，1代表自动续费 最小值：0 最大值：1 status Integer 实例状态,1未生效2生效中3已删除=退订4保留期=冻结5宽限期6删除中 最小值：1 最大值：6 vpc_id String 虚拟私有云id 最小长度：1 最大长度：128 security_group_id String 安全组id 最小长度：1 最大长度：128 eps_id String 企业项目id 最小长度：1 最大长度：128 effective_time Number 生效时间点，包周期实例有效 最小值：0 最大值：9223372036854775807 expire_days String 过期时间天数，包周期实例有效 最小长度：1 最大长度：128 expire_time Number 过期时间点，包周期有效 最小值：0 最大值：9223372036854775807 lock_check_endpoint String CBC锁定节点 最小长度：1 最大长度：128 create_user String 创建用户 最小长度：1 最大长度：128 create_time Number 创建时间点 最小值：0 最大值：9223372036854775807 domain_id String 用户domain id 最小长度：1 最大长度：128 is_trial_order Integer 是否试用订单 最小值：0 最大值：1 work_space_mode String 工作空间模式说明 最小长度：1 最大长度：16 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最小长度：1 最大长度：1024 error_code String dayu异常码 最小长度：1 最大长度：1024 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最小长度：1 最大长度：1024 error_code String dayu异常码 最小长度：1 最大长度：1024

URI GET /v2/{project_id}/{connection_id}/datatables 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 最小长度：1 最大长度：128 connection_id 是 String 数据连接id 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 database_name 是 String 数据库名称 最小长度：1 最大长度：128 table_name 否 String 指定查询表的名称 最小长度：1 最大长度：128 limit 否 String 数据条数限制 最小长度：1 最大长度：16 offset 否 String 偏移量 最小长度：1 最大长度：16

响应示例 状态码： 200 Success，返回查询的表的列表 { "tables" : [ { "description" : null, "table_id" : "NativeTable-9b18c0ad6ef5404caef4e6cbaccdae6f-postgres-dm_autotest-kuaallfuhe01", "table_name" : "kuaallfuhe01", "table_name_cn" : null, "columns" : null, "dw_id" : "9b18c0ad6ef5404caef4e6cbaccdae6f", "dw_name" : "dws_xiaoyu", "dw_type" : "DWS", "database_name" : "postgres", "schema_name" : "dm_autotest", "life_cycle" : 0, "user_id" : "ei_dayu_y00321344_01", "user_name" : null, "project_id" : null, "create_time" : null, "table_size" : 0, "total_count" : 15, "is_valid" : 1, "extra_setting" : null, "partitioned" : true } ], "total_count" : 15} 状态码： 400 { "error_code" : "DAYU.4402", "error_msg" : "The operation failed, detail msg {0}."} 状态码： 500 { "error_code" : "DAYU.3531", "error_msg" : "Internal server error: {0}"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 当前数据库中表的记录数 最小值：0 最大值：100 tables Array of TablesList objects 表的列表 表5 TablesList 参数 参数类型 描述 table_name String 表名称 最小长度：1 最大长度：128 table_id String 表id 最小长度：1 最大长度：128 table_name_cn String 表的中文名称 最小长度：1 最大长度：128 columns String 表中字段 最小长度：1 最大长度：128 dw_id String 数据连接id 最小长度：1 最大长度：128 dw_name String 数据连接名称 最小长度：1 最大长度：128 dw_type String 数据连接类型 最小长度：1 最大长度：128 database_name String 数据库名称 最小长度：1 最大长度：128 schema_name String schema名称 最小长度：1 最大长度：128 life_cycle Integer 表的生命周期 最小值：0 最大值：1 description String 表的描述 最小长度：1 最大长度：128 user_id String 用户id 最小长度：1 最大长度：128 user_name String 用户名称 最小长度：1 最大长度：128 project_id String 数据连接id 最小长度：1 最大长度：128 create_time String 表的创建时间 最小长度：1 最大长度：128 table_size Integer 表的大小 最小值：0 最大值：4096 total_count Integer 当前查询条件下表的总记录数 最小值：0 最大值：100 is_valid Integer 表是否合规 最小值：0 最大值：1 extra_setting String 表的额外设置 最小长度：1 最大长度：128 partitioned Boolean 是否进行数据分区 缺省值：false 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最小长度：1 最大长度：1024 error_code String dayu异常码 最小长度：1 最大长度：1024 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最小长度：1 最大长度：1024 error_code String dayu异常码 最小长度：1 最大长度：1024

响应示例 状态码： 200 Success，返回数据库列表 { "dw_id" : "f6ce0c0de8f14ba8b7fbf23486b8ec16", "databases" : [ { "database_name" : "dlcatalog_2fe5", "description" : null }, { "database_name" : "dlcatalog_3e24", "description" : null }, { "database_name" : "dlcatalog_677a", "description" : null }, { "database_name" : "dlcatalog_86e4", "description" : null }, { "database_name" : "dlcatalog_ced5", "description" : null } ], "total_count" : 21} 状态码： 400 { "error_code" : "DAYU.4402", "error_msg" : "The operation failed, detail msg {0}."} 状态码： 500 { "error_code" : "DAYU.3531", "error_msg" : "Internal server error: {0}"}

URI GET /v2/{project_id}/{connection_id}/databases 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 最小长度：1 最大长度：128 connection_id 是 String 数据连接id 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 String 数据条数限制 最小长度：1 最大长度：16 offset 否 String 偏移量 最小长度：1 最大长度：16

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 当前数据连接数据库记录数 最小值：0 最大值：100 dw_id String 数据连接id 最小长度：1 最大长度：128 databases Array of DatabasesList objects 数据库列表 表5 DatabasesList 参数 参数类型 描述 database_name String 数据库名称 最小长度：1 最大长度：128 description String 数据库描述 最小长度：1 最大长度：128 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最小长度：1 最大长度：1024 error_code String dayu异常码 最小长度：1 最大长度：1024 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最小长度：1 最大长度：1024 error_code String dayu异常码 最小长度：1 最大长度：1024

响应参数 状态码： 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_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 ConsistencyRuleDetailForOpenApi objects 子规则 表4 ConsistencyRuleDetailForOpenApi 参数 参数类型 描述 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 对照列名，当存在多个值时以逗号分隔 dimension String 维度 queue String DLI 队列 regular_expression String 当规则模板为正则表达式校验时的正则表达式 template_arguments String 模板参数 weight Integer 规则权重 calculation_range String 计算范围 calculation_range_sql String 计算范围SQL alarm_condition String 告警表达式 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DQC.0000，请求处理成功 error_msg String 错误信息 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DQC.0000，请求处理成功 error_msg String 错误信息

URI GET /v2/{project_id}/quality/consistency-tasks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 只能获取所属project的任务执行结果列表 表2 Query参数 参数 是否必选 参数类型 描述 category_id 否 Long 目录ID name 否 String name schedule_status 否 String 调度状态 UNKNOWN:未知,NOT_START:未启动,SCHEDULING:调度中,FINISH_SUCCESS:正常结束,KILL:手动停止,RUNNING_EXCEPTION:运行失败 枚举值： UNKNOWN NOT_START SCHEDULING FINISH_SUCCESS KILL RUNNING_EXCEPTION start_time 否 Long 最近运行时间查询区间的开始时间,13位时间戳(精确到毫秒) end_time 否 Long 最近运行时间查询区间的结束时间,13位时间戳(精确到毫秒) creator 否 String 创建人 limit 否 Long 分页条数,最大值为100 最小值：0 最大值：100 缺省值：10 offset 否 Long 分页偏移量,最小值0 最小值：0 缺省值：0

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Long 总条数 resources Array of QualityTaskOverviewVO_2 objects 分页数据 表5 QualityTaskOverviewVO_2 参数 参数类型 描述 id Long id name String name category_id Long 目录ID schedule_status String 调度状态 UNKNOWN:未知,NOT_START:未启动,SCHEDULING:调度中,FINISH_SUCCESS:正常结束,KILL:手动停止,RUNNING_EXCEPTION:运行失败 schedule_period String 调度周期 MINUTE:按分钟调度,HOUR:按小时调度,DAY:按天调度,WEEK:按周调度 schedule_interval String 调度间隔 当调度周期为分钟、小时、天时，返回数值字符串，当调度周期为周时，返回具体的调度星期信息如（MONDAY,THURSDAY） create_time Long 创建时间,13位时间戳(精确到毫秒) last_run_time Long 最新运行时间,13位时间戳(精确到毫秒) creator String 创建者 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DQC.0000，请求处理成功 error_msg String 错误信息 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码，如DQC.0000，请求处理成功 error_msg String 错误信息

响应示例 状态码： 200 Success 返回的是InstanceVO { "count" : 1, "resources" : [ { "id" : 1012386182149165000, "name" : "test", "category_id" : 0, "schedule_status" : "NOT_START", "schedule_period" : null, "schedule_interval" : null, "create_time" : 1661413275050, "last_run_time" : null, "creator" : "ei" } ]}

响应示例 状态码： 200 Success，返回字段列表 { "columns" : [ { "comment" : "", "column_name" : "age", "column_type" : "integer", "seq_number" : 2, "primary" : false, "partition_col" : false }, { "comment" : "", "column_name" : "address", "column_type" : "character varying", "seq_number" : 3, "primary" : false, "partition_col" : false }, { "comment" : "", "column_name" : "phonenum", "column_type" : "character varying", "seq_number" : 4, "primary" : false, "partition_col" : false } ], "total_count" : 7, "table_id" : "NativeTable-9b18c0ad6ef5404caef4e6cbaccdae6f-postgres-dm_autotest-QQQQQQQstudents_infoweq"} 状态码： 400 { "error_code" : "DAYU.4402", "error_msg" : "The operation failed, detail msg {0}."} 状态码： 500 { "error_code" : "DAYU.3531", "error_msg" : "Internal server error: {0}"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 table_id String 表id 最小长度：1 最大长度：128 total_count Integer 当前表中字段记录数 最小值：0 最大值：100 columns Array of ColumnsList objects 字段列表 表5 ColumnsList 参数 参数类型 描述 comment String 字段注解 最小长度：1 最大长度：128 column_name String 字段名称 最小长度：1 最大长度：128 column_type String 字段类型 最小长度：1 最大长度：128 seq_number Integer 字段的顺序 最小值：0 最大值：100 primary Boolean 字段是否为主键 缺省值：false partition_col Boolean 是否对字段进行分割 缺省值：false 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最小长度：1 最大长度：1024 error_code String dayu异常码 最小长度：1 最大长度：1024 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_msg String 错误信息 最小长度：1 最大长度：1024 error_code String dayu异常码 最小长度：1 最大长度：1024

URI GET /v2/{project_id}/{connection_id}/datatables/{table_id}/columns 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 最小长度：1 最大长度：128 connection_id 是 String 数据连接id 最小长度：1 最大长度：128 table_id 是 String 表id 最小长度：1 最大长度：128 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 String 数据条数限制 最小长度：1 最大长度：16 offset 否 String 偏移量 最小长度：1 最大长度：16

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 statistics Array of StatisticForDetail objects 统计信息详情列表 表5 StatisticForDetail 参数 参数类型 描述 id String 统计对象编号 name String 统计对象名称 call_num Integer 调用总量 success_num Integer 成功调用量(取数成功) fail_num Integer 失败调用量(取数失败) legal_num Integer 合法调用量(通过校验) illegal_num Integer 非法调用量(无法通过校验) cost_time_avg Number 请求平均时长 success_cost_time_avg Number 成功请求平均时长 fail_cost_time_avg Number 失败请求平均时长 success_rate Number 成功率 fail_rate Number 失败率 legal_rate Number 合法率 illegal_rate Number 非法率 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 查询app 服务使用topN成功 { "statistics" : [ { "id" : "3423634676234236674", "name" : "统计对象名称", "call_num" : 0, "success_num" : 0, "fail_num" : 0, "legal_num" : 0, "illegal_num" : 0, "cost_time_avg" : 0, "success_cost_time_avg" : 0, "fail_cost_time_avg" : 0, "success_rate" : 0, "fail_rate" : 0, "legal_rate" : 0, "illegal_rate" : 0 } ]}