TiDB Cloudの請求情報のAPIが公開されたため使ってみた

こんにちは、ゲームソリューション部のsoraです。
今回は、TiDB Cloudの請求情報のAPIが公開されたため使ってみたことについて書いていきます。

はじめに

TiDB自体の説明は本記事ではしません。
TiDBとは何かについては、以下の記事をご参照ください。

今回は、こちらの公式ページを参考に、TiDB Cloudの請求情報APIを使っていきます。

TiDB CloudのAPIキーの作成

TiDB Cloudにログインして、Organization Settings＞API KeysからCreate API KeyでAPIキーを作成します。
Organization RoleでOrganization Owner権限がないと作成できないことはご注意ください。

API利用時に必要なパブリックキーとプライベートキーが表示されます。

TiDB Cloudの請求情報の取得

APIキーが作成できたため、curlで請求情報を取得します。
パブリックキーとプライベートキーには、先ほど作成したものを入れてください。
YYYY-MMには、請求情報を取得したい年と月を入れてください。

$ curl --digest \
   --user '<パブリックキー>:<プライベートキー>' \
   --request GET \
   --url https://billing.tidbapi.com/v1beta1/bills/YYYY-MM
{
    "overview": {
      "billedMonth": "2023-10",
      "runningTotal": "0",
      "discounts": "0",
      "credits": "0",
      "totalCost": "0"
    },
    "summaryByProject": {
      "projects": null,
      "otherCharges": null
    },
    "summaryByService": null
}

今回は請求が何も発生していないため、表示項目が少ないですが、TiDB CloudのBiilingで見れる情報は見れると思います。
他で確認した限りでも、プロジェクトごとの料金やNode ComputeやNode Storageなどの項目別の料金、Node Computeの中でもTiDB・TiKV・TiFlashそれぞれの料金などを取得することができました。

また実際にはやっていませんが、APIキーごとに1分あたり最大100件のリクエストといったレート制限もあります。

参考情報

TiDB Cloud Billing System OPENAPI (v1beta1)

最後に

今回は、TiDB Cloudの請求情報のAPIが公開されたため使ってみたことを記事にしました。
どなたかの参考になると幸いです。