データサービスのレスポンスコードとHTTPステータスコード
データサービスで定義された API エンドポイントを呼び出すと、Data Service は HTTP 応答を返します。 Data Service エンドポイントから返されたデータを解釈するには、この応答の構造とステータス コードの意味を理解することが不可欠です。
このドキュメントでは、 TiDB Cloudのデータ サービスの応答コードとステータス コードについて説明します。
応答
Data Service は、JSON 本文を含む HTTP 応答を返します。
注記：
複数の SQL ステートメントを使用してエンドポイントを呼び出すと、Data Service はステートメントを 1 つずつ実行しますが、HTTP 応答の最後のステートメントの実行結果のみを返します。
応答本文には次のフィールドが含まれます。
type:文字列。このエンドポイントのタイプ。値は"sql_endpoint"または"chat2data_endpoint"である可能性があります。エンドポイントが異なれば、返される応答の種類も異なります。data:オブジェクト。実行結果には次の 3 つの部分が含まれます。columns:配列。返されたフィールドのスキーマ情報。rows:配列。返される結果はkey:value形式です。エンドポイントに対してバッチ操作が有効であり、エンドポイントの最後の SQL ステートメントが
INSERT、UPDATE、またはDELETE操作である場合は、次の点に注意してください。- エンドポイントから返される結果には、応答とステータスを示す各行の
"message"フィールドと"success"フィールドも含まれます。 - ターゲット テーブルの主キー列が
auto_incrementとして構成されている場合、エンドポイントから返される結果には、各行の"auto_increment_id"フィールドも含まれます。このフィールドの値は、INSERT操作の自動インクリメント ID であり、UPDATEやDELETEなどの他の操作の場合はnullです。
- エンドポイントから返される結果には、応答とステータスを示す各行の
result:オブジェクト。 SQL ステートメントの実行関連情報 (成功/失敗ステータス、実行時間、返された行数、ユーザー構成など)。
応答の例は次のとおりです。
- SQL Endpoint
- Chat2Data Endpoint
{
"type": "sql_endpoint",
"data": {
"columns": [],
"rows": [
{
"auto_increment_id": "270001",
"index": "0",
"message": "Row insert successfully",
"success": "true"
},
{
"auto_increment_id": "270002",
"index": "1",
"message": "Row insert successfully",
"success": "true"
}
],
"result": {
"code": 200,
"message": "Query OK, 2 rows affected (8.359 sec)",
"start_ms": 1689593360560,
"end_ms": 1689593368919,
"latency": "8.359s",
"row_count": 2,
"row_affect": 2,
"limit": 500
}
}
}
{
"type": "chat2data_endpoint",
"data": {
"columns": [
{
"col": "id",
"data_type": "BIGINT",
"nullable": false
},
{
"col": "type",
"data_type": "VARCHAR",
"nullable": false
}
],
"rows": [
{
"id": "20008295419",
"type": "CreateEvent"
}
],
"result": {
"code": 200,
"message": "Query OK!",
"start_ms": 1678965476709,
"end_ms": 1678965476839,
"latency": "130ms",
"row_count": 1,
"row_affect": 0,
"limit": 50
"sql": "select id,type from sample_data.github_events limit 1;",
"ai_latency": "30ms"
}
}
}
ステータスコード
200
HTTP ステータス コードが200で、 data.result.codeフィールドにも200表示されている場合は、SQL ステートメントが正常に実行されたことを示します。そうしないと、 TiDB Cloud はエンドポイントで定義された SQL ステートメントの実行に失敗します。詳細については、 codeフィールドとmessageフィールドを確認してください。
応答の例は次のとおりです。
{
"type": "sql_endpoint",
"data": {
"columns": [],
"rows": [],
"result": {
"code": 1146,
"message": "table not found",
"start_ms": "",
"end_ms": "",
"latency": "",
"row_count": 0,
"row_affect": 0,
"limit": 0
}
}
}
400
このステータス コードは、パラメータ チェックが失敗したことを示します。
応答の例は次のとおりです。
{
"type": "sql_endpoint",
"data": {
"columns": [],
"rows": [],
"result": {
"code": 400,
"message": "param check failed! {detailed error}",
"start_ms": "",
"end_ms": "",
"latency": "",
"row_count": 0,
"row_affect": 0,
"limit": 0
}
}
}
401
このステータス コードは、権限がないために認証が失敗したことを示します。
応答の例は次のとおりです。
{
"type": "sql_endpoint",
"data": {
"columns": [],
"rows": [],
"result": {
"code": 401,
"message": "auth failed",
"start_ms": "",
"end_ms": "",
"latency": "",
"row_count": 0,
"row_affect": 0,
"limit": 0
}
}
}
404
このステータス コードは、指定されたエンドポイントが見つからないために認証が失敗したことを示します。
応答の例は次のとおりです。
{
"type": "sql_endpoint",
"data": {
"columns": [],
"rows": [],
"result": {
"code": 404,
"message": "endpoint not found",
"start_ms": "",
"end_ms": "",
"latency": "",
"row_count": 0,
"row_affect": 0,
"limit": 0
}
}
}
405
このステータス コードは、リクエストで許可されていないメソッドが使用されたことを示します。 Data Service はGETとPOSTのみをサポートすることに注意してください。
応答の例は次のとおりです。
{
"type": "sql_endpoint",
"data": {
"columns": [],
"rows": [],
"result": {
"code": 405,
"message": "method not allowed",
"start_ms": "",
"end_ms": "",
"latency": "",
"row_count": 0,
"row_affect": 0,
"limit": 0
}
}
}
408
このステータス コードは、リクエストがエンドポイントのタイムアウト期間を超えたことを示します。エンドポイントのタイムアウトを変更するには、 プロパティの構成を参照してください。
応答の例は次のとおりです。
{
"type": "sql_endpoint",
"data": {
"columns": [],
"rows": [],
"result": {
"code": 408,
"message": "request timeout.",
"start_ms": "",
"end_ms": "",
"latency": "",
"row_count": 0,
"row_affect": 0,
"limit": 0
}
}
}
429
このステータス コードは、リクエストが API キーのレート制限を超えていることを示します。さらに割り当てが必要な場合は、サポート チームにおリクエストを送信するください。
応答の例は次のとおりです。
- SQL Endpoint
- Chat2Data Endpoint
{
"type": "",
"data": {
"columns": [],
"rows": [],
"result": {
"code": 49900007,
"message": "The request exceeded the limit of 100 times per apikey per minute. For more quota, please contact us: https://support.pingcap.com/hc/en-us/requests/new?ticket_form_id=7800003722519",
"start_ms": "",
"end_ms": "",
"latency": "",
"row_count": 0,
"row_affect": 0,
"limit": 0
}
}
}
{
"type": "chat2data_endpoint",
"data": {
"columns": [],
"rows": [],
"result": {
"code": 429,
"message": "The AI request exceeded the limit of 100 times per day. For more quota, please contact us: https://support.pingcap.com/hc/en-us/requests/new?ticket_form_id=7800003722519",
"start_ms": "",
"end_ms": "",
"latency": "",
"row_count": 0,
"row_affect": 0,
"limit": 0
}
}
}
500
このステータス コードは、リクエストで内部エラーが発生したことを示します。このエラーにはさまざまな原因が考えられます。
考えられる原因の 1 つは、認証サーバーに接続できないために認証に失敗したことです。
応答の例は次のとおりです。
{
"type": "sql_endpoint",
"data": {
"columns": [],
"rows": [],
"result": {
"code": 500,
"message": "internal error! defaultPermissionHelper: rpc error: code = DeadlineExceeded desc = context deadline exceeded",
"start_ms": "",
"end_ms": "",
"latency": "",
"row_count": 0,
"row_affect": 0,
"limit": 0
}
}
}
これは、 TiDB Cloudクラスターに接続できないことにも関係している可能性があります。トラブルシューティングについてはmessageを参照する必要があります。
{
"type": "sql_endpoint",
"data": {
"columns": [],
"rows": [],
"result": {
"code": 500,
"message": "internal error! {detailed error}",
"start_ms": "",
"end_ms": "",
"latency": "",
"row_count": 0,
"row_affect": 0,
"limit": 0
}
}
}