Restful API | SwarmCloud中文文档

BASE URL

欧洲 https://cgi.cdnbye.com:2087/v1
中国香港 https://cgi.swarmcloud.net:2087/v1
美国 https://cgi.hdtvcloud.com:2087/v1

限速: 2000次请求每分钟

获取Token

获取当前账户的token

POST /user/token

POST /user/token

请求体

参数名	参数类型	描述	是否必须
email	string	用户邮箱	是
passwd	string	对原始密码进行sha256加密后的字符串	是

响应

json

Status: 200

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

Status: 200

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

参数名	参数类型	描述
id	int	用户ID
token	string	用户token，有效期14天

获取域名/AppId列表

获取某个用户的所有域名/APP列表

GET /user/user_id/{user_id}/domain

GET /user/user_id/{user_id}/domain

HTTP请求头

参数名	参数类型	描述	是否必须
MyToken	string	用户token	是

查询参数

参数名	参数类型	描述	是否必须
page	int	当前页数	是
page_size	int	每页大小	是

响应

json

Status: 200

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

Status: 200

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

参数名	参数类型	描述
id	int	域名/APP的ID
domain	string	域名/AppId
uid	int	用户ID
native	bool	是否原生应用
isValid	bool	域名是否已绑定

设置时区

设置您所在时区的UTC偏移量

GET /user/user_id/{user_id}/timezone

GET /user/user_id/{user_id}/timezone

HTTP请求头

参数名	参数类型	描述	是否必须
MyToken	string	用户token	是

路径参数

参数名	参数类型	描述	是否必须
user_id	string	用户ID	是

请求体

参数名	参数类型	描述	是否必须
utc	int	UTC偏移量	是

获取实时数据

获取某个或者汇总的域名/APP的实时数据

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

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

HTTP请求头

参数名	参数类型	描述	是否必须
MyToken	string	用户token	是

路径参数

参数名	参数类型	描述	是否必须
user_id	string	用户ID	是
domain_id	string	域名ID("0"代表获取所有域名/APP的汇总数据)	是

响应

json

Status: 200

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

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

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"代表获取所有域名/APP的汇总数据)	是

查询参数

参数名	参数类型	描述	是否必须
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}
          ]
    }
}

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

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"代表获取所有域名/APP的汇总数据)	是

查询参数

参数名	参数类型	描述	是否必须
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}
          ]
    }
}

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

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
    }
}

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请求头

路径参数

请求体

响应