From 31b72f65370cfcc01bf2c5937c8ea1351b28af55 Mon Sep 17 00:00:00 2001 From: sheyanjie-qq <249478495@qq.com> Date: Thu, 19 Sep 2024 23:01:07 +0800 Subject: [PATCH] improve rest api doc --- .../14-reference/05-connector/60-rest-api.mdx | 39 ++++++++++++------- 1 file changed, 25 insertions(+), 14 deletions(-) diff --git a/docs/zh/14-reference/05-connector/60-rest-api.mdx b/docs/zh/14-reference/05-connector/60-rest-api.mdx index de0e7118d4..df6adadcab 100644 --- a/docs/zh/14-reference/05-connector/60-rest-api.mdx +++ b/docs/zh/14-reference/05-connector/60-rest-api.mdx @@ -118,21 +118,32 @@ curl -L -u username:password -d "" :/rest/sql/[db_name][?tz=timez ### HTTP 响应码 -从 `TDengine 3.0.3.0` 开始 `taosAdapter` 提供配置参数 `httpCodeServerError` 用来设置当 C 接口返回错误时是否返回非 200 的http状态码。 -无论是否设置此参数，响应 body 里都有详细的错误码和错误信息，具体请参考 [错误](../rest-api/#错误) 。 +默认情况下，`taosAdapter` 对大多数 C 接口调用出错时也会返回 200 响应码，但是 HTTP body 中包含错误信息。从 `TDengine 3.0.3.0` 开始 `taosAdapter` 提供配置参数 `httpCodeServerError` 用来设置当 C 接口返回错误时是否返回非 200 的 HTTP 响应码。无论是否设置此参数，响应 body 里都有详细的错误码和错误信息，具体请参考 [错误](../rest-api/#错误) 。 -| **说明** | **httpCodeServerError false** | **httpCodeServerError true** | -|--------------------|-------------------------------|---------------------------------------| -| taos_errno() 返回 0 | 200 | 200 | -| taos_errno() 返回 非0 | 200（除鉴权错误） | 500 （除鉴权错误和 400/502/503 错误） | -| 参数错误 | 400（仅处理 HTTP 请求 URL 参数错误） | 400 （处理 HTTP 请求 URL 参数错误和 taosd 返回错误） | -| 鉴权错误 | 401 | 401 | -| 接口不存在 | 404 | 404 | -| 集群不可用错误 | 502 | 502 | -| 系统资源不足 | 503 | 503 | +**当 httpCodeServerError 为 false 时：** -返回 400 的 C 错误码为： +| **分类说明** |**HTTP 响应码** | +|--------------------|-------------------------------| +| C 接口调用成功 | 200 | 200 | +| C 接口调用出错，且不是鉴权错误 | 200 | +| HTTP 请求 URL 参数错误 | 400 | +| C 接口调用鉴权错误 | 401 | +| 接口不存在 | 404 | +| 系统资源不足 | 503 | +**当 httpCodeServerError 为 true 时：** + +| **分类说明** | **HTTP 响应码** | +|--------------------|-------------------------------| +| C 接口调用成功 | 200 | +| HTTP 请求 URL 参数错误和 C 接口调用参数解析错误 | 400 | +| C 接口调用鉴权错误 | 401 | +| 接口不存在 | 404 | +| C 接口调用网络不可用错误 | 502 | +| 系统资源不足 |503 | +| 其他 C 接口调用错误 | 500 | + + C 接口参数解析相关错误码： - TSDB_CODE_TSC_SQL_SYNTAX_ERROR (0x0216) - TSDB_CODE_TSC_LINE_SYNTAX_ERROR (0x021B) - TSDB_CODE_PAR_SYNTAX_ERROR (0x2600) @@ -140,7 +151,7 @@ curl -L -u username:password -d "" :/rest/sql/[db_name][?tz=timez - TSDB_CODE_TSC_VALUE_OUT_OF_RANGE (0x0224) - TSDB_CODE_PAR_INVALID_FILL_TIME_RANGE (0x263B) -返回 401 的错误码为： +C 接口鉴权相关错误码： - TSDB_CODE_MND_USER_ALREADY_EXIST (0x0350) - TSDB_CODE_MND_USER_NOT_EXIST (0x0351) @@ -151,7 +162,7 @@ curl -L -u username:password -d "" :/rest/sql/[db_name][?tz=timez - TSDB_CODE_MND_INVALID_ALTER_OPER (0x0356) - TSDB_CODE_MND_AUTH_FAILURE (0x0357) -返回 502 的错误码为： +C 接口网络不可用相关错误码： - TSDB_CODE_RPC_NETWORK_UNAVAIL (0x000B)