接口响应规范--大数据研发治理套件（私有化）-火山引擎

文档中心

大数据研发治理套件（私有化）

指标服务

接口响应规范

HTTP接口遵循API协议规范。返回数据格式统一如下，以下的code、msg为内部报错状态码：

{
    "code":int,      // 用户错误码,0代表成功
    "msg" :"",     // 可选，返回消息， 如ok,error, 成功
    ...
    "BaseResp":{
        StatusMessage:"",    // 详细的错误信息
        StatusCode:int      // 详细的错误码
        ...
    }
}

类别	模块状态码	模块错误描述	模块子类状态码	模块子类描述
未知错误	-1	未知错误	-1000	未知错误[unknown error]
参数错误	100	参数错误	100001	请求参数异常[Request parameter exception]
			100002	请求参数缺失[Missing request parameters]
			100003	系统内部参数异常[System internal parameter abnormality]
基础组件异常	201	基础组件异常：TCC	201001	TCC异常[TCC exception]
	202	基础组件异常：缓存	202001	缓存异常[Cache exception]
	203	基础组件异常：mysql	203001	MySQL读异常[MySQL read exception]
	204	基础组件异常：线程池	204001	多线程执行异常[Multithreading execution exception]
统内部模块错误	301	系统模块异常：鉴权	301001	鉴权异常[authentication exception]
	302	系统模块异常：路由	302001	请求Abase获取元数据异常[Request abase to get meta data exception]
			302002	经过路由过滤，指标未路由到可查模型[After routing filtering, the indicator is not routed to the model]
			302003	专题过滤，专题内不包含指标/维度[The topic does not contain the indicator/dimension]
			302004	指标元信息不存在[Indicator meta information does not exist]
			302005	nuwa元信息内容异常[Abnormal nuwa meta information content]
	303	系统模块异常：元数据处理
	304	系统模块异常：引擎	304001	时间维表超过限制[Time dimension table exceeds limit]
			304002	查询数据量超过上限[Data limit exceeded]
			304101	引擎解析异常[Engine parsing exception]
			304102	ch sql解析异常[Ch sql parse error]
			304103	my sql解析异常[My sql parse error]
			304104	nosql sql解析异常[No sql parse error]
	305	系统模块异常：内存引擎	305001	内存引擎数据转换异常[Memory engine data conversion exception]
	305	系统模块异常：内存引擎	305002	内存引擎数据计算异常[Memory engine data calculation exception]
4xx 依赖下游服务异常	401	依赖下游服务异常：OS	401001	OS服务访问失败[OS service access failed]
			401002	存储引擎Query超时[Storage engine Query timeout]
			401003	储引擎语法错误[Storage engine syntax error]
	402	依赖下游服务异常：Nuwa	402001	nuwa服务访问失败[Nuwa service access failed]

Api returnCode定义(一般采用http状态码，http状态码参考https://httpstatuses.p2hp.com/)

code	value
200	成功
4xx	客户端错误
5xx	服务器端错误
自定义	自定义

最近更新时间：2024.12.20 16:56:33

这个页面对您有帮助吗？

有用

无用