データサービスのレスポンスとHTTPステータスコード

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

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

応答

データサービスは、JSON 本文を含む HTTP 応答を返します。

注記：
複数の SQL ステートメントを含むエンドポイントを呼び出すと、Data Service はステートメントを 1 つずつ実行しますが、HTTP 応答では最後のステートメントの実行結果のみを返します。

レスポンス本文には次のフィールドが含まれます。

type :文字列。このエンドポイントのタイプ。値は"sql_endpoint"または"chat2data_endpoint"になります。エンドポイントによって返されるレスポンスのタイプは異なります。
data :オブジェクト。実行結果には3つの部分が含まれます。
- columns :配列。返されるフィールドのスキーマ情報。
- rows :配列。4 key:value形式で結果が返されます。
  エンドポイントに対してバッチ操作が有効になっていて、エンドポイントの最後の SQL ステートメントがINSERTまたはUPDATE操作である場合は、次の点に注意してください。
  - エンドポイントから返される結果には、応答とステータスを示す各行の"message"フィールドと"success"フィールドも含まれます。
  - ターゲットテーブルの主キー列がauto_incrementに設定されている場合、エンドポイントから返される結果には各行の"auto_increment_id"フィールドも含まれます。このフィールドの値は、 INSERT操作の場合は自動インクリメント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
        }
    }
}

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

このステータスコードは、リクエストで許可されていないメソッドが使用されたことを示します。データサービスは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
    }
  }
}

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

データサービスのレスポンスとHTTPステータスコード

応答

ステータスコード

200

400

401

404

405

408

429

500

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