接口文档

  • 全局公共参数
  • 认证账户相关
    • 删除认证账户
    • 新增/编辑认证账户
    • 获取认证账户列表
  • IP相关
    • 导出独享数据中心IP/静态住宅IP
    • 独享数据中心IP
    • 获取动态-数量
    • 静态住宅IP
  • 流量相关
    • 查询主账号流量
    • 查询主账号流量明细-按天
    • 查询主账号流量明细-按小时
    • 查询认证账户流量
    • 获取剩余流量
  • 其他
    • 删除域名屏蔽
    • 添加域名屏蔽
    • 访问域名屏蔽列表
  • 国家城市
    • 查看国家下的州
    • 查看国家列表
    • 查看州下的城市
    • 查看静态和数据中心可以开通的城市
  • 订单相关
    • 动态流量订单
    • 独享数据中心订单
    • 静态住宅订单
  • 白名单相关
    • 删除白名单
    • 查找白名单
    • 添加白名单

全局公共参数

基本信息

接口描述:全局公共参数是针对项目而言的,所有请求的 HTTP 类型的接口都需要携带此参数。

请求参数

Body

参数名称 参数值 是否必须 示例 备注
appkey 是 您账户的appkey

认证账户相关

删除认证账户

基本信息

Path: https://gapi.roxlabs.cn/api/del_child

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id string 是 509 要删除的认证账户id

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data string 非必须
timestamp number 非必须

新增/编辑认证账户

基本信息

Path: https://gapi.roxlabs.cn/api/save_child

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
username string 是 testshi12 用户名
password integer 否 123456 密码
status text 是 1 账户状态:0=禁用,1=启用
limit_flow text 是 输入使用上限/G
remark text 是 备注

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data null 非必须
timestamp number 非必须

获取认证账户列表

基本信息

Path: https://gapi.roxlabs.cn/api/get_child_list

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

名称 类型 是否必须 默认值 备注 其他信息
非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data object 非必须
├─ count number 非必须
├─ list object [] 非必须

item 类型: object

├─ id number 必须
├─ create_time number 必须
├─ update_time number 必须
├─ uid number 必须
├─ account string 必须
├─ password string 必须
├─ state number 必须
├─ consumed_flow number 必须
├─ limit_flow number 必须 认证账户流量上限【G】
├─ flow_type string 必须
├─ account_type string 必须
├─ check_white_list number 必须
├─ remark string 必须
├─ use_flow number 必须
├─ consumed number 必须
├─ limit number 必须
├─ tag string 必须
├─ balance string 必须 当前可用流量【KB】
timestamp number 非必须

IP相关

导出独享数据中心IP/静态住宅IP

基本信息

Path: https://gapi.roxlabs.cn/api/static_ip_export

Method: GET

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Query

参数名称 是否必须 示例 备注
status 否 状态:未过期=>Not Expire,过期=>Expire
region 否 地区
ip 否 IP段
order_id 否 订单号
type 是 1 类型1数据中心2静态住宅

Body

名称 类型 是否必须 默认值 备注 其他信息
非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息

独享数据中心IP

基本信息

Path: https://gapi.roxlabs.cn/api/static_ip_list

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
ip string 是 IP段
remark integer 否 备注
region text 是 地区
status text 是 状态:未过期=>Not Expire,过期=>Expire
page text 是 1 页数
limit text 是 10 条数

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data object 非必须
├─ count number 非必须
├─ limit number 非必须
├─ list string [] 非必须

item 类型: string

├─ 非必须
├─ page number 非必须
timestamp number 非必须

获取动态-数量

基本信息

Path: https://gapi.roxlabs.cn/api/balance_info

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

名称 类型 是否必须 默认值 备注 其他信息
非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data object 非必须
├─ all_buy number 非必须 累计额度
├─ balance number 非必须 剩余额度
├─ balance_consumed number 非必须 已使用额度
├─ duration10 number 非必须 短效池 1~5min ¥/IP
├─ duration30 number 非必须 短效池 1~5min ¥/IP
├─ duration5 number 非必须 长效池 10~30min ¥/IP
├─ duration_expire_time number 非必须
timestamp number 非必须

静态住宅IP

基本信息

Path: https://gapi.roxlabs.cn/api/static_house_ip_list

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
ip string 是 IP段
remark integer 否 备注
region text 是 地区
status text 是 状态:未过期=>Not Expire,过期=>Expire
page text 是 1 页数
limit text 是 10 条数

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data object 非必须
├─ count number 非必须
├─ limit number 非必须
├─ list string [] 非必须

item 类型: string

├─ 非必须
├─ page number 非必须
timestamp number 非必须

