Skip to content

Latest commit

 

History

History
142 lines (95 loc) · 3.59 KB

tidb_http_api.md

File metadata and controls

142 lines (95 loc) · 3.59 KB
Raw

TiDB HTTP API

TiDBIP is the ip of the TiDB server. 10080 is the default status port, and you can edit it in tidb.toml when starting the TiDB server.

  1. Get the current status of TiDB, including the connections, version and git_hash

    curl http://{TiDBIP}:10080/status

  2. Get all metrics of TiDB

    curl http://{TiDBIP}:10080/metrics

  3. Get the metadata of all regions

    curl http://{TiDBIP}:10080/regions/meta

  4. Get the information of a specific region by ID

    curl http://{TiDBIP}:10080/regions/{regionID}

  5. Get regions Information from db.table

    curl http://{TiDBIP}:10080/tables/{db}/{table}/regions

  6. Get schema Information about all db

    curl http://{TiDBIP}:10080/schema

  7. Get schema Information about db

    curl http://{TiDBIP}:10080/schema/{db}

  8. Get schema Information about db.table, and you can get schema info by tableID (tableID is the unique identifier of table in TiDB)

    curl http://{TiDBIP}:10080/schema/{db}/{table}

curl http://{TiDBIP}:10080/schema?table_id={tableID}

  9. Get disk-usage info about db.table

    curl http://{TiDBIP}:10080/tables/{db}/{table}/disk-usage

  10. Get MVCC Information of the key with a specified handle ID

    curl http://{TiDBIP}:10080/mvcc/key/{db}/{table}/{handle}

  11. Get MVCC Information of the first key in the table with a specified start ts

    curl http://{TiDBIP}:10080/mvcc/txn/{startTS}/{db}/{table}

  12. Get MVCC Information by a hex value

    curl http://{TiDBIP}:10080/mvcc/hex/{hexKey}

  13. Get MVCC Information of a specified index key, argument example: column_name_1=column_value_1&column_name_2=column_value2...

    curl http://{TiDBIP}:10080/mvcc/index/{db}/{table}/{index}/{handle}?${c1}={v1}&${c2}=${v2}

    Hint: For the index column which column type is timezone dependent, e.g. timestamp, convert its value to UTC timezone.

  14. Get TiDB server settings

    curl http://{TiDBIP}:10080/settings

  15. Get TiDB server information.

    curl http://{TiDBIP}:10080/info

  16. Get TiDB cluster all servers information.

    curl http://{TiDBIP}:10080/info/all

  17. Enable/Disable TiDB server general log

    curl -X POST -d "tidb_general_log=1" http://{TiDBIP}:10080/settings
curl -X POST -d "tidb_general_log=0" http://{TiDBIP}:10080/settings

  18. Change TiDB server log level

    curl -X POST -d "log_level=debug" http://{TiDBIP}:10080/settings
curl -X POST -d "log_level=info" http://{TiDBIP}:10080/settings

  19. Change TiDB DDL slow log threshold

    The unit is millisecond.

    curl -X POST -d "ddl_slow_threshold=300" http://{TiDBIP}:10080/settings

  20. Get the column value by an encoded row and some information that can be obtained from a column of the table schema information.

    Argument example: rowBin=base64_encoded_row_value

    curl http://{TiDBIP}:10080/tables/{colID}/{colFlag}/{colLen}?rowBin={val}

    Hint: For the column which field type is timezone dependent, e.g. timestamp, convert its value to UTC timezone.

  21. Resign the ddl owner, let tidb start a new ddl owner election.

    curl -X POST http://{TiDBIP}:10080/ddl/owner/resign

    Note: If you request a tidb that is not ddl owner, the response will be This node is not a ddl owner, can't be resigned.