Restful API | SwarmCloud 日本語ドキュメント

BASE URL

広州 https://cgi-cn.cdnbye.com/v1
香港 https://cgi.swarmcloud.net/v1
アメリカ https://cgi-us.swarmcloud.net/v1
ヨーロッパ https://cgi-eu.swarmcloud.net/v1

レート制限: 2000リクエスト/分

Tokenの取得

現在のアカウントのtokenを取得します

POST /user/token

リクエストボディ

パラメータ名	型	説明	必須
email	string	ユーザーのメールアドレス	はい
passwd	string	元のパスワードをsha256で暗号化した文字列	はい

レスポンス

json

Status: 200

{
  "ret": 0,
  "name": "token",
  "data":
    {
      "id": 001,
      "token": "xxxxxx"
    }
}

パラメータ名	型	説明
id	int	ユーザーID
token	string	ユーザーtoken、有効期限14日間

ドメイン/AppId一覧の取得

特定ユーザーのすべてのドメイン/アプリ一覧を取得します

GET /user/user_id/{user_id}/domain

HTTPリクエストヘッダー

パラメータ名	型	説明	必須
MyToken	string	ユーザーtoken	はい

クエリパラメータ

パラメータ名	型	説明	必須
page	int	現在のページ番号	はい
page_size	int	1ページあたりの件数	はい

レスポンス

json

Status: 200

{
  "ret": 0,
  "name": "domain"
  "data":
    [
      {
        "id": 001,
        "domain": "xxx.com",
        "uid": 001,
        "native": false,
        "isValid": false
      }
    ]
}

パラメータ名	型	説明
id	int	ドメイン/アプリのID
domain	string	ドメイン/AppId
uid	int	ユーザーID
native	bool	ネイティブアプリかどうか
isValid	bool	ドメインが紐付け済みかどうか

タイムゾーンの設定

お使いのタイムゾーンのUTCオフセットを設定します

GET /user/user_id/{user_id}/timezone

HTTPリクエストヘッダー

パラメータ名	型	説明	必須
MyToken	string	ユーザーtoken	はい

パスパラメータ

パラメータ名	型	説明	必須
user_id	string	ユーザーID	はい

リクエストボディ

パラメータ名	型	説明	必須
utc	int	UTCオフセット	はい

リアルタイムデータの取得

特定または集計されたドメイン/アプリのリアルタイムデータを取得します

GET /user/user_id/{user_id}/domain/domain_id/{domain_id}

HTTPリクエストヘッダー

パラメータ名	型	説明	必須
MyToken	string	ユーザーtoken	はい

パスパラメータ

パラメータ名	型	説明	必須
user_id	string	ユーザーID	はい
domain_id	string	ドメインID（"0"はすべてのドメイン/アプリの集計データを取得することを表します）	はい

レスポンス

json

Status: 200

{
  "ret": 0,
  "name": "domain",
  "data":
    {
      "num_rt": 456,
      "num_max": 892,
      "traffic_p2p_day": 1022794195,
      "api_frequency_day": 14805,
     }
}

パラメータ名	型	説明
num_rt	int	現在の同時接続ユーザー数
num_max	int	過去の同時接続ユーザー数のピーク
traffic_p2p_day	int	本日のP2Pトラフィック（KB）
api_frequency_day	int	本日の再生回数

過去のP2Pトラフィックデータの取得

指定した期間のP2Pトラフィックデータを取得します

GET /user/user_id/{user_id}/domain/domain_id/{domain_id}/p2p

HTTPリクエストヘッダー

パラメータ名	型	説明	必須
MyToken	string	ユーザーtoken	はい

パスパラメータ

パラメータ名	型	説明	必須
user_id	string	ユーザーID	はい
domain_id	string	ドメインID（"0"はすべてのドメイン/アプリの集計データを取得することを表します）	はい

クエリパラメータ

パラメータ名	型	説明	必須
start_ts	int	開始タイムスタンプ（UTC+8）	はい
end_ts	int	終了タイムスタンプ（UTC+8）	はい
gran	int	常に1440	はい

レスポンス

json

Status: 200

{
  "ret": 0,
  "name": "statistic",
  "data":
    {
      "max":
        {
          "ts": 1591372800,
          "value": 541188637412
        },
        "list":
          [
            {"ts":1590854400,"value":1591200000},
            {"ts":1590940800,"value":194511284034},
            {"ts":1591027200,"value":541188637412}
          ]
    }
}