流量相关

查询主账号流量

基本信息

Path: https://gapi.roxlabs.cn/api/get_main_flow

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

名称 类型 是否必须 默认值 备注 其他信息
非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data object 非必须
├─ uid number 非必须 账户id
├─ balance number 非必须 剩余流量,单位字节
├─ all_buy number 非必须 累计购买流量,单位字节
├─ use_flow number 非必须 已使用流量,单位字节
timestamp number 非必须

查询主账号流量明细-按天

基本信息

Path: https://gapi.roxlabs.cn/api/flow_use_record/day

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
start_time string 是 1670774400 开始时间
end_time integer 否 1671033600 结束时间

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data object [] 非必须

item 类型: object

├─ day string 必须 今天的时间戳
├─ global number 必须 今日使用的总流量,单位字节
├─ last_flow number 必须 剩余的流量
timestamp number 非必须

查询主账号流量明细-按小时

基本信息

Path: https://gapi.roxlabs.cn/api/flow_use_record/hours

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
start_time string 是 1670860800 开始时间
end_time integer 否 1670947200 结束时间

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data object [] 非必须

item 类型: object

├─ day string 必须 这个小时的时间戳
├─ global number 必须 这个小时使用的总流量,单位字节
├─ last_flow number 必须 剩余流量
timestamp number 非必须

查询认证账户流量

基本信息

Path: https://gapi.roxlabs.cn/api/get_child_flow

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id string 是 认证账户id
account string 是 认证账户名称

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data object 非必须
├─ id number 非必须 子账户id
├─ uid number 非必须 主账户id
├─ balance number 非必须 剩余流量,单位KB
├─ limit number 非必须 认证账户使用上限,单位G
├─ consumed_flow number 非必须 累计消耗流量,单位KB
timestamp number 非必须

获取剩余流量

基本信息

Path: https://gapi.roxlabs.cn/api/user_flow

Method: POST

请求参数

Query

参数名称 是否必须 示例 备注
appkey 是

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data number 非必须 剩余流量
timestamp number 非必须

其他

删除域名屏蔽

基本信息

Path: https://gapi.roxlabs.cn/api/prohibit_domain_del

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
id string 是 访问域名ID

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data string 非必须
timestamp number 非必须

添加域名屏蔽

基本信息

Path: https://gapi.roxlabs.cn/api/prohibit_domain_add

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
address string 是 www.baidu.com,www.ip.com 地址(多个用逗号隔开)

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data string 非必须
timestamp number 非必须

访问域名屏蔽列表

基本信息

Path: https://gapi.roxlabs.cn/api/prohibit_domain_list

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

名称 类型 是否必须 默认值 备注 其他信息
非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data object 非必须
├─ list string [] 非必须

item 类型: string

├─ 非必须
├─ num number 非必须
timestamp number 非必须

国家城市

查看国家下的州

基本信息

Path: https://api.roxlabs.cn/index/api/get_city_by_state

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Query

参数名称 是否必须 示例 备注
id 是 国家ID

Body

参数名称 参数类型 是否必须 示例 备注
id string 是 国家ID

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code string 非必须
msg string 非必须
ret_data object [] 非必须

item 类型: object

├─ state string 必须 州
timestamp number 非必须

查看国家列表

基本信息

Path: https://api.roxlabs.cn/index/api/get_dynamic_data_area

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code string 非必须
msg string 非必须
ret_data object [] 非必须

item 类型: object

├─ id number 必须
├─ country_name string 必须 国家名称
├─ country_code string 必须 国家代码
├─ available number 必须
├─ city object [] 必须

item 类型: object

├─ code string 必须
timestamp number 非必须

查看州下的城市

基本信息

Path: https://api.roxlabs.cn/index/api/get_city_by_region

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
country_code string 是 us 国家代码
region integer 否 florida 城市

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code string 非必须
msg string 非必须
ret_data object [] 非必须

item 类型: object

├─ code string 必须 城市
timestamp number 非必须

查看静态和数据中心可以开通的城市

基本信息

Path: https://api.roxlabs.cn/index/api/static_country

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code string 非必须
msg string 非必须
ret_data object [] 非必须

item 类型: object

├─ id number 必须
├─ region string 必须 地区
├─ name string 必须 地区中文
├─ status number 必须
├─ count number 必须 数量
timestamp number 非必须

订单相关

动态流量订单

基本信息

Path: https://gapi.roxlabs.cn/api/get_flow_list

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
order_id string 是 订单号
start_time integer 否 2022-12-01 开始时间
end_time text 是 2022-12-31 结束时间
limit text 是 10 每页条数
page text 是 1 页码
pay_status text 是 1 支付状态:0=未支付,1=已支付
p_type text 是 2 流量包类型:1=国内,2=国外

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data object 非必须
├─ all_buy number 非必须
├─ balance number 非必须
├─ count number 非必须
├─ flow_ip string 非必须
├─ flow_port string 非必须
├─ foreign_all_buy number 非必须
├─ foreign_balance number 非必须
├─ list object [] 非必须

item 类型: object

├─ recharge_id number 必须
├─ recharge_type number 必须
├─ uid number 必须
├─ order_id string 必须
├─ money number 必须
├─ client_type number 必须
├─ pay_type string 必须
├─ pay_status number 必须
├─ description string 必须
├─ exec_data string 必须
├─ created_at string 必须
├─ updated_at string 必须
├─ close_time string 必须
├─ pay_time number 必须
├─ back_coin number 必须
├─ coin number 必须
├─ back_expire_time number 必须
├─ mark string 必须
├─ creat_admin_id number 必须
├─ check_status string 必须
├─ check_admin_id number 必须
├─ old_balance number 必须
├─ new_balance number 必须
├─ sign_id number 必须
├─ sign_time number 必须
├─ status number 必须
├─ creat_admin string 必须
├─ check_admin string 必须
├─ have_in_account number 必须
├─ pay_account string 必须
├─ pay_sn string 必须
├─ give_orderid string 必须
├─ worn string 必须
├─ houzhui string 必须
├─ isnewyear number 必须
├─ apply_user string 必须
├─ oa_order_no string 必须
├─ sign_user string 必须
├─ is_give number 必须
├─ open_pack number 必须
├─ remark string 必须
├─ first_order number 必须
├─ origin string 必须
├─ jingjia_domain number 必须
├─ package_type number 必须
├─ is_distribution number 必须
├─ superior_user string 必须
├─ testing_count number 必须
├─ platform number 必须
├─ pak_id number 必须
├─ pak_type number 必须
├─ invoice string 必须
├─ discount_code string 必须
├─ coupon_id number 必须
├─ expired_time number 必须
timestamp number 非必须

独享数据中心订单

基本信息

Path: https://gapi.roxlabs.cn/api/static_order

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
order_id string 是 订单号
start_time integer 否 开始时间
end_time text 是 结束时间
page text 是 1 页码
limit text 是 10 每页条数

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data object 非必须
├─ count number 非必须
├─ limit number 非必须
├─ list string [] 非必须

item 类型: string

├─ 非必须
├─ page number 非必须
timestamp number 非必须

静态住宅订单

基本信息

Path: https://gapi.roxlabs.cn/api/static_house_order

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
order_id string 是 订单号
start_time integer 否 2022-12-01 开始时间
end_time text 是 2022-12-31 结束时间
limit text 是 10 每页条数
page text 是 1 页码

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data object 非必须
├─ count number 非必须
├─ limit number 非必须
├─ list string [] 非必须

item 类型: string

├─ 非必须
├─ page number 非必须
timestamp number 非必须

白名单相关

删除白名单

基本信息

Path: https://gapi.roxlabs.cn/api/del_white

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
white string 是 192.168.1.1,192.168.1.2 白名单,多个白名单使用英文,分割

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data string 非必须
timestamp number 非必须

查找白名单

基本信息

Path: https://gapi.roxlabs.cn/api/white_list

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

名称 类型 是否必须 默认值 备注 其他信息
非必须

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data object 非必须
├─ day_white_balance number 非必须 一天内可修改白名单的剩余次数
├─ day_white_limit number 非必须 修改一天内用户白名单总数
├─ lists object [] 非必须 ip列表

item 类型: object

├─ mark_ip string 必须
├─ updated_at number 必须
├─ mark object 非必须 注释
├─ day_white_balance string 非必须
├─ day_white_limit string 非必须
├─ lists string 非必须
├─ white string 非必须
├─ white number 非必须
timestamp number 非必须

添加白名单

基本信息

Path: https://gapi.roxlabs.cn/api/save_white

Method: POST

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/x-www-form-urlencoded 是

Body

参数名称 参数类型 是否必须 示例 备注
white string 是 192.168.1.1,192.168.1.2 白名单,多个白名单使用英文,分割

返回数据

名称 类型 是否必须 默认值 备注 其他信息
ret number 非必须
code number 非必须
msg string 非必须
ret_data object 非必须
├─ error number 非必须
├─ error_ip string [] 非必须 添加失败的ip列表

item 类型: string

├─ 非必须
├─ success number 非必须
├─ success_ip string [] 非必须 成功添加的ip列表

item 类型: string

├─ 非必须
timestamp number 非必须