組織ステータス API¶

概要¶

今月の現時点までの利用合計を取得できます。

今月の合計コネクション数¶

API URL:: https://api.sora-cloud.shiguredo.app/orgs/get-total-connections-this-month

組織の今月の合計コネクション数を取得します。

$ curl -sS \
    -X POST \
    https://api.sora-cloud.shiguredo.app/orgs/get-total-connections-this-month \
    -H "Authorization: Bearer <API-KEY>" \
    | jq .
32

今月の合計セッション数¶

API URL:: https://api.sora-cloud.shiguredo.app/orgs/get-total-sessions-this-month

今月の合計セッション数を取得します。

$ curl -sS \
    -X POST \
    https://api.sora-cloud.shiguredo.app/orgs/get-total-sessions-this-month \
    -H "Authorization: Bearer <API-KEY>" \
    | jq .
19

今月の合計接続時間(分)¶

API URL:: https://api.sora-cloud.shiguredo.app/orgs/get-total-duration-min-this-month

今月の合計接続時間(分)を取得します。 1 接続時間が 1 分に満たない場合は 0 分とした上で集計します。0 分未満で複数回接続して合計接続時間が 1 分を超えた場合も結果は 0 分となります。

$ curl -sS \
    -X POST \
    https://api.sora-cloud.shiguredo.app/orgs/get-total-duration-min-this-month \
    -H "Authorization: Bearer <API-KEY>" \
    | jq .
62

今月の合計トラフィック¶

API URL:: https://api.sora-cloud.shiguredo.app/orgs/get-total-traffic-this-month

今月の合計転送量(バイト)を取得します

Ingress は受信
Egress は送信

$ curl -sS \
    -X POST \
    https://api.sora-cloud.shiguredo.app/orgs/get-total-traffic-this-month \
    -H "Authorization: Bearer <API-KEY>" \
    | jq .
{
    "ingress": 334802932,
    "egress": 271316192
}

今月の最大同時接続数¶

API URL:: https://api.sora-cloud.shiguredo.app/orgs/get-max-concurrent-connections-this-month

今月の最大同時接続数を取得します。

$ curl -sS \
    -X POST \
    https://api.sora-cloud.shiguredo.app/orgs/get-max-concurrent-connections-this-month \
    -H "Authorization: Bearer <API-KEY>" \
    | jq .
2

今月の最大利用帯域 (Mbps)¶

API URL:: https://api.sora-cloud.shiguredo.app/orgs/get-max-bandwidth-mbps-this-month

今月の最大帯域を取得します。 1 Mbps に満たない場合は 0 を返却します (切り捨て) 。

$ curl -sS \
    -X POST \
    https://api.sora-cloud.shiguredo.app/orgs/get-max-bandwidth-mbps-this-month \
    -H "Authorization: Bearer <API-KEY>" \
    | jq .
2

今月の API リクエスト数¶

API URL:: https://api.sora-cloud.shiguredo.app/orgs/get-total-api-requests-this-month

今月の API リクエスト数を取得します。

$ curl -sS \
    -X POST \
    https://api.sora-cloud.shiguredo.app/orgs/get-total-api-requests-this-month \
    -H "Authorization: Bearer <API-KEY>" \
    | jq .
1418

今月の Sora API リクエスト数¶

API URL:: https://api.sora-cloud.shiguredo.app/orgs/get-total-sora-api-requests-this-month

今月の Sora API リクエスト数を取得します。

$ curl -sS \
    -X POST \
    https://api.sora-cloud.shiguredo.app/orgs/get-total-sora-api-requests-this-month \
    -H "Authorization: Bearer <API-KEY>" \
    | jq .
22

今月のウェブフックリクエスト数¶

API URL:: https://api.sora-cloud.shiguredo.app/orgs/get-total-webhook-requests-this-month

今月のウェブフックリクエスト数を取得します。

$ curl -sS \
    -X POST \
    https://api.sora-cloud.shiguredo.app/orgs/get-total-webhook-requests-this-month \
    -H "Authorization: Bearer <API-KEY>" \
    | jq .
400

組織 ステータス API¶

概要¶