📣新登場!TiDB Cloud BYOC、TiDB Cloud Filesystem、PostgreSQL-compatible TiDB Cloud Starter がパブリックプレビュー中。このページは自動翻訳されたものです。原文はこちらからご覧ください。

Data Serviceの応答とHTTPステータスコード



Data Serviceで定義されたAPIエンドポイントを呼び出すと、Data ServiceはHTTPレスポンスを返します。このレスポンスの構造とステータスコードの意味を理解することは、Data Serviceのエンドポイントから返されるデータを解釈する上で不可欠です。

このドキュメントでは、TiDB CloudのData Serviceの応答とステータスコードについて説明します。

応答

Data Serviceは、JSON形式のボディを持つHTTPレスポンスを返します。

レスポンスボディには以下のフィールドが含まれます。

  • type :文字列。このエンドポイントのタイプ。値は"sql_endpoint"です。

  • data :オブジェクト。実行結果は、次の3つの部分から構成されます。

    • columns :配列。返されるフィールドのスキーマ情報。

    • rows :配列。返される結果はkey:value形式です。

      エンドポイントでBatch Operationが有効になっており、エンドポイントの最後の SQL文がINSERTまたはUPDATE操作である場合は、次の点に注意してください。

      • エンドポイントから返される結果には、各行の応答とステータスを示す"message"および"success"フィールドも含まれます。
      • 対象テーブルの主キー列がauto_incrementに設定されている場合、エンドポイントから返される結果には、各行の"auto_increment_id"フィールドも含まれます。このフィールドの値は、 INSERT操作のAUTO_INCREMENT ID であり、 UPDATEなどの他の操作の場合はnullとなります。
    • result :オブジェクト。SQL文の実行関連情報。成功/失敗ステータス、実行時間、返された行数、ユーザー構成などが含まれます。

応答の例は以下のとおりです。

{ "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 } } }

ステータスコード

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 キーのレート制限を超えていることを示します。さらに多くの割り当てが必要な場合は、サポートチームにリクエストを送信してください。

応答の例は以下のとおりです。

{ "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://tidb.support.pingcap.com/", "start_ms": "", "end_ms": "", "latency": "", "row_count": 0, "row_affect": 0, "limit": 0 } } }

500

このステータスコードは、リクエスト中に内部エラーが発生したことを示しています。このエラーには様々な原因が考えられます。

考えられる原因の一つは、認証サーバーに接続できなかったために認証が失敗したことです。

応答の例は以下のとおりです。

{ "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 Starterインスタンスに接続できないことにも関連している可能性があります。トラブルシューティングについては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 } } }

このページは役に立ちましたか?