パラメータ名	型	説明
max	object	過去データの最大値
list	array	すべての過去データからなる配列
ts	int	タイムスタンプ
value	int	P2Pトラフィック（KB）

過去の同時接続ユーザー数データの取得

指定した期間の同時接続ユーザー数を取得します

GET /user/user_id/{user_id}/domain/domain_id/{domain_id}/num

HTTPリクエストヘッダー

パラメータ名	型	説明	必須
MyToken	string	ユーザーtoken	はい

パスパラメータ

パラメータ名	型	説明	必須
user_id	string	ユーザーID	はい
domain_id	string	ドメインID（"0"はすべてのドメイン/アプリの集計データを取得することを表します）	はい

クエリパラメータ

パラメータ名	型	説明	必須
start_ts	int	開始タイムスタンプ（UTC+8）	はい
end_ts	int	終了タイムスタンプ（UTC+8）	はい
gran	int	5分の整数倍である必要があります	はい

レスポンス

json

Status: 200

{
  "ret": 0,
  "name": "statistic",
  "data":
    {
      "max":
        {
          "ts": 1591372800,
          "value": 109566
        },
        "list":
          [
            {"ts":1590854400,"value":66504},
            {"ts":1590940800,"value":72373},
            {"ts":1591027200,"value":78300}
          ]
    }
}

パラメータ名	型	説明
max	object	過去データの最大値
list	array	すべての過去データからなる配列
ts	int	タイムスタンプ
value	int	同時接続ユーザー数

P2Pの有効化/無効化

同じアカウントで複数のドメイン/APPIDを紐付けている場合、P2Pを有効にしているすべてのドメイン/APPIDはトラフィックパックを共有します。ここで特定のドメイン/APPIDのP2Pサービスを無効にすることで、トラフィックパックの消費を抑えることができます。

POST /user/user_id/{user_id}/domain/domain_id/{domain_id}/control

HTTPリクエストヘッダー

パラメータ名	型	説明	必須
MyToken	string	ユーザーtoken	Yes

パスパラメータ

パラメータ名	型	説明	必須
user_id	string	ユーザーID	Yes
domain_id	string	ドメインID	Yes

リクエストボディ

パラメータ名	型	説明	必須
disable	bool	trueを設定するとp2pを無効化、falseを設定するとp2pを有効化	Yes

レスポンス

json

Status: 200

{
  "ret":0,
  "name":"control",
  "data":
    {
      "allow":true,
      "succeed":true
    }
}

BASE URL ​

Tokenの取得 ​

リクエストボディ ​

レスポンス ​

ドメイン/AppId一覧の取得 ​

HTTPリクエストヘッダー ​

クエリパラメータ ​

レスポンス ​

タイムゾーンの設定 ​

HTTPリクエストヘッダー ​

パスパラメータ ​

リクエストボディ ​

リアルタイムデータの取得 ​

HTTPリクエストヘッダー ​

パスパラメータ ​

レスポンス ​

過去のP2Pトラフィックデータの取得 ​

HTTPリクエストヘッダー ​

パスパラメータ ​

クエリパラメータ ​

レスポンス ​

過去の同時接続ユーザー数データの取得 ​

HTTPリクエストヘッダー ​

パスパラメータ ​

クエリパラメータ ​

レスポンス ​

P2Pの有効化/無効化 ​

HTTPリクエストヘッダー ​

パスパラメータ ​

リクエストボディ ​

レスポンス ​

BASE URL

Tokenの取得

リクエストボディ

レスポンス

ドメイン/AppId一覧の取得

HTTPリクエストヘッダー

クエリパラメータ

レスポンス

タイムゾーンの設定

HTTPリクエストヘッダー

パスパラメータ

リクエストボディ

リアルタイムデータの取得

HTTPリクエストヘッダー

パスパラメータ

レスポンス

過去のP2Pトラフィックデータの取得

HTTPリクエストヘッダー

パスパラメータ

クエリパラメータ

レスポンス

過去の同時接続ユーザー数データの取得

HTTPリクエストヘッダー

パスパラメータ

クエリパラメータ

レスポンス

P2Pの有効化/無効化

HTTPリクエストヘッダー

パスパラメータ

リクエストボディ

レスポンス