ProxyLite OpenAPI

支持通过站点 OpenAPI 前缀管理个人账户、代理资源和团队账单。

认证方式以各操作的 security 定义为准：

  • apiKeyAuth：通过查询参数 app_key 传入个人或团队 API Key；后端也兼容 key、appkey、openid 参数及 POST 请求体传参。
  • bearerAuth：Authorization: Bearer <JWT>，用于网页登录令牌。请勿把 API Key 当作 JWT。
  • 团队 API Key 绑定固定团队；支持团队空间的接口可省略 team_id，显式传入必须与 Key 绑定团队一致。
  • 仅支持个人空间的接口会拒绝团队 API Key；团队操作仍遵循持有成员的资源权限。

JSON 响应包含 code、msg、data、request_id。code=200 表示业务成功；HTTP 200 也可能携带业务错误码。 msg 随请求语言变化，客户端应使用 code 判断结果。部分导出接口另支持文本、CSV 或 XML，详见操作定义。 金额、流量、日期和分页字段以各接口 Schema 为准。

基础 URL：

认证

  • HTTP 认证，方案：bearer
  • API Key（apiKeyAuth）
    • 参数名称： app_key, in: query. 个人或团队 API Key。推荐查询参数 app_key；也兼容 key/appkey/openid 及 POST 请求体。团队 Key 只能访问绑定团队的受支持接口。

代理账户管理

代理账户列表 (GET /end-point/whitelist-account/list)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/list

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse资源空间标识；个人空间省略或传空字符串；团队 Key 可省略，传入时必须与 Key 一致

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "username": "string",
        "password": "string",
        "created_at": "string",
        "remark": "string",
        "product_type": 9,
        "usage_flow": 0,
        "limit_flow": 102400,
        "status": 0
      }
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» coderesponseCodefalse无状态码,200 成功、3 app_key 无效
» msgstringfalse无状态消息
» dataobjectfalse无none
»» list[object]false无none
»»» idintegerfalse无账户编号
»»» usernamestringfalse无代理账户名
»»» passwordstringfalse无代理账户密码
»»» created_atstringfalse无添加时间
»»» remarkstringfalse无备注
»»» product_typeproductTypesfalse无套餐类型，9 动态住宅流量套餐、11 动态住宅IP、14静态数据中心IP、25 静态住宅IP
»»» usage_flowintegerfalse无已使用流量，单位：KB
»»» limit_flowintegerfalse无自定义流量上限：单位GB最大102400，0 不限制
»»» statusintegerfalse无启用状态：1启用，0停用

枚举值

属性值
product_type9
product_type11
product_type14
product_type25

检测代理账户可设置的流量限制

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/check

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string"
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» accountbodystringfalse编辑已有代理账户时传入账号名称

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "isAgent": 0,
    "trendMax": 0,
    "staticMax": 0,
    "maxLimit": 0,
    "minLimit": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

枚举值

属性值
isAgent0
isAgent1

获取动态代理子账号配额与已用数量

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/child-account \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/child-account

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse资源空间标识；个人空间省略或传空字符串

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "totalChildAccount": 0,
    "usedChildAccount": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

添加代理账户。 (POST /end-point/whitelist-account/add)

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01:pass,user02:pass,user03:pass",
  "remark": "",
  "product_type": 9
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_keybodystringfalse授权密钥
» accountsbodystringtrue账户密码，请按格式 username:password 填写，账户和密码仅支持数字和字母，禁止输入任何特殊符号或空格,冒号隔开账户和密码。支持批量添加，英文逗号（,）分隔代理账户。
» remarkbodystringfalse代理账户描述
» product_typebodyproductTypesfalse套餐类型，9 动态住宅流量套餐、11 动态住宅IP、14静态数据中心IP、25 静态住宅IP

枚举值

ParameterValue
» product_type9
» product_type11
» product_type14
» product_type25

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": null
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringfalse无状态消息
» datanullfalse无none

删除代理账户 (POST /end-point/whitelist-account/delete)

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/delete

请注意删除后无法恢复，已使用流量等无法查询。删除约有5分钟等待时间，在此期间仍可能产生费用。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_keybodystringfalse授权密钥
» accountsbodystringtrue代理账户，仅支持数字和字母。支持批量操作，英文逗号（,）分隔代理账户

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": null
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringfalse无状态消息
» datanullfalse无none

禁用代理账户 (POST /end-point/whitelist-account/disable)

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/disable

禁用约有5分钟等待时间，在此期间仍可能产生费用。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_keybodystringfalse授权密钥
» accountsbodystringtrue代理账户，仅支持数字和字母。支持批量操作，英文逗号（,）分隔代理账户

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": null
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringfalse无状态消息
» datanullfalse无none

启用代理账户 (POST /end-point/whitelist-account/enable)

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/enable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_keybodystringfalse授权密钥
» accountsbodystringtrue代理账户，仅支持数字和字母。支持批量操作，英文逗号（,）分隔代理账户

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": null
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringfalse无状态消息
» datanullfalse无none

修改代理账户密码

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-password \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-password

请注意修改后有5分钟等待时间，在此期间旧密码仍可能正常使用。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "account": "user",
  "password": "pass"
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_keybodystringfalse授权密钥
» accountbodystringtrue代理账户，仅支持数字和字母。
» passwordbodystringtrue代理账户新密码，仅支持数字和字母。

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": null
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringfalse无状态消息
» datanullfalse无none

修改代理账户备注

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "account": "user",
  "remark": ""
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_keybodystringfalse授权密钥
» accountbodystringtrue代理账户，仅支持数字和字母。
» remarkbodystringtrue代理账户新备注，32个中文或64个英文以内。

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": null
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringfalse无状态消息
» datanullfalse无none

修改代理账户流量上限

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-limit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-limit

请注意流量统计可能有5分钟以内延迟，即实际消耗流量可能超过此限制。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "account": "user",
  "limit": 0
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_keybodystringfalse授权密钥
» accountbodystringtrue代理账户，仅支持数字和字母。
» limitbodyintegerfalse流量限制，单位：GB，0为不设上限

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": null
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringfalse无状态消息
» datanullfalse无none

快速创建代理账户

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/quick-add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/quick-add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 0
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» product_typebodyintegertrue无

响应示例

200 响应

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "username": "string",
    "password": "string"
  }
}

响应

状态码含义描述数据模型
200OK业务成功时返回新账户和密码Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无none
» msgstringfalse无none
» request_idstringfalse无none
» dataanyfalse无none

oneOf

名称类型必填约束描述
»» anonymousobjectfalse无none
»»» usernamestringtrue无none
»»» passwordstringtrue无none

xor

名称类型必填约束描述
»» anonymousnullfalse无none

修改代理账户每日流量上限

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change-daily-limit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change-daily-limit

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string",
  "daily_limit": 0
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» accountbodystringtrue无
» daily_limitbodyintegerfalse单位 GB

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

修改代理账户信息 (POST /end-point/whitelist-account/change)

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/change

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "account": "string",
  "password": "string",
  "remark": "string",
  "limit": 0,
  "daily_limit": 0,
  "status": 0,
  "udp": 0
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» accountbodystringtrue无
» passwordbodystringfalse无
» remarkbodystringfalse无
» limitbodyintegerfalse总流量上限，单位 GB
» daily_limitbodyintegerfalse每日流量上限，单位 GB
» statusbodyintegerfalse无
» udpbodyintegerfalse无

枚举值

ParameterValue
» status0
» status1
» udp0
» udp1

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

刷新当前资源空间的代理账户认证缓存

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/whitelist-account/refresh \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/whitelist-account/refresh

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

指定产品类型的代理账户配额

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/quota?product_type=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/quota

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
product_typequeryintegertrue无

响应示例

200 响应

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "usage": 0,
    "limit": 0,
    "expand": 0
  }
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无none
» msgstringfalse无none
» request_idstringfalse无none
» dataobjectfalse无none
»» usageintegertrue无none
»» limitintegertrue无none
»» expandintegertrue无none

所有产品类型的代理账户配额

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/quotas \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/quotas

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无

响应示例

200 响应

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "product_type": 0,
        "limit": 0,
        "usage": 0
      }
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无none
» msgstringfalse无none
» request_idstringfalse无none
» dataobjectfalse无none
»» list[object]false无none
»»» product_typeintegerfalse无none
»»» limitintegerfalse无none
»»» usageintegerfalse无none

代理账户列表 (GET /end-point/proxy-account/list)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/proxy-account/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/proxy-account/list

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse资源空间标识；个人空间省略或传空字符串；团队 Key 可省略，传入时必须与 Key 一致

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "username": "string",
        "password": "string",
        "created_at": "string",
        "remark": "string",
        "product_type": 9,
        "usage_flow": 0,
        "limit_flow": 102400,
        "status": 0
      }
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» coderesponseCodefalse无状态码,200 成功、3 app_key 无效
» msgstringfalse无状态消息
» dataobjectfalse无none
»» list[object]false无none
»»» idintegerfalse无账户编号
»»» usernamestringfalse无代理账户名
»»» passwordstringfalse无代理账户密码
»»» created_atstringfalse无添加时间
»»» remarkstringfalse无备注
»»» product_typeproductTypesfalse无套餐类型，9 动态住宅流量套餐、11 动态住宅IP、14静态数据中心IP、25 静态住宅IP
»»» usage_flowintegerfalse无已使用流量，单位：KB
»»» limit_flowintegerfalse无自定义流量上限：单位GB最大102400，0 不限制
»»» statusintegerfalse无启用状态：1启用，0停用

枚举值

属性值
product_type9
product_type11
product_type14
product_type25

添加代理账户。 (POST /end-point/proxy-account/add)

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01:pass,user02:pass,user03:pass",
  "remark": "",
  "product_type": 9
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_keybodystringfalse授权密钥
» accountsbodystringtrue账户密码，请按格式 username:password 填写，账户和密码仅支持数字和字母，禁止输入任何特殊符号或空格,冒号隔开账户和密码。支持批量添加，英文逗号（,）分隔代理账户。
» remarkbodystringfalse代理账户描述
» product_typebodyproductTypesfalse套餐类型，9 动态住宅流量套餐、11 动态住宅IP、14静态数据中心IP、25 静态住宅IP

枚举值

ParameterValue
» product_type9
» product_type11
» product_type14
» product_type25

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": null
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringfalse无状态消息
» datanullfalse无none

删除代理账户 (POST /end-point/proxy-account/delete)

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/delete

请注意删除后无法恢复，已使用流量等无法查询。删除约有5分钟等待时间，在此期间仍可能产生费用。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_keybodystringfalse授权密钥
» accountsbodystringtrue代理账户，仅支持数字和字母。支持批量操作，英文逗号（,）分隔代理账户

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": null
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringfalse无状态消息
» datanullfalse无none

启用代理账户 (POST /end-point/proxy-account/enable)

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/enable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_keybodystringfalse授权密钥
» accountsbodystringtrue代理账户，仅支持数字和字母。支持批量操作，英文逗号（,）分隔代理账户

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": null
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringfalse无状态消息
» datanullfalse无none

禁用代理账户 (POST /end-point/proxy-account/disable)

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/disable

禁用约有5分钟等待时间，在此期间仍可能产生费用。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_keybodystringfalse授权密钥
» accountsbodystringtrue代理账户，仅支持数字和字母。支持批量操作，英文逗号（,）分隔代理账户

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": null
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringfalse无状态消息
» datanullfalse无none

修改代理账户信息 (POST /end-point/proxy-account/change)

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/proxy-account/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-account/change

修改代理账户密码、备注、流量限制、每日流量限制、启用状态或 UDP 开关。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "account": "string",
  "password": "string",
  "remark": "string",
  "limit": 0,
  "daily_limit": 0,
  "status": 0,
  "udp": 0
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_keybodystringfalse授权密钥
» accountbodystringtrue代理账户名
» passwordbodystringfalse新密码，6-16 位数字或字母；不传则不修改
» remarkbodystringfalse新备注
» limitbodyintegerfalse流量上限，单位 GB，0 表示不限制
» daily_limitbodyintegerfalse每日流量上限，单位 GB，0 表示不限制
» statusbodyintegerfalse启用状态
» udpbodyintegerfalseUDP 支持开关，仅对套餐类型 14、16、21、25 生效

枚举值

ParameterValue
» status0
» status1
» udp0
» udp1

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": null
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功
» msgstringfalse无状态消息
» datanullfalse无none

生成代理连接信息

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/whitelist-account/format?ac=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/whitelist-account/format

支持个人和团队 API Key。仅返回当前资源空间内有权访问的代理账号，支持套餐类型 9、11、12。JSON/XML 返回结构化账密列表；txt/csv 返回按 f 格式拼接的连接串。

参数

名称位置类型必填描述
acqueryinteger,stringtrue代理账号 ID 或用户名；兼容参数 account
aequerystringfalse无
stquerystringfalse无
ctquerystringfalse无
lfqueryintegerfalse无
nqueryintegerfalse无
fqueryintegerfalse仅影响 txt/csv 的连接串格式
typequerystringfalse无
lbquerystringfalse无
epquerystringfalse无
team_idqueryResourceSpaceIdfalse无

枚举值

ParameterValue
f1
f2
f3
f4
f5
typejson
typexml
typetxt
typecsv

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "password": "string",
        "server": "string",
        "port": 0
      }
    ]
  },
  "request_id": "string"
}

"string"

<?xml version="1.0" encoding="UTF-8" ?>
<WebV1SuccessResponse>
  <code>200</code>
  <msg>SUCCESS</msg>
  <data/>
  <request_id>string</request_id>
</WebV1SuccessResponse>

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。WebV1SuccessResponse

订单管理

订单创建、查询、取消等

订单列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/order/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/order/list

团队空间订单额外返回 creator，表示实际下单成员；管理员和超级管理员可见完整联系方式，其他角色返回脱敏联系方式。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse订单资源空间标识；个人空间省略或传空字符串
page_noqueryintegerfalse无
page_sizequeryintegerfalse无
trade_noquerystringfalse订单编号
start_timequerystring(date-time)false开始时间（包含），如 2024-01-01 00:00:00
end_timequerystring(date-time)false结束时间（不包含）
statusqueryintegerfalse订单状态
product_typequeryintegerfalse产品类型
invoicequeryintegerfalse发票状态：0不限制 1已开发票 -1未开发票（可补开）
pay_fee_statusqueryintegerfalse长短款筛选：1超额支付 2短款支付

Detailed descriptions

status: 订单状态

状态描述
0待支付
1已支付
2超时未支付已取消
3已退款

product_type: 产品类型

产品类型描述
3余额充值
9动态流量套餐
11动态全球包时套餐V2
12长效IDC流量套餐
13住宅静态IP流量套餐
14数据中心静态IP套餐
15长效ISP流量套餐
16静态流量套餐
17动态IP数量套餐
18web-scraper
19静态IP续费
20静态IP更换配额
21静态流量套餐v2
24静态流量附加包套餐
25住宅静态IP套餐
26补单 - 部分支付渠道需要用户手动填写金额，如：虚拟币，若发生短款，需要联系客服通过此种产品进行补支付
27Serp
28Video

枚举值

ParameterValue
status0
status1
status2
status3
product_type3
product_type9
product_type11
product_type12
product_type14
product_type16
product_type17
product_type18
product_type19
product_type21
product_type24
product_type25
product_type26
product_type27
product_type28
invoice-1
invoice0
invoice1
pay_fee_status1
pay_fee_status2

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "trade_no": "string",
        "out_trade_no": "string",
        "product_id": 0,
        "product_type": 0,
        "amount": 0,
        "unit_price": 0.1,
        "total_fee": 0.1,
        "goods_fee": 0.1,
        "pay_fee": 0.1,
        "discount_fee": 0.1,
        "handling_fee": 0.1,
        "refund_fee": 0.1,
        "pm_id": 0,
        "pm_title": "string",
        "pm_logo": "string",
        "status": 0,
        "title": "string",
        "detail": "string",
        "region_desc": "string",
        "pay_at": "2019-08-24T14:15:22Z",
        "pay_timestamp": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "pay_fee_status": 0,
        "invoice": {
          "name": "string",
          "org_name": "string",
          "first_name": "string",
          "last_name": "string",
          "phone": "string",
          "email": "[email protected]",
          "role_type": 0,
          "vat_id": "string",
          "address_country": "string",
          "address_city": "string",
          "address_line1": "string",
          "address_line2": "string",
          "address_postal_code": "string"
        }
      }
    ],
    "pagination": {
      "total": 0,
      "page_no": 0,
      "page_size": 0,
      "total_pages": 0
    }
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK成功Inline

响应结构

创建订单

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/order/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/create

因套餐种类较多，且每种套餐存在不同的配置，请根据实际情况填写参数。不正当填写参数可能导致订单创建失败。

examples:

续费静态IP

{
    "pid": 套餐ID, // 从 /openapi/product 接口获取
    "upids": "1,2,3,4,5,6", // 从 /openapi/ip/get-static-ip 接口获取对应的 id 字段
    "pm_id": 1 // 从 /openapi/payment/list 或 /openapi/payment/groups 接口获取
  }

静态住宅IP购买

{
  "pid": 套餐ID, // 从 /openapi/product 接口获取
  "pm_id": 支付方式ID, // 从 /openapi/payment/list 或 /openapi/payment/groups 接口获取
  "region_list": "JP,15,333|DE,10,444|US,5,555" // 格式：地区,数量,ASN|地区,数量,ASN（ASN编号可选）
}

静态数据中心IP购买

{
  "pid": 套餐ID, // 从 /openapi/product 接口获取
  "pm_id": 支付方式ID, // 从 /openapi/payment/list 或 /openapi/payment/groups 接口获取
  "region_list": "JP,15,333|DE,10,444|US,5,555" // 格式：地区,数量,ASN|地区,数量,ASN（ASN编号可选）
}

动态住宅流量购买

{
  "pid": 套餐ID, // 从 /openapi/product 接口获取
  "pm_id": 支付方式ID // 从 /openapi/payment/list 或 /openapi/payment/groups 接口获取
}

静态轮换流量购买

{
  "pid": 套餐ID, // 从 /openapi/product 接口获取
  "pm_id": 支付方式ID // 从 /openapi/payment/list 或 /openapi/payment/groups 接口获取
}

动态无限流量购买

{
  "pid": 套餐ID, // 从 /openapi/product 接口获取
  "pm_id": 支付方式ID, // 从 /openapi/payment/list 或 /openapi/payment/groups 接口获取
  "product_sku_bandwidth_id": 带宽规格ID,
  "product_sku_concurrency_id": 并发规格ID
}

余额充值

{
  "pid": 套餐ID, // 从 /openapi/product 接口获取
  "pm_id": 支付方式ID, // 从 /openapi/payment/list 或 /openapi/payment/groups 接口获取
  "recharge_amount": 充值金额
}

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "pid": 0,
  "upids": "string",
  "amount": 0,
  "pm_id": 0,
  "region_list": "string",
  "coupon_sn": "string",
  "use_invitation_registration_discount": true,
  "renew_duration": 0,
  "product_sku_bandwidth_id": 0,
  "product_sku_concurrency_id": 0,
  "product_sku_duration_id": 0,
  "etd": 1,
  "recharge_amount": 0
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» pidbodyintegertrue套餐ID，来自 /openapi/product 接口返回的 id 字段
» upidsbodystringfalse续费套餐ID列表（逗号分隔），来自 /openapi/user-product/list 或 /openapi/ip/get-static-ip 接口返回的 id 字段
» amountbodynumberfalse新购套餐数量
» pm_idbodyintegertrue支付方式ID，来自 /openapi/payment/list 或 /openapi/payment/groups 接口返回的 id 字段
» region_listbodystringfalse购买静态IP时指定区域+数量+ASN编号，格式：地区,数量,ASN
» coupon_snbodystringfalse优惠券编号
» use_invitation_registration_discountbodybooleanfalse是否使用邀请注册优惠
» renew_durationbodyintegerfalse续费时长-静态IP可选
» product_sku_bandwidth_idbodyintegerfalse套餐11：带宽套餐ID
» product_sku_concurrency_idbodyintegerfalse套餐11：并发套餐ID
» product_sku_duration_idbodyintegerfalse套餐type=11必填：时长规格ID
» etdbodyintegerfalse时长倍数，从套餐 extension_of_time_days 获取，2代表天数×2，价格上浮
» recharge_amountbodyintegerfalse套餐3：充值金额

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK创建成功Inline

响应结构

取消订单

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/order/close \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/close

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no": "string"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» trade_nobodystringtrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

订单详情

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/order/info?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/order/info

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
trade_noquerystringtrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

订单详情 V2

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/order/info-v2?order_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/order/info-v2

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
order_idquerystringtrue客户端加密后的订单 ID

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "[email protected]",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；订单已支付或已取消时可能以业务错误 code 携带订单数据Inline

响应结构

历史订单补开发票

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/order/reissue-invoice \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/reissue-invoice

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no_list": [
    "string"
  ]
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» trade_no_listbody[string]true无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

订单预检

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/order/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/order/check

创建订单前调用，用于预览价格、折扣、IP续费明细等，不会实际创建订单。 参数与 /openapi/order/create 完全一致。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "pid": 0,
  "upids": "string",
  "amount": 1,
  "pm_id": 0,
  "region_list": "string",
  "coupon_sn": "string",
  "renew_duration": "1m",
  "product_sku_bandwidth_id": 0,
  "product_sku_concurrency_id": 0,
  "product_sku_duration_id": 0,
  "etd": 1,
  "recharge_amount": 0
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» pidbodyintegertrue套餐ID
» upidsbodystringfalseIP续费：用户套餐ID列表，逗号分隔
» amountbodyintegerfalse购买数量
» pm_idbodyintegertrue支付方式ID
» region_listbodystringfalse静态IP购买地区+数量，格式：地区ID,数量
» coupon_snbodystringfalse优惠券编号
» renew_durationbodystringfalseIP续费时长：1m=1个月，2m=2个月，em=下个月月底
» product_sku_bandwidth_idbodyintegerfalse套餐type=11必填：带宽规格ID
» product_sku_concurrency_idbodyintegerfalse套餐type=11必填：并发规格ID
» product_sku_duration_idbodyintegerfalse套餐type=11必填：时长规格ID
» etdbodyintegerfalse时长倍数，从套餐 extension_of_time_days 获取
» recharge_amountbodynumberfalse套餐type=3必填：充值金额

枚举值

ParameterValue
» renew_duration1m
» renew_duration2m
» renew_durationem

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "product_id": 0,
    "amount": 0,
    "discount_fee": 0.1,
    "total_fee": 0.1,
    "pay_fee": 0.1,
    "product_type": 0,
    "title": "string",
    "detail": "string",
    "ip_result": [
      {
        "ip": "string",
        "price": 0.1,
        "country_code": "string",
        "current_time": "2019-08-24T14:15:22Z",
        "renewal_time": "2019-08-24T14:15:22Z",
        "country": {
          "name_zh_cn": "string",
          "flag": "string",
          "square_flag": "string"
        }
      }
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK预检成功Inline

响应结构

API Key 管理

个人和团队资源空间的 API Key 管理

API Key 列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/api-keys \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/api-keys

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse资源空间标识；个人空间省略或传空字符串
pagequeryintegerfalse无
pageSizequeryintegerfalse无

响应示例

200 响应

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "id": 1,
        "api_key": "string",
        "team_user_id": 0,
        "remark": "string",
        "status": 0,
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "pageSize": 1
  }
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegertrue无none
» msgstringtrue无none
» request_idstringtrue无none
» dataobjecttrue无none
»» list[UserApiKeyMetadata]true无none
»»» idintegertrue无API Key ID
»»» api_keystringtrue无创建响应为完整 Key；团队列表中为脱敏值
»»» team_user_idintegertrue无团队 Key 实际持有成员 ID，个人 Key 为 0
»»» remarkstringtrue无备注
»»» statusintegertrue无0=停用，1=启用
»»» created_atstringtrue无创建时间
»»» updated_atstring,nullfalse无更新时间
»» totalintegertrue无none
»» pageintegertrue无none
»» pageSizeintegertrue无none

枚举值

属性值
status0
status1

创建 API Key

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/api-keys/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/create

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "remark": "string"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» remarkbodystringfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "api_key": "string",
    "team_user_id": 0,
    "remark": "string",
    "status": 0,
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK业务成功时返回完整 API Key，仅此一次Inline

响应结构

枚举值

属性值
status0
status1

启用 API Key

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/api-keys/enable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/enable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» idbodyintegertrueAPI Key ID

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

停用 API Key

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/api-keys/disable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/disable

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» idbodyintegertrueAPI Key ID

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

删除 API Key

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/api-keys/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» idbodyintegertrueAPI Key ID

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

修改 API Key 备注

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/api-keys/update-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/api-keys/update-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "remark": "string"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» idbodyintegertrue无
» remarkbodystringtrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

月度续费账单

月度汇总续费的实时账单、预检、下单和历史记录

当前月度汇总续费账单

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/monthly-renewal-bill \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/monthly-renewal-bill

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "batch": {
      "type": "current",
      "start_at": "string",
      "end_at": "string",
      "target_expired_at": "string",
      "timezone": "string"
    },
    "currency": "string",
    "total_fee": 0,
    "items": [
      {
        "id": 0,
        "user_product_id": 1,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "title": "string",
        "expired_at": "string",
        "target_expired_at": "string",
        "renew_days": 1,
        "unit_month_price": 0,
        "pay_fee": 0,
        "currency": "string",
        "bandwidth": 0,
        "bandwidth_mbsp": 0,
        "concurrency": 0,
        "ip": "string",
        "country_code": "string",
        "paid_at": "string",
        "refunded_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

枚举值

属性值
typecurrent
typenext

检查月度汇总续费订单

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/monthly-renewal-bill/check \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/monthly-renewal-bill/check

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

参数

名称位置类型必填描述
bodybodyMonthlyRenewalRequesttrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "batch": {
      "type": "current",
      "start_at": "string",
      "end_at": "string",
      "target_expired_at": "string",
      "timezone": "string"
    },
    "currency": "string",
    "total_fee": 0,
    "discount_fee": 0,
    "pay_fee": 0,
    "items": [
      {
        "id": 0,
        "user_product_id": 1,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "title": "string",
        "expired_at": "string",
        "target_expired_at": "string",
        "renew_days": 1,
        "unit_month_price": 0,
        "pay_fee": 0,
        "currency": "string",
        "bandwidth": 0,
        "bandwidth_mbsp": 0,
        "concurrency": 0,
        "ip": "string",
        "country_code": "string",
        "paid_at": "string",
        "refunded_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "user_coupon_id": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

枚举值

属性值
typecurrent
typenext

创建月度汇总续费订单

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/monthly-renewal-bill/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/monthly-renewal-bill/create

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

参数

名称位置类型必填描述
bodybodyMonthlyRenewalRequesttrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "trade_no": "string",
    "total_fee": 0,
    "discount_fee": 0,
    "pay_fee": 0,
    "currency": "string",
    "user_coupon_id": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

月度汇总续费历史账单

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/monthly-renewal-bill/history \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/monthly-renewal-bill/history

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
trade_noquerystringfalse无
start_datequerystring(date)false无
end_datequerystring(date)false无
pagequeryintegerfalse无
sizequeryintegerfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "total": 0,
    "page": 1,
    "size": 1,
    "list": [
      {
        "id": 1,
        "trade_no": "string",
        "status": 0,
        "pay_fee": 0,
        "currency": "string",
        "pay_at": "string",
        "created_at": "string",
        "pay_method": 0,
        "pm_id": 0,
        "pay_channel": 0,
        "pm_title": "string",
        "pm_logo": "string",
        "items": [
          {
            "id": 0,
            "user_product_id": 1,
            "product_id": 1,
            "product_type": 0,
            "parent_product_type": 0,
            "title": "string",
            "expired_at": "string",
            "target_expired_at": "string",
            "renew_days": 1,
            "unit_month_price": 0,
            "pay_fee": 0,
            "currency": "string",
            "bandwidth": 0,
            "bandwidth_mbsp": 0,
            "concurrency": 0,
            "ip": "string",
            "country_code": "string",
            "paid_at": "string",
            "refunded_at": "string",
            "created_at": "string",
            "updated_at": "string"
          }
        ]
      }
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

发票管理

发票抬头、开票申请和可开票订单

发票抬头详情

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/info

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
invoice_codequerystringfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoice_code": "string",
    "name": "string",
    "org_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "email": "[email protected]",
    "role_type": 1,
    "invoice_type": 0,
    "vat_id": "string",
    "tax_no": "string",
    "address_country": "string",
    "address_city": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string",
    "bank_name": "string",
    "bank_account": "string",
    "is_def": true
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

枚举值

属性值
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

创建或修改发票抬头

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/create

Body parameter

{
  "invoice_code": "string",
  "name": "string",
  "org_name": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "email": "[email protected]",
  "role_type": 1,
  "invoice_type": 0,
  "vat_id": "string",
  "tax_no": "string",
  "address_country": "string",
  "address_city": "string",
  "address_line1": "string",
  "address_line2": "string",
  "address_postal_code": "string",
  "bank_name": "string",
  "bank_account": "string",
  "is_def": true,
  "team_id": "A1b2C3d4E5f6",
  "new_invoice_code": false
}

参数

名称位置类型必填描述
bodybodyanytrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功，data 为 nullInline

响应结构

发票抬头列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/list

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "invoice_code": "string",
        "name": "string",
        "org_name": "string",
        "first_name": "string",
        "last_name": "string",
        "phone": "string",
        "email": "[email protected]",
        "role_type": 1,
        "invoice_type": 0,
        "vat_id": "string",
        "tax_no": "string",
        "address_country": "string",
        "address_city": "string",
        "address_line1": "string",
        "address_line2": "string",
        "address_postal_code": "string",
        "bank_name": "string",
        "bank_account": "string",
        "is_def": true,
        "created_at": 0
      }
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

枚举值

属性值
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

删除发票抬头

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_code": "string"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» invoice_codebodystringtrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功，data 为 nullInline

响应结构

开票记录列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/record-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/record-list

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
statusqueryintegerfalse无

枚举值

ParameterValue
status0
status1
status2
status3
status4

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "invoice_no": "string",
        "invoice_amount": 0,
        "invoice_download_url": "string",
        "status": 0,
        "remark": "string",
        "order_ids": [
          0
        ],
        "created_at": 0,
        "invoice_info": {
          "invoice_code": "string",
          "name": "string",
          "org_name": "string",
          "role_type": 1,
          "invoice_type": 0
        }
      }
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

枚举值

属性值
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

提交开票申请

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/submit \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/submit

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_code": "string",
  "order_ids": [
    0
  ]
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» invoice_codebodystringtrue无
» order_idsbody[integer]true无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoice_id": 1
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

取消开票申请

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-invoice/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-invoice/cancel

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invoice_id": 1,
  "reason": "string"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» invoice_idbodyintegertrue无
» reasonbodystringfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功，data 为 nullInline

响应结构

开票金额统计

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/statistics \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/statistics

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoiceable_amount": 0,
    "invoiced_amount": 0,
    "processing_amount": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

可开票订单列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-invoice/invoiceable-orders \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-invoice/invoiceable-orders

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "order_no": "string",
        "pay_fee": 0,
        "created_at": 0
      }
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

团队管理

团队创建、查询、改名和解散

创建团队

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/team/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/create

Body parameter

{
  "name": "string"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» namebodystringtrue团队名称

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

枚举值

属性值
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

当前用户可访问的团队列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/team/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/list

参数

名称位置类型必填描述
pagequeryintegerfalse无
page_sizequeryintegerfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": "A1b2C3d4E5f6",
        "name": "string",
        "super_admin_user_id": 1,
        "status": 0,
        "current_role": 1,
        "dissolving_at": "string",
        "dissolved_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

枚举值

属性值
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

团队详情

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/team/detail?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/detail

参数

名称位置类型必填描述
team_idqueryTeamPublicIdtrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

枚举值

属性值
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

修改团队名称

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/team/update-name \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/update-name

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "name": "string"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyTeamPublicIdtrue团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» namebodystringtrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

枚举值

属性值
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

解散团队

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/team/dissolve \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/dissolve

仅团队超级管理员可调用。请求中的 name 必须与团队当前名称完全一致。 该接口强制执行操作二次验证：未处于 15 分钟信任状态时返回 code=348， 调用方应根据响应 data 中的可用方式取得验证码后，携带 verify_type 和 verify_code 重试。 可重复调用以继续未完成的解散流程。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "name": "华东研发团队",
  "verify_type": "email",
  "verify_code": "123456"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyTeamPublicIdtrue团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» namebodystringtrue团队名称确认，必须与团队当前名称完全一致
» verify_typebodystringfalse二次验证方式；需要验证时与 verify_code 一起提交
» verify_codebodystringfalse二次验证码；处于 15 分钟信任状态时可不传

枚举值

ParameterValue
» verify_typephone
» verify_typeemail
» verify_typewechat
» verify_typetotp

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

枚举值

属性值
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

查询团队解散状态

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/team/dissolve-status?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/dissolve-status

参数

名称位置类型必填描述
team_idqueryTeamPublicIdtrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

枚举值

属性值
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

团队成员

团队成员列表、角色调整、移除和退出

团队成员列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/team/members?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/members

参数

名称位置类型必填描述
team_idqueryTeamPublicIdtrue无
pagequeryintegerfalse无
page_sizequeryintegerfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "team_member_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 1,
        "role": 1,
        "status": 0,
        "joined_at": "string",
        "nickname": "string",
        "username": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

枚举值

属性值
role1
role2
role3
role4
status0
status1
status2
status3

团队人员统一列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/team/people?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/people

返回有效成员；超级管理员和管理员还会看到待处理邀请。其他邀请状态仅保留在邀请历史列表中。

参数

名称位置类型必填描述
team_idqueryTeamPublicIdtrue无
pagequeryintegerfalse无
page_sizequeryintegerfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "record_type": "member",
        "record_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 0,
        "inviter_user_id": 0,
        "invite_type": 0,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 0,
        "role": 1,
        "status": 0,
        "display_name": "string",
        "nickname": "string",
        "username": "string",
        "email": "string",
        "phone": "string",
        "joined_at": "string",
        "expired_at": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

枚举值

属性值
record_typemember
record_typeinvitation
invite_type0
invite_type1
invite_type2
invite_type3
delivery_type0
delivery_type1
delivery_type2
delivery_type3
role1
role2
role3
role4
status0
status1

调整成员角色

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/team/members/update-role \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/members/update-role

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "team_member_id": 1,
  "role": 2
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyTeamPublicIdtrue团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» team_member_idbodyintegertrue无
» rolebodyintegertrue无

枚举值

ParameterValue
» role2
» role3

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

枚举值

属性值
role1
role2
role3
role4
status0
status1
status2
status3

移除团队成员

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/team/members/remove \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/members/remove

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "team_member_id": 1
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyTeamPublicIdtrue团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» team_member_idbodyintegertrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data.status=3Inline

响应结构

枚举值

属性值
role1
role2
role3
role4
status0
status1
status2
status3

退出团队

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/team/members/leave \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/members/leave

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyTeamPublicIdtrue团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data.status=2Inline

响应结构

枚举值

属性值
role1
role2
role3
role4
status0
status1
status2
status3

团队邀请

团队成员邀请的创建、查询和处理

创建团队邀请

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/create

按已注册用户、邮箱或手机号创建邀请。邮箱或手机号匹配到本站用户时，响应会规范化为 invite_type=1。 前端可提交本站邀请 URL 相对路径模板，服务端仅将其中的 替换为一次性邀请令牌。 未注册目标使用受邀手机号注册，或使用受邀邮箱完成验证后，服务端会将仍有效的邀请绑定到新用户、轮换 token，并只补发一条未读站内信；原邮件或短信中的旧 token 随即失效。若邮箱邀请尚未完成自动绑定，使用受邀邮箱注册的当前账号可直接接受，无需等待 email_verify。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invite_type": 1,
  "role": 2,
  "user_id": 1,
  "email": "[email protected]",
  "country_code": 1,
  "phone": "string",
  "invitation_url_template": "/team/invitation/{{token}}"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyTeamPublicIdtrue团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» invite_typebodyintegertrue1=已注册用户，2=邮箱，3=手机号
» rolebodyintegertrue2=管理员，3=普通成员
» user_idbodyintegerfalseinvite_type=1 时必填
» emailbodystring(email)falseinvite_type=2 时必填
» country_codebodyintegerfalseinvite_type=3 时必填
» phonebodystringfalseinvite_type=3 时必填
» invitation_url_templatebodystringfalse本站前端定义的相对路径模板；必须以单个 / 开头、不得包含域名或换行，且必须且只能包含一个 占位符
» anonymousbodyobjectfalse无
»» invite_typebodyanyfalse无
» anonymousbodyobjectfalse无
»» invite_typebodyanyfalse无
» anonymousbodyobjectfalse无
»» invite_typebodyanyfalse无

枚举值

ParameterValue
» invite_type1
» invite_type2
» invite_type3
» role2
» role3

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 code，200 为业务成功Inline

响应结构

枚举值

属性值
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4
emailqueued
emailfailed
emailskipped
smsqueued
smsfailed
smsskipped
site_inner_messagecreated
site_inner_messageexists
site_inner_messagefailed

团队邀请列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/team/invitations?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/invitations

仅团队超级管理员或管理员可访问；返回前会将已到期的待处理邀请更新为已过期。

参数

名称位置类型必填描述
team_idqueryTeamPublicIdtrue团队公开标识
pagequeryintegerfalse页码，从 1 开始
page_sizequeryintegerfalse每页数量

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "inviter_user_id": 1,
        "invitee_user_id": 0,
        "invite_type": 1,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 1,
        "role": 2,
        "status": 0,
        "accepted_by_user_id": 0,
        "expired_at": "2026-07-17 10:00:00",
        "accepted_at": null,
        "rejected_at": null,
        "cancelled_at": null,
        "created_at": "2026-07-10 10:00:00"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

枚举值

属性值
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4

预览团队邀请

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/team/invitations/preview?invitation_token=string \
  -H 'Accept: application/json'

GET /end-point/team/invitations/preview

使用一次性 invitation_token 匿名预览邀请；链接中不使用邀请数字 ID。

参数

名称位置类型必填描述
invitation_tokenquerystringtrue邀请链接携带的非空明文一次性令牌

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_name": "string",
    "role": 2,
    "status": 0,
    "expired_at": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

枚举值

属性值
role2
role3
status0
status1
status2
status3
status4

重发团队邀请通知

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/resend \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/resend

重投原始发送渠道；已注册用户同时发送站内信。重发会轮换令牌，之前的所有邀请链接立即失效。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invitation_id": 1
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyTeamPublicIdtrue团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» invitation_idbodyintegertrue邀请 ID

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

枚举值

属性值
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4
emailqueued
emailfailed
emailskipped
smsqueued
smsfailed
smsskipped
site_inner_messagecreated
site_inner_messageexists
site_inner_messagefailed

接受团队邀请

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/accept \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/accept

当前登录用户使用一次性 invitation_token 接受邀请，必须与邀请目标匹配且属于邀请所属站点；不需要传 team_id。

Body parameter

{
  "invitation_token": "string"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» invitation_tokenbodystringtrue明文一次性邀请令牌

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 为成员对象Inline

响应结构

枚举值

属性值
role1
role2
role3
role4
status0
status1
status2
status3

拒绝团队邀请

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/reject \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/reject

当前登录用户使用一次性 invitation_token 拒绝与本人匹配的邀请；不需要传 team_id。

Body parameter

{
  "invitation_token": "string"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» invitation_tokenbodystringtrue明文一次性邀请令牌

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data.status=2Inline

响应结构

枚举值

属性值
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4

取消团队邀请

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/team/invitations/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/invitations/cancel

取消指定团队内的待处理邀请，操作人必须有权邀请该目标角色。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "invitation_id": 1
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyTeamPublicIdtrue团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» invitation_idbodyintegertrue邀请 ID

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data.status=3Inline

响应结构

枚举值

属性值
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4

团队资产

团队资产查询和个人/团队空间划转

团队套餐信息

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/team/product-info?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/product-info

返回指定团队资源空间的套餐摘要，字段与 /web_v1/user/info 的套餐字段保持一致， 不返回团队超级管理员的个人资料、余额或内部数字团队 ID。积分套餐详细信息请使用 /web_v1/credit/info。

参数

名称位置类型必填描述
team_idqueryTeamPublicIdtrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "product_types": [
      0
    ],
    "product_residence_remain_count": 0,
    "product_residence_total_count": 0,
    "pdrue2_timestamp": 0,
    "remain": 0,
    "total_amount": 0,
    "scraping_remain": 0,
    "scraping_total_amount": 0,
    "scraping_timestamp": "string",
    "scraping_timestamp2": 0,
    "common_scraping_remain": 0,
    "common_scraping_total_amount": 0,
    "common_scraping_timestamp": "string",
    "common_scraping_timestamp2": 0,
    "pdidcr_count": 0,
    "pdidcr_total": 0,
    "pdidcr_traffic_remain": 0,
    "pdidcr_traffic_total": 0,
    "p_sitai_ip_count": 0,
    "p_sitai_ip": 0,
    "p_sitai_ip_total": 0,
    "p_sitai_remain": 0,
    "p_sitai_total": 0,
    "pdidc_count": 0,
    "pdidc_total": 0,
    "pdidc_ip_count": 0,
    "pdidc_ip_all_count": 0,
    "pdispr_count": 0,
    "pdispr_total": 0,
    "pdispr_traffic_remain": 0,
    "pdispr_traffic_total": 0,
    "product_datacenter_isp_traffic_ip_count": 0,
    "product_datacenter_isp_traffc_ip": 0,
    "product_datacenter_isp_traffc_ip_total": 0,
    "product_datacenter_isp_traffic_ip": 0,
    "product_datacenter_isp_traffic_ip_total": 0,
    "product_datacenter_isp_traffc_remain": 0,
    "product_datacenter_isp_traffc_total": 0,
    "product_datacenter_isp_traffic_remain": 0,
    "product_datacenter_isp_traffic_total": 0,
    "product_datacenter_isp_ip": 0,
    "product_datacenter_isp_ip_total": 0,
    "product_datacenter_isp_ip_count": 0,
    "product_datacenter_isp_ip_all_count": 0,
    "product_datacenter_isp_ip_traffic_remain": 0,
    "product_datacenter_isp_ip_traffic_total": 0,
    "product_agent_residence_remain_count": 0,
    "product_agent_residence_total_count": 0,
    "product_serp_remain": 0,
    "product_serp_total": 0,
    "product_serp_timestamp": "string",
    "product_serp_timestamp2": 0,
    "product_video_remain": 0,
    "product_video_total": 0,
    "product_video_timestamp": "string",
    "product_video_timestamp2": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

团队资产列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/team/assets?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/assets

参数

名称位置类型必填描述
team_idqueryTeamPublicIdtrue无
pagequeryintegerfalse无
page_sizequeryintegerfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

可划入团队的个人资产

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/team/assets/personal-candidates?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/assets/personal-candidates

参数

名称位置类型必填描述
team_idqueryTeamPublicIdtrue无
pagequeryintegerfalse无
page_sizequeryintegerfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

个人资产划入团队

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/team/assets/move-in \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/assets/move-in

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyTeamPublicIdtrue团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» user_product_idbodyintegertrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

团队资产移回个人

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/team/assets/move-out \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/assets/move-out

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyTeamPublicIdtrue团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» user_product_idbodyintegertrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

积分管理

积分套餐信息、自动补充、消耗记录和统计

获取积分套餐信息 (GET /web_v1/credit/info)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/web_v1/credit/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/info

查询当前资源空间的积分套餐摘要。团队空间要求 USE_ASSETS 权限；此接口同时支持登录态、个人 API Key 和团队 API Key。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse资源空间标识；个人空间省略或传空字符串；团队 API Key 可省略，传入时必须与 Key 一致

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 为积分等级、总量、剩余量、重置时间和自动补充状态Inline

响应结构

设置余额自动补充积分

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/web_v1/credit/update-auto-supplement \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /web_v1/credit/update-auto-supplement

登录态设置当前资源空间的自动补充开关。团队空间要求 USE_OWNER_PAYMENT_CAPABILITIES 权限，当前仅团队超级管理员可操作；团队空间默认关闭。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "status": 0
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» statusbodyintegertrue0=关闭，1=开启

枚举值

ParameterValue
» status0
» status1

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data.status 为更新后的开关状态Inline

响应结构

获取积分消耗记录 (GET /web_v1/credit/consumption-logs)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/web_v1/credit/consumption-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/consumption-logs

登录态或 API Key 分页查询当前资源空间的积分消耗记录。团队空间要求 VIEW_BILLING 权限。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
pagequeryintegerfalse无
page_sizequeryintegerfalse无
start_datequerystring(date)false开始日期，按站点时区解释
end_datequerystring(date)false结束日期，按站点时区解释
consumption_typequerystringfalse消耗类型

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 包含 list、page、page_size、total_count 和 total_pageInline

响应结构

获取积分重置记录 (GET /web_v1/credit/reset-logs)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/web_v1/credit/reset-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/reset-logs

登录态或 API Key 分页查询当前资源空间的积分重置记录。团队空间要求 VIEW_BILLING 权限。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
pagequeryintegerfalse无
page_sizequeryintegerfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 包含积分重置记录及分页信息Inline

响应结构

获取积分统计 (GET /web_v1/credit/stats)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/web_v1/credit/stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/stats

登录态或 API Key 查询当前资源空间按消耗类型聚合的积分统计。团队空间要求 VIEW_BILLING 权限。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
start_datequerystring(date)false开始日期，按站点时区解释
end_datequerystring(date)false结束日期，按站点时区解释

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 包含 by_type 和 totalInline

响应结构

获取按天积分统计 (GET /web_v1/credit/daily-stats)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/web_v1/credit/daily-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/daily-stats

登录态或 API Key 查询当前资源空间的按天积分消耗，默认最近 7 天。团队普通成员仅返回本人实际消费；具备 VIEW_BILLING 权限的管理员、超级管理员和财务成员返回团队全量数据。历史未记录消费成员的团队日志仅对全量视图可见。 API Key 查询最多包含 31 个自然日（含首尾），开始日期不得晚于结束日期。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
start_datequerystring(date)false开始日期，默认 6 天前
end_datequerystring(date)false结束日期，默认今天
consumption_typequerystringfalse可选消耗类型
fill_gapsqueryintegerfalse是否补齐缺失日期

枚举值

ParameterValue
fill_gaps0
fill_gaps1

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 包含 daily_stats 和 summaryInline

响应结构

获取按小时积分统计 (GET /web_v1/credit/hourly-stats)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/web_v1/credit/hourly-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/credit/hourly-stats

登录态或 API Key 查询当前资源空间的按小时积分消耗，默认最近 7 天。团队空间要求 VIEW_BILLING 权限。 API Key 查询最多包含 31 个自然日（含首尾），开始日期不得晚于结束日期。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
start_datequerystring(date)false开始日期，默认 6 天前
end_datequerystring(date)false结束日期，默认今天
consumption_typequerystringfalse可选消耗类型
fill_gapsqueryintegerfalse是否补齐缺失小时

枚举值

ParameterValue
fill_gaps0
fill_gaps1

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 包含 hourly_stats 和 summaryInline

响应结构

获取积分套餐信息 (GET /end-point/credit/info)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/credit/info \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/info

查询当前资源空间的积分套餐摘要。团队空间要求 USE_ASSETS 权限；此接口同时支持登录态、个人 API Key 和团队 API Key。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse资源空间标识；个人空间省略或传空字符串；团队 API Key 可省略，传入时必须与 Key 一致

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 为积分等级、总量、剩余量、重置时间和自动补充状态Inline

响应结构

获取积分消耗记录 (GET /end-point/credit/consumption-logs)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/credit/consumption-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/consumption-logs

登录态或 API Key 分页查询当前资源空间的积分消耗记录。团队空间要求 VIEW_BILLING 权限。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
pagequeryintegerfalse无
page_sizequeryintegerfalse无
start_datequerystring(date)false开始日期，按站点时区解释
end_datequerystring(date)false结束日期，按站点时区解释
consumption_typequerystringfalse消耗类型

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 包含 list、page、page_size、total_count 和 total_pageInline

响应结构

获取积分重置记录 (GET /end-point/credit/reset-logs)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/credit/reset-logs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/reset-logs

登录态或 API Key 分页查询当前资源空间的积分重置记录。团队空间要求 VIEW_BILLING 权限。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
pagequeryintegerfalse无
page_sizequeryintegerfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 包含积分重置记录及分页信息Inline

响应结构

获取积分统计 (GET /end-point/credit/stats)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/credit/stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/stats

登录态或 API Key 查询当前资源空间按消耗类型聚合的积分统计。团队空间要求 VIEW_BILLING 权限。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
start_datequerystring(date)false开始日期，按站点时区解释
end_datequerystring(date)false结束日期，按站点时区解释

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 包含 by_type 和 totalInline

响应结构

获取按天积分统计 (GET /end-point/credit/daily-stats)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/credit/daily-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/daily-stats

登录态或 API Key 查询当前资源空间的按天积分消耗，默认最近 7 天。团队普通成员仅返回本人实际消费；具备 VIEW_BILLING 权限的管理员、超级管理员和财务成员返回团队全量数据。历史未记录消费成员的团队日志仅对全量视图可见。 API Key 查询最多包含 31 个自然日（含首尾），开始日期不得晚于结束日期。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
start_datequerystring(date)false开始日期，默认 6 天前
end_datequerystring(date)false结束日期，默认今天
consumption_typequerystringfalse可选消耗类型
fill_gapsqueryintegerfalse是否补齐缺失日期

枚举值

ParameterValue
fill_gaps0
fill_gaps1

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 包含 daily_stats 和 summaryInline

响应结构

获取按小时积分统计 (GET /end-point/credit/hourly-stats)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/credit/hourly-stats \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/credit/hourly-stats

登录态或 API Key 查询当前资源空间的按小时积分消耗，默认最近 7 天。团队空间要求 VIEW_BILLING 权限。 API Key 查询最多包含 31 个自然日（含首尾），开始日期不得晚于结束日期。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
start_datequerystring(date)false开始日期，默认 6 天前
end_datequerystring(date)false结束日期，默认今天
consumption_typequerystringfalse可选消耗类型
fill_gapsqueryintegerfalse是否补齐缺失小时

枚举值

ParameterValue
fill_gaps0
fill_gaps1

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 包含 hourly_stats 和 summaryInline

响应结构

Xcrawl Activity Log

Xcrawl 单任务与批任务的记录、详情和汇总查询

获取 Xcrawl 近期任务列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/recent-runs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/recent-runs

登录态查询当前资源空间的单任务列表和汇总。团队空间要求 USE_ASSETS；普通成员仅能查看自己创建凭据产生的任务，管理员和超级管理员可查看全团队任务。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
pagequeryintegerfalse无
page_sizequeryintegerfalse无
endpointquerystringfalse端点类型
statusquerystringfalse无
start_timequerystringfalse用户时区时间，格式 Y-m-d H:i:s
end_timequerystringfalse用户时区时间，包含结束边界
urlquerystringfalse目标 URL 或 Data scraper 标识
job_idquerystringfalse任务 ID 前缀

枚举值

ParameterValue
statuspending
statuscrawling
statuscompleted
statusfailed

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 包含分页 list 和 metadataInline

响应结构

获取 Xcrawl Crawl Result

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/crawl-result?job_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/crawl-result

登录态查询当前资源空间指定任务的 Crawl Result。团队空间要求 USE_ASSETS，并按成员可见凭据范围校验任务归属。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
job_idquerystringtrue任务 ID

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 包含 job_id 和 crawl_resultInline

响应结构

获取 Xcrawl 任务详情与日志

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/activity-logs?job_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/activity-logs

登录态查询当前资源空间指定单任务及其结果详情。团队空间要求 USE_ASSETS，并按成员可见凭据范围校验任务归属。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
job_idquerystringtrue任务 ID
pagequeryintegerfalsecrawl/data 子结果页码
page_sizequeryintegerfalsecrawl/data 子结果分页数量

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 包含 job 和按 endpoint 变化的 detailInline

响应结构

获取 Data URL 聚合统计

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/data-url-summary \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/data-url-summary

登录态聚合当前资源空间的 Data scraper 任务。团队空间要求 USE_ASSETS，结果遵循成员可见凭据范围。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
limitqueryintegerfalse返回数量；0 返回空列表

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data.list 为 scraper 聚合结果Inline

响应结构

获取批量爬取近期任务列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/batch-recent-runs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/batch-recent-runs

登录态查询当前资源空间的批任务列表和汇总。团队空间要求 USE_ASSETS；普通成员仅能查看自己创建凭据产生的任务，管理员和超级管理员可查看全团队任务。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
pagequeryintegerfalse无
page_sizequeryintegerfalse无
endpointquerystringfalse端点类型，通常为 batch_scrape
statusquerystringfalse无
start_timequerystringfalse用户时区时间，格式 Y-m-d H:i:s
end_timequerystringfalse用户时区时间，包含结束边界
batch_idquerystringfalse批任务 ID 前缀

枚举值

ParameterValue
statuspending
statuscrawling
statuscompleted
statusfailed

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 包含分页 list 和 metadataInline

响应结构

获取批量爬取任务详情与日志

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/web_v1/xcrawl-activity-log/batch-activity-logs?batch_id=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /web_v1/xcrawl-activity-log/batch-activity-logs

登录态查询当前资源空间指定批任务及其子项结果。团队空间要求 USE_ASSETS，并按成员可见凭据范围校验任务归属。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
batch_idquerystringtrue批任务 ID
pagequeryintegerfalse子项页码
page_sizequeryintegerfalse子项分页数量

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；业务成功时 data 包含 job 和批任务 detailInline

响应结构

账户管理

获取个人账户概览

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/account/profile \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/account/profile

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "username": "string",
    "nickname": "string",
    "email": "string",
    "balance": "string",
    "gift_balance": "string",
    "currency": "string",
    "language": "string",
    "timezone": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

查询个人余额流水

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/wallet/change-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/wallet/change-list

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

参数

名称位置类型必填描述
re_typequeryintegerfalse无
transaction_typequeryintegerfalse无
balance_typequeryintegerfalse无
pagequeryintegerfalse无
page_sizequeryintegerfalse无

枚举值

ParameterValue
re_type0
re_type1

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "re_type": 0,
        "transaction_type": 0,
        "balance_type": 0,
        "fee": "string"
      }
    ],
    "page": 0,
    "page_size": 0,
    "total_count": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

日志导出

创建代理日志导出任务

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow-log-export/create \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow-log-export/create

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。 开始时间必须早于结束时间，时间跨度不超过 31 天；同一用户只允许一个等待或处理中的导出任务，日志上限为 500 万条。

Body parameter

{
  "start_time": 0,
  "end_time": 0,
  "type": "dynamic"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» start_timebodyintegertrue开始 Unix 时间戳，秒
» end_timebodyintegertrue结束 Unix 时间戳，秒
» typebodystringfalse无

枚举值

ParameterValue
» typedynamic
» typehost_pool

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "task_id": 0,
    "status": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

查询日志导出任务详情

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow-log-export/detail?task_id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow-log-export/detail

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

参数

名称位置类型必填描述
task_idqueryintegertrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "user_id": 0,
    "start_time": "string",
    "end_time": "string",
    "status": "pending",
    "file_size": 0,
    "record_count": 0,
    "created_at": "string",
    "completed_at": "string",
    "file_url": "string",
    "download_url": "string",
    "error_message": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

枚举值

属性值
statuspending
statusprocessing
statuscompleted
statusfailed
statuscanceled
statusno_data

查询日志导出任务列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow-log-export/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow-log-export/list

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

参数

名称位置类型必填描述
pagequeryintegerfalse无
sizequeryintegerfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "user_id": 0,
        "start_time": "string",
        "end_time": "string",
        "status": "pending",
        "file_size": 0,
        "record_count": 0,
        "created_at": "string",
        "completed_at": "string",
        "file_url": "string",
        "download_url": "string",
        "error_message": "string"
      }
    ],
    "total": 0,
    "page": 0,
    "size": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

枚举值

属性值
statuspending
statusprocessing
statuscompleted
statusfailed
statuscanceled
statusno_data

取消尚未执行的日志导出任务

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow-log-export/cancel \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow-log-export/cancel

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。 仅能取消队列中处于等待状态的任务，已经执行的任务无法取消。

Body parameter

{
  "task_id": 1
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» task_idbodyintegertrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

优惠券

查询个人优惠券列表

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-coupon/list \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-coupon/list

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

Body parameter

{
  "status": 0,
  "page": 1,
  "size": 20
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» statusbodyintegerfalse无
» pagebodyintegerfalse无
» sizebodyintegerfalse无

枚举值

ParameterValue
» status0
» status1
» status2

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "coupon_id": 0,
        "type": 0,
        "status": 0,
        "source": 0,
        "title": "string",
        "title_en": "string",
        "description": "string",
        "description_en": "string",
        "start_amount": "string",
        "start_amount_usd": "string",
        "start_amount_hkd": "string",
        "deduction_amount": "string",
        "deduction_amount_usd": "string",
        "deduction_amount_hkd": "string",
        "discount_rate": "string",
        "discount_ceiling_amount": "string",
        "discount_ceiling_amount_usd": "string",
        "discount_ceiling_amount_hkd": "string",
        "created_at": "string",
        "effect_at": "string",
        "expired_at": "string",
        "used_at": "string",
        "product_types": "string",
        "created_timestamp": 0,
        "effect_timestamp": 0,
        "expired_timestamp": 0,
        "used_timestamp": 0,
        "is_expired": true
      }
    ],
    "page": 0,
    "page_size": 0,
    "page_count": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

查询个人优惠券详情

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-coupon/info \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-coupon/info

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

Body parameter

{
  "id": 1
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» idbodyintegertrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "coupon_id": 0,
    "type": 0,
    "status": 0,
    "source": 0,
    "title": "string",
    "title_en": "string",
    "description": "string",
    "description_en": "string",
    "start_amount": "string",
    "start_amount_usd": "string",
    "start_amount_hkd": "string",
    "deduction_amount": "string",
    "deduction_amount_usd": "string",
    "deduction_amount_hkd": "string",
    "discount_rate": "string",
    "discount_ceiling_amount": "string",
    "discount_ceiling_amount_usd": "string",
    "discount_ceiling_amount_hkd": "string",
    "created_at": "string",
    "effect_at": "string",
    "expired_at": "string",
    "used_at": "string",
    "product_types": "string",
    "created_timestamp": 0,
    "effect_timestamp": 0,
    "expired_timestamp": 0,
    "used_timestamp": 0,
    "is_expired": true
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

通知管理

查询站内通知

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/notify/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/notify/list

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

参数

名称位置类型必填描述
pagequeryintegerfalse无
sizequeryintegerfalse无
readqueryintegerfalse无
typequeryintegerfalse无

枚举值

ParameterValue
read0
read1

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "title": "string",
        "content": "string",
        "type": 0,
        "read_status": 0,
        "created_at": "string",
        "created_timestamp": 0
      }
    ],
    "page": 0,
    "size": 0,
    "total": 0,
    "total_unread_count": 0,
    "unread_count_by_type": {}
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

枚举值

属性值
read_status0
read_status1

查询站内通知详情

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/notify/detail?id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/notify/detail

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

参数

名称位置类型必填描述
idqueryintegertrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 0,
    "title": "string",
    "content": "string",
    "type": 0,
    "read_status": 0,
    "created_at": "string",
    "created_timestamp": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

枚举值

属性值
read_status0
read_status1

将站内通知标记为已读

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/notify/read \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/notify/read

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

Body parameter

{
  "id": 1
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» idbodyintegertrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

批量标记站内通知为已读

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/notify/batch-read \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/notify/batch-read

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

Body parameter

{
  "ids": [
    1
  ]
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» idsbody[integer]true无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

查询通知渠道配置

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-notify \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notify

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "scene": 0,
        "email_notify": true,
        "phone_notify": true,
        "browser_notify": true,
        "site_inner_message_notify": true,
        "webhook_notify": true,
        "telegram_notify": true
      }
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

查询通知邮箱

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-notification-email/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notification-email/list

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "email": "string",
        "created_at": 0
      }
    ],
    "max_count": 0,
    "current_count": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

查询通知场景

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-notification-email/scenes \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notification-email/scenes

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "name": "string",
        "description": "string"
      }
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

查询邮箱订阅场景

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-notification-email/email-scenes?id=1 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-notification-email/email-scenes

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

参数

名称位置类型必填描述
idqueryintegertrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "scenes": [
      0
    ],
    "subscribe_all": true
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

代理配置

查询个人代理缓存开关

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/proxy-cache/status \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/proxy-cache/status

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "status": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

枚举值

属性值
status0
status1

设置个人代理缓存开关

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/proxy-cache/change \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-cache/change

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

Body parameter

{
  "status": 0
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» statusbodyintegertrue无

枚举值

ParameterValue
» status0
» status1

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

查询个人代理 UDP 开关

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-proxy-config/udp \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-proxy-config/udp

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "enabled": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

枚举值

属性值
enabled0
enabled1

设置个人代理 UDP 开关

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-proxy-config/udp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-proxy-config/udp

仅支持个人空间的登录态或个人 API Key；团队 API Key 不支持。

Body parameter

{
  "udp": 0
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» udpbodyintegertrue无

枚举值

ParameterValue
» udp0
» udp1

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "enabled": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请检查业务 code，200 为成功。Inline

响应结构

枚举值

属性值
enabled0
enabled1

团队钱包

查询团队钱包

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/team/wallet/detail?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/wallet/detail

需要 VIEW_BILLING 权限。团队钱包独立于超级管理员和成员的个人余额。

参数

名称位置类型必填描述
team_idqueryTeamPublicIdtrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

查询团队钱包流水

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/team/wallet/records?team_id=A1b2C3d4E5f6 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/team/wallet/records

需要 VIEW_BILLING 权限。流水金额始终为正数，资金增减由 direction 字段表示。

参数

名称位置类型必填描述
team_idqueryTeamPublicIdtrue无
pagequeryintegerfalse无
page_sizequeryintegerfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "operator_user_id": 0,
        "creator": {
          "user_id": 0,
          "display_name": "string",
          "nickname": "string",
          "username": "string",
          "email": "string",
          "phone": "string"
        },
        "direction": 0,
        "transaction_type": 1,
        "amount": 0.1,
        "after_balance": 0.1,
        "link_id": 0,
        "request_id": "string",
        "remark": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

枚举值

属性值
direction0
direction1
transaction_type1
transaction_type2
transaction_type3
transaction_type4
transaction_type5

个人余额转入团队钱包

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/team/wallet/transfer-in \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/wallet/transfer-in

仅团队超级管理员具有 TRANSFER_BALANCE 权限。原子扣减其个人充值余额后增加团队钱包；转入金额不计入 total_recharge_fee，且不支持转回个人余额。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "amount": 9999999999.9999
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyTeamPublicIdtrue团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» amountbodynumber(double)true无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

团队余额转回个人账户

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/team/wallet/transfer-out \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/team/wallet/transfer-out

仅超级管理员登录态可调用。原子扣减团队钱包并增加其个人充值余额；不改变团队或个人的累计充值金额。解散中的团队可用于回收余额，已解散团队不能调用。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "amount": 9999999999.9999
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyTeamPublicIdtrue团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» amountbodynumber(double)true不得超过团队当前可用余额

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKHTTP 成功；请继续判断响应体 codeInline

响应结构

IP提取

提取IP (GET /end-point/ip/get-ip)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/ip/get-ip?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/get-ip

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse团队 Key 可省略；传入时必须与 Key 绑定团队一致
app_keyquerystring(password)true访问密钥
ccquerystringfalse国家或地区
statequerystringfalse省或州
cityquerystringfalse城市
formatquerystringfalse获取格式
lbquerystringfalse间隔符，仅text格式有效
numquerynumberfalse提取数量
lifequerynumberfalse保持周期-分钟
epquerystringfalse代理网络

枚举值

ParameterValue
epus
ephk
epde

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      [
        "150.109.114.72:1140",
        "150.109.114.72:1141",
        "150.109.114.72:1142",
        "150.109.114.72:1143",
        "150.109.114.72:1144",
        "150.109.114.72:1145",
        "150.109.114.72:1146",
        "150.109.114.72:1147",
        "150.109.114.72:1148",
        "150.109.114.72:1149"
      ]
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegertrue无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringtrue无状态消息
» dataobjectfalse无none
»» list[any]false无none

城市列表 (GET /end-point/ip/dynamic-area-city-list)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-area-city-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-area-city-list

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "name_zh_cn": "美国",
        "name_en": "United States",
        "continent_code": "NA",
        "country_code": "US",
        "items": [
          {
            "city": "Arlington",
            "state": "alabama",
            "continent_code": "NA",
            "country_code": "US"
          }
        ]
      }
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegertrue无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringtrue无状态消息
» dataobjectfalse无none
»» list[object]false无列表
»»» name_zh_cnstringfalse无国家或地区名称
»»» name_enstringfalse无国家或地区名称
»»» continent_codestringfalse无大洲代码
»»» country_codestringfalse无国家或地区代码
»»» items[any]false无省或州
»»»» citystringfalse无城市名称
»»»» statestringfalse无省或州名称代码
»»»» continent_codestringfalse无大洲代码
»»»» country_codestringfalse无国家或地区代码

IP 提取数量按天统计

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-extract-ip/days \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-extract-ip/days

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
start_datequerystring(date)false默认 6 天前
end_datequerystring(date)false默认今天
product_typequeryintegerfalse无

枚举值

ParameterValue
product_type9
product_type17
product_type22

响应示例

200 响应

{
  "code": 0,
  "msg": "string",
  "request_id": "string",
  "data": {
    "list": [
      {
        "count": 0,
        "date": "2019-08-24"
      }
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无none
» msgstringfalse无none
» request_idstringfalse无none
» dataobjectfalse无none
»» list[object]false无none
»»» countintegertrue无none
»»» datestring(date)true无none

提取IP (GET /end-point/ip/v3)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/ip/v3?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/v3

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse团队 Key 可省略；传入时必须与 Key 绑定团队一致
app_keyquerystring(password)true访问密钥
ccquerystringfalse国家或地区
statequerystringfalse省或州
cityquerystringfalse城市
formatquerystringfalse获取格式
lbquerystringfalse间隔符，仅text格式有效
numquerynumberfalse提取数量
lifequerynumberfalse保持周期-分钟
epquerystringfalse代理网络

枚举值

ParameterValue
epus
ephk
epde

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      [
        "150.109.114.72:1140",
        "150.109.114.72:1141",
        "150.109.114.72:1142",
        "150.109.114.72:1143",
        "150.109.114.72:1144",
        "150.109.114.72:1145",
        "150.109.114.72:1146",
        "150.109.114.72:1147",
        "150.109.114.72:1148",
        "150.109.114.72:1149"
      ]
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegertrue无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringtrue无状态消息
» dataobjectfalse无none
»» list[any]false无none

动态地区城市列表V4

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/ip/dcl4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dcl4

按用户名获取城市列表，需要登录认证，且账户必须属于当前用户

参数

名称位置类型必填描述
usernamequerystringtrue代理账户用户名

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "City": "Los Angeles",
        "Area": "US",
        "State": "California"
      }
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功
» msgstringfalse无状态消息
» dataobjectfalse无none
»» cachebooleanfalse无是否来自缓存
»» list[object]false无none
»»» Citystringfalse无城市
»»» Areastringfalse无地区
»»» Statestringfalse无州/省

动态地区州/省列表V4

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/ip/dsl4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dsl4

按用户名获取州/省列表，需要登录认证，且账户必须属于当前用户

参数

名称位置类型必填描述
usernamequerystringtrue代理账户用户名

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "City": "Los Angeles",
        "Area": "US",
        "State": "California"
      }
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功
» msgstringfalse无状态消息
» dataobjectfalse无none
»» cachebooleanfalse无是否来自缓存
»» list[object]false无none
»»» Citystringfalse无城市
»»» Areastringfalse无地区
»»» Statestringfalse无州/省

动态地区州/省城市融合列表V4

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/ip/dal4?username=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dal4

按用户名获取州/省和城市的融合列表，按地区分组。需要登录认证，且账户必须属于当前用户

参数

名称位置类型必填描述
usernamequerystringtrue代理账户用户名

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "Area": "US",
        "states": [
          {
            "State": "California",
            "cities": [
              "Los Angeles"
            ]
          }
        ]
      }
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功
» msgstringfalse无状态消息
» dataobjectfalse无none
»» cachebooleanfalse无是否来自缓存
»» list[object]false无地区列表
»»» Areastringfalse无地区代码
»»» states[object]false无州/省列表
»»»» Statestringfalse无州/省名称
»»»» cities[string]false无城市列表

城市列表 (GET /end-point/ip/dynamic-citys)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-citys \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-citys

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "name_zh_cn": "美国",
        "name_en": "United States",
        "continent_code": "NA",
        "country_code": "US",
        "items": [
          {
            "city": "Arlington",
            "state": "alabama",
            "continent_code": "NA",
            "country_code": "US"
          }
        ]
      }
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegertrue无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringtrue无状态消息
» dataobjectfalse无none
»» list[object]false无列表
»»» name_zh_cnstringfalse无国家或地区名称
»»» name_enstringfalse无国家或地区名称
»»» continent_codestringfalse无大洲代码
»»» country_codestringfalse无国家或地区代码
»»» items[any]false无省或州
»»»» citystringfalse无城市名称
»»»» statestringfalse无省或州名称代码
»»»» continent_codestringfalse无大洲代码
»»»» country_codestringfalse无国家或地区代码

城市搜索

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-citys/search?country_code=string&state=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-citys/search

参数

名称位置类型必填描述
country_codequerystringtrue国家或地区代码
statequerystringtrue州或省代码

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      "string"
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegertrue无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringtrue无状态消息
» dataobjectfalse无none
»» list[string]false无列表

州列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-states \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-states

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "name_zh_cn": "美国",
        "name_en": "United States",
        "continent_code": "NA",
        "country_code": "US",
        "items": [
          {
            "state": "alabama",
            "continent_code": "NA",
            "country_code": "US"
          }
        ]
      }
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegertrue无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringtrue无状态消息
» dataobjectfalse无none
»» list[object]false无列表
»»» name_zh_cnstringfalse无国家或地区名称
»»» name_enstringfalse无国家或地区名称
»»» continent_codestringfalse无大洲代码
»»» country_codestringfalse无国家或地区代码
»»» items[any]false无省或州
»»»» statestringfalse无省或州名称代码
»»»» continent_codestringfalse无大洲代码
»»»» country_codestringfalse无国家或地区代码

州/省搜索

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/ip/dynamic-states/search?country_code=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/dynamic-states/search

参数

名称位置类型必填描述
country_codequerystringtrue国家或地区代码

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      "string"
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegertrue无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringtrue无状态消息
» dataobjectfalse无none
»» list[string]false无列表

获取已分配的数据中心静态 IP 列表

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/ip/get-datacenter-assign-ip-list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/ip/get-datacenter-assign-ip-list

已废弃，推荐使用 /openapi/user-product/datacenter-isp-ip-list。为兼容旧客户端，本接口使用 POST 方法，但筛选参数均从 query 读取。

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse资源空间标识；个人空间省略或传空字符串；团队 Key 可省略，传入时必须与 Key 一致
areaquerystringfalse国家/地区代码
statusqueryintegerfalse0=所有，1=有效，2=过期
trade_noquerystringfalse订单号
created_atqueryarray[string]false创建时间范围，必须同时传开始和结束时间

枚举值

ParameterValue
status0
status1
status2

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "total": 0,
    "list": [
      {
        "id": 1,
        "ip": "string",
        "country_code": "string",
        "up_id": 1,
        "expired_at": "string",
        "created_at": "string",
        "country_name_zh_cn": "string",
        "country_name_en": "string",
        "country_continent_code": "string",
        "port": 1
      }
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

提取已购买静态IP列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/ip/get-static-ip \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/get-static-ip

参数

名称位置类型必填描述
country_codequerystringfalse国家或地区代码
product_typequerynumberfalse产品类型, 25:静态住宅IP, 14: 数据中心IP
trade_noquerystringfalse通过订单号筛选IP
pagequerynumberfalse页码
sizequerynumberfalse每页数量
statusquerynumberfalse状态, 1:有效, 2:无效, 3:即将过期, 4:维护中

枚举值

ParameterValue
product_type14
product_type25
status1 - 2 - 3 - 4

响应

状态码含义描述数据模型

获取在售地区静态IP数量

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/ip/static-ip-region \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/ip/static-ip-region

参数

名称位置类型必填描述
ispqueryintegerfalseISP 筛选，不传则不筛选（站点 1/4/5 除外默认为 1）
asnqueryintegerfalse是否返回 ASN 分组数据
exclusivequeryintegerfalse是否按独享库存统计

Detailed descriptions

isp: ISP 筛选，不传则不筛选（站点 1/4/5 除外默认为 1）

值描述
0数据中心静态IP（IDC）
1家庭住宅静态IP（ISP）

asn: 是否返回 ASN 分组数据

值描述
0不返回 ASN 分组数据（默认）
1返回 ASN 分组数据

exclusive: 是否按独享库存统计

值描述
0按当前用户/共享组口径统计（默认）
1排除所有已分配IP，仅统计可用库存

枚举值

ParameterValue
isp0
isp1
asn0
asn1
exclusive0
exclusive1

响应示例

200 响应

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "list": [
      {
        "code": "US",
        "number": 55
      }
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegertrue无状态码,200 成功
» msgstringtrue无状态消息
» dataobjectfalse无none
»» list[any]false无none
»»» codestringtrue无国家或地区代码
»»» numberintegertrue无数量

获取 host_pool 支持国家/地区

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/host-pool/regions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/host-pool/regions

查询 host_pool 服务当前站点支持的国家/地区列表。

该接口面向数据中心 IP 按流量积分的随机提取场景，仅按当前站点可用数据中心 IP 库存统计国家/地区。

响应示例

200 响应

{
  "code": 200,
  "msg": "请求成功",
  "data": {
    "list": [
      {
        "code": "US",
        "number": 55,
        "name_zh_cn": "美国",
        "name_en": "United States",
        "square_flag": "https://example.com/static/flags/us.png"
      }
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegertrue无状态码,200 成功
» msgstringtrue无状态消息
» dataobjectfalse无none
»» list[object]false无none
»»» codestringtrue无国家或地区代码，ISO 3166-1 alpha-2
»»» numberintegertrue无当前站点可用数据中心 IP 数量
»»» name_zh_cnstringfalse无国家或地区中文名称
»»» name_enstringfalse无国家或地区英文名称
»»» square_flagstringfalse无方形旗帜图片 URL

IP白名单

IP 白名单列表 (GET /end-point/proxy-ip/list)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/proxy-ip/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/proxy-ip/list

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse资源空间标识；个人空间省略或传空字符串
product_typequeryintegerfalse套餐类型编号

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "ip": "1.1.1.1",
        "remark": "string",
        "product_type": 0,
        "created_at": "string"
      }
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功
» msgstringfalse无状态消息
» dataobjectfalse无none
»» list[object]false无none
»»» ipstringfalse无白名单 IP
»»» remarkstringfalse无备注
»»» product_typeintegerfalse无套餐类型
»»» created_atstringfalse无创建时间

添加 IP 白名单 (POST /end-point/proxy-ip/add)

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/proxy-ip/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-ip/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "remark": "string",
  "product_type": 0,
  "user_product_id": 0
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_keybodystringfalse授权密钥
» ipsbodystringtrue需要添加的白名单 IP，多个用英文逗号或换行分隔
» remarkbodystringfalse备注
» product_typebodyintegerfalse套餐类型编号
» user_product_idbodyintegerfalse用户套餐 ID，套餐类型为 11 时必填

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": null
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功
» msgstringfalse无状态消息
» datanullfalse无none

删除 IP 白名单 (POST /end-point/proxy-ip/delete)

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/proxy-ip/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/proxy-ip/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "verify_type": "string",
  "verify_code": "string"
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_keybodystringfalse授权密钥
» ipsbodystringtrue需要删除的白名单 IP，多个用英文逗号分隔
» verify_typebodystringfalse验证类型：phone、email、wechat、totp
» verify_codebodystringfalse验证码

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": null
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功
» msgstringfalse无状态消息
» datanullfalse无none

IP 白名单列表 (GET /end-point/white-ip/list)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/white-ip/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/white-ip/list

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse资源空间标识；个人空间省略或传空字符串
product_typequeryintegerfalse套餐类型编号

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "ip": "1.1.1.1",
        "remark": "string",
        "product_type": 0,
        "created_at": "string"
      }
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功
» msgstringfalse无状态消息
» dataobjectfalse无none
»» list[object]false无none
»»» ipstringfalse无白名单 IP
»»» remarkstringfalse无备注
»»» product_typeintegerfalse无套餐类型
»»» created_atstringfalse无创建时间

添加 IP 白名单 (POST /end-point/white-ip/add)

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/white-ip/add \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/add

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "remark": "string",
  "product_type": 0,
  "user_product_id": 0
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_keybodystringfalse授权密钥
» ipsbodystringtrue需要添加的白名单 IP，多个用英文逗号或换行分隔
» remarkbodystringfalse备注
» product_typebodyintegerfalse套餐类型编号
» user_product_idbodyintegerfalse用户套餐 ID，套餐类型为 11 时必填

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": null
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功
» msgstringfalse无状态消息
» datanullfalse无none

删除 IP 白名单 (POST /end-point/white-ip/delete)

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/white-ip/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "verify_type": "string",
  "verify_code": "string"
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_keybodystringfalse授权密钥
» ipsbodystringtrue需要删除的白名单 IP，多个用英文逗号分隔
» verify_typebodystringfalse验证类型：phone、email、wechat、totp
» verify_codebodystringfalse验证码

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": null
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功
» msgstringfalse无状态消息
» datanullfalse无none

修改 IP 白名单备注

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/white-ip/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/change-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ip": "192.168.0.1",
  "remark": "string"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» ipbodystring(ipv4)true无
» remarkbodystringtrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

刷新当前资源空间 IP 白名单认证缓存

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/white-ip/refresh \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/white-ip/refresh

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

指定产品类型的 IP 白名单配额

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/white-ip/quota?product_type=0 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/white-ip/quota

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
product_typequeryintegertrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

所有产品类型的 IP 白名单配额

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/white-ip/quotas \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/white-ip/quotas

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

流量日志查询

近期使用流量按天汇总

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow/days \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow/days

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "days": 7,
  "product_type": 0,
  "username": "string"
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» daysbodyintegerfalse无
» product_typebodyintegerfalse无
» usernamebodystringfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "days": "2019-08-24",
        "flow": 0
      }
    ],
    "days": 1
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

代理账户历史使用流量

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow/username-total \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow/username-total

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "flow": 0
      }
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

导出代理账户月度使用流量

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-usage-flow/export-csv \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/csv' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-usage-flow/export-csv

Body parameter

{
  "team_id": "A1b2C3d4E5f6"
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键

响应示例

200 响应

响应

状态码含义描述数据模型
200OKGBK 编码 CSV 文件string

套餐流量总量与剩余量

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/flow-total \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/flow-total

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
unitquerystringfalse无

枚举值

ParameterValue
unitKB
unitMB
unitGB
unitTB
unitPB

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "limit": 0,
    "total": 0,
    "remain": 0,
    "unit": "KB",
    "timestamp": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

枚举值

属性值
unitKB
unitMB
unitGB
unitTB
unitPB

每日速率图

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/rate-graph \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/rate-graph

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
startquerystring(date)false无
endquerystring(date)false无
usernamequerystringfalse无
user_product_idqueryintegerfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "date": "2019-08-24",
        "rate": 0,
        "corrent": 0
      }
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

每日缓存流量统计

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/cache-total \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/cache-total

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
start_timequerystringfalse无
end_timequerystringfalse无
product_typequeryintegerfalse无
usernamequerystringfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "day": "2019-08-24",
        "cache_flow": 0,
        "cache_reduce_flow": 0
      }
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

使用流量按天汇总

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-usage-flow/total?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-usage-flow/total

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse资源空间标识；个人空间省略或传空字符串
app_keyquerystring(password)true认证密钥
start_timequerystring(Y-m-d H:i:s)false起始时间，可精确到秒。请注意，日志记录有5分钟以内延迟。默认7天以内。
end_timequerystring(Y-m-d H:i:s)false截止时间，可精确到秒。请注意，日志记录有5分钟以内延迟。默认当前时间。
usernamequerystringfalse子账户名称,默认查询所有账户，可指定子账户。请注意如果您添加了相同名称的子账户，此查询将返回同名代理账户的所有使用记录。
product_typequerynumberfalse套餐类型

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "day": "2022-08-01",
        "flow": 0
      }
    ]
  }
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegertrue无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringtrue无状态消息
» dataobjectfalse无none
»» list[object]false无none
»»» daystringfalse无日期
»»» flowintegerfalse无消耗流量,单位KB

代理日志

客户端 IP 代理访问统计

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/http-t-dom/list-v2 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/http-t-dom/list-v2

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
start_timequerystring(date)false无
end_timequerystring(date)false无
exportquerystringfalse无

枚举值

ParameterValue
exportcsv

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "visit_count": 0,
        "client_ip": "string",
        "time": "2019-08-24",
        "country_code": "string",
        "country": "string"
      }
    ],
    "cache": true,
    "ttl": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKJSON 统计结果；export=csv 时返回 CSV 文件string

客户端 IP 访问占比

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/http-t-dom/client-ip-proportion \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/http-t-dom/client-ip-proportion

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
start_timequerystring(date)false无
end_timequerystring(date)false无
exportquerystringfalse无

枚举值

ParameterValue
exportcsv

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "username": "string",
        "client_ip": "string",
        "visit_count": 0,
        "visit_percentage": "string",
        "country": "string",
        "country_code": "string"
      }
    ],
    "cache": true,
    "ttl": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKJSON 占比结果；export=csv 时返回 CSV 文件string

套餐查询

已购套餐列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-product/list?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/list

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse资源空间标识；个人空间省略或传空字符串
app_keyquerystring(password)true认证密钥
trade_noquerystringfalse订单号，请输入完整订单号。不支持模糊搜索。
pagequerynumberfalse分页，默认：1
sizequerynumberfalse分页显示数量,默认：20
product_typequerynumberfalse套餐类型

响应示例

200 响应

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "created_at": "2022-05-13 12:14:15",
        "expired_at": "2022-05-13 12:14:15",
        "product_type": 9,
        "trade_no": "2022051312134339861461465434",
        "order": {
          "created_at": "2022-05-13 12:13:43",
          "pay_at": "2022-05-13 12:13:43",
          "title": "入门级"
        }
      }
    ],
    "page": 1,
    "page_size": 20,
    "total_count": 0,
    "total_page": 0
  }
}

响应

状态码含义描述数据模型
200OK请求成Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegertrue无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringtrue无状态消息
» dataobjectfalse无none
»» list[object]false无none
»»» idintegerfalse无套餐编号
»»» created_atstringfalse无套餐生效时间
»»» expired_atstringfalse无套餐过期时间,过期后流量无法使用。
»»» product_typeproductTypesfalse无套餐类型，9 动态住宅流量套餐、11 动态住宅IP、14静态数据中心IP、25 静态住宅IP
»»» trade_nostringfalse无订单交易号
»»» orderobjectfalse无none
»»»» created_atstringfalse无订单创建时间
»»»» pay_atstringfalse无订单支付时间
»»»» titlestringfalse无订单描述
»» pageintegertrue无当前分页
»» page_sizeintegerfalse无分页大小
»» total_countintegerfalse无总记录数量
»» total_pageintegerfalse无总分页数量

枚举值

属性值
product_type9
product_type11
product_type14
product_type25

用户套餐数据汇总

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-product/summary?app_key=pa%24%24word \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/summary

获取用户套餐的统计汇总信息，包括总量、有效量、临期量、过期量等

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse资源空间标识；个人空间省略或传空字符串
app_keyquerystring(password)true认证密钥
product_typequeryintegerfalse产品类型，仅支持 9（动态流量套餐）、12（长效IDC流量套餐）

枚举值

ParameterValue
product_type9
product_type12

响应示例

200 响应

{
  "code": 200,
  "msg": "成功",
  "data": {
    "total": 1048576,
    "total_count": 5,
    "effective": 524288,
    "effective_count": 3,
    "effective_total": 786432,
    "effective_used": 262144,
    "temporary": 102400,
    "temporary_count": 1,
    "expired": 51200,
    "expired_count": 1,
    "used": 473088
  }
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

Status Code 200

名称类型必填约束描述
» codeintegerfalse无状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msgstringfalse无状态消息
» dataobjectfalse无none
»» totalintegerfalse无流量/IP总量（单位：KB）
»» total_countintegerfalse无套餐总个数
»» effectiveintegerfalse无有效剩余量（单位：KB）
»» effective_countintegerfalse无有效套餐个数
»» effective_totalintegerfalse无有效总量（单位：KB）
»» effective_usedintegerfalse无有效已使用量（单位：KB）
»» temporaryintegerfalse无临期总量（7天内到期，单位：KB）
»» temporary_countintegerfalse无临期套餐个数（7天内到期）
»» expiredintegerfalse无过期剩余量（单位：KB）
»» expired_countintegerfalse无过期套餐个数
»» usedintegerfalse无已使用总量（单位：KB）

静态 IP 列表

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-product/datacenter-isp-ip-list \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/datacenter-isp-ip-list

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "status": 0,
  "page": 1,
  "size": 20,
  "user_product_id": 1,
  "country_code": "string",
  "product_type": 0,
  "ip": "192.168.0.1",
  "auto_renewal": 0,
  "support_renewal": 0,
  "remaining_days": 0,
  "limit_days": 0,
  "sort": "exp_asc",
  "remark": "string"
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» statusbodyintegerfalse无
» pagebodyintegerfalse无
» sizebodyintegerfalse无
» user_product_idbodyintegerfalse无
» country_codebodystringfalse无
» product_typebodyintegerfalse无
» ipbodystring(ipv4)false无
» auto_renewalbodyintegerfalse无
» support_renewalbodyintegerfalse无
» remaining_daysbodyintegerfalse无
» limit_daysbodyintegerfalse无
» sortbodystringfalse无
» remarkbodystringfalse无

枚举值

ParameterValue
» auto_renewal0
» auto_renewal1
» support_renewal0
» support_renewal1
» sortexp_asc
» sortexp_desc

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

删除已过期套餐

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-product/delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» idbodyintegertrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

批量删除已过期套餐

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-product/batch-delete \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/batch-delete

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ids": [
    1
  ]
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» idsbody[integer]true无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

修改套餐备注

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-product/change-remark \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/change-remark

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "remark": "string"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» idbodyintegertrue无
» remarkbodystringtrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

批量设置静态 IP UDP 开关

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-product/set-ip-udp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/set-ip-udp

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "ids": [
    1
  ],
  "udp": 0
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» idsbody[integer]true无
» udpbodyintegertrue无

枚举值

ParameterValue
» udp0
» udp1

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

套餐管理

更换数据中心 ISP 静态 IP

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-product/change-datacenter-isp-ip \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/change-datacenter-isp-ip

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "country_code": "string",
  "ip": "string"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» idbodyintegertrue用户套餐 ID
» country_codebodystringfalse目标国家/地区代码；不传时优先沿用当前 IP 国家/地区
» ipbodystringfalse目标 IP 前缀筛选

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "ip_id": 1,
    "ip": "string",
    "country_code": "string"
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

获取静态 IP 更换记录

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/user-product/ip-change-log \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/user-product/ip-change-log

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse资源空间标识；个人空间省略或传空字符串
pagequeryintegerfalse无
page_sizequeryintegerfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "old": "string",
        "new": "string",
        "created_at": "string",
        "created_timestamp": 0
      }
    ],
    "page": 1,
    "page_size": 1,
    "total_count": 0,
    "page_count": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

设置单个套餐的自动续费开关

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-product/set-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/set-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1,
  "status": 0
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» user_product_idbodyintegertrue无
» statusbodyintegerfalse0=停用，1=启用

枚举值

ParameterValue
» status0
» status1

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

批量设置套餐自动续费开关

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-product/batch-set-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/batch-set-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "status": 0
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» user_product_idsbody[integer]true无
» statusbodyintegerfalse0=停用，1=启用

枚举值

ParameterValue
» status0
» status1

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "results": [
      {
        "user_product_id": 1,
        "success": true,
        "id": 1
      }
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功；每个套餐独立返回处理结果Inline

响应结构

设置产品类型的默认自动续费参数

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-product/set-auto-renewal-default-config \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/set-auto-renewal-default-config

days_before_expire、traffic_threshold、renewal_cycle_days 至少传一个；值为 0 表示重置对应配置。

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 9,
  "days_before_expire": 30,
  "traffic_threshold": 100,
  "renewal_cycle_days": 0
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» product_typebodyintegertrue无
» days_before_expirebodyintegerfalse无
» traffic_thresholdbodyintegerfalse单位 GB，仅 9/12/24 支持
» renewal_cycle_daysbodyintegerfalse仅 11/14/16/25 支持，且必须是当前在售产品周期
» anonymousbodyobjectfalse无
» anonymousbodyobjectfalse无
» anonymousbodyobjectfalse无

枚举值

ParameterValue
» product_type9
» product_type11
» product_type12
» product_type14
» product_type16
» product_type24
» product_type25

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": null,
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功，data 为 nullInline

响应结构

获取产品类型的默认自动续费参数

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-product/get-auto-renewal-default-config \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/get-auto-renewal-default-config

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 9
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» product_typebodyintegerfalse不传则返回全部支持类型

枚举值

ParameterValue
» product_type9
» product_type11
» product_type12
» product_type14
» product_type16
» product_type24
» product_type25

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "configs": [
      {
        "product_type": 9,
        "days_before_expire": 0,
        "source": "user",
        "renewal_cycle": {
          "days": 1,
          "unit": "day",
          "source": "user"
        },
        "traffic_threshold": 0,
        "traffic_source": "user"
      }
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

枚举值

属性值
product_type9
product_type11
product_type12
product_type14
product_type16
product_type24
product_type25
sourceuser
sourcesystem
sourceuser
sourcesystem
traffic_sourceuser
traffic_sourcesystem

获取单个套餐自动续费配置和续费预览

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-product/get-auto-renewal \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/get-auto-renewal

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» user_product_idbodyintegertrue无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "expired_at": "string",
    "time_days": 0,
    "time_unit": "day",
    "next_expired_at": "string",
    "agreed_price": 0,
    "currency": "string",
    "config": {
      "id": 1,
      "user_id": 1,
      "team_id": "A1b2C3d4E5f6",
      "team_user_id": 0,
      "product_type": 0,
      "left_traffic": 0,
      "left_days": 0,
      "user_product_id": 1,
      "product_id": 0,
      "status": 0,
      "currency": "string",
      "agreed_price": 0,
      "agreed_bandwidth_price": 0,
      "agreed_concurrency_price": 0,
      "bandwidth_id": 0,
      "concurrency_id": 0,
      "duration": 0,
      "renew_product_id": 0,
      "days_before_expire": 0,
      "traffic_threshold": 0,
      "parent_product_type": 0,
      "created_at": "string",
      "updated_at": "string"
    },
    "traffic_threshold": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

枚举值

属性值
time_unitday
time_unithour
status0
status1

获取自动续费执行记录

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/user-product/auto-renewal-logs \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/user-product/auto-renewal-logs

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1,
  "page": 1,
  "size": 20
}

参数

名称位置类型必填描述
bodybodyobjectfalse无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» user_product_idbodyintegerfalse不传则查询当前空间全部记录
» pagebodyintegerfalse无
» sizebodyintegerfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "config_id": 0,
        "user_product_id": 1,
        "product_type": 0,
        "renew_product_id": 0,
        "order_id": 0,
        "fee": 0,
        "currency": "string",
        "before_expired_at": "string",
        "after_expired_at": "string",
        "before_remain": 0,
        "after_remain": 0,
        "trigger_type": 0,
        "status": 1,
        "revoke_at": "string",
        "revoke_remark": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "page": 1,
    "page_size": 1,
    "total_page": 0,
    "total_count": 0
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

枚举值

属性值
trigger_type0
trigger_type1
status1
status2
status3

支付管理

拉起订单支付

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/pay?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/pay

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
trade_noquerystringtrue无
pm_idqueryintegerfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

后台开单未支付订单拉起支付

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/pay/index-choose \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/pay/index-choose

Body parameter

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no": "string",
  "pay_method": 0,
  "pm_id": 0,
  "trade_type": "string"
}

参数

名称位置类型必填描述
bodybodyobjecttrue无
» team_idbodyanyfalse公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»» anonymousbodystringfalse无
»» anonymousbodyTeamPublicIdfalse团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» trade_nobodystringtrue无
» pay_methodbodyintegerfalse无
» pm_idbodyintegerfalse无
» trade_typebodystringfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK操作成功WebV1SuccessResponse

支付校验和费用预览

代码示例

# 也可以使用 wget
curl -X POST https://api.proxylite.com/end-point/pay/pay-check?trade_no=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /end-point/pay/pay-check

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
trade_noquerystringtrue无
pm_idqueryintegerfalse无

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "trade_no": "string",
    "pm_id": 0,
    "pay_method": 0,
    "trade_type": "string",
    "country_code": "string",
    "currency": "string",
    "goods_fee": 0,
    "discount_fee": 0,
    "handling_fee": 0,
    "pay_fee": 0,
    "total_fee": 0,
    "pay_method_info": {
      "id": 0,
      "type": 0,
      "title": "string",
      "group": "string",
      "handling_rate": 0,
      "handling_fee": 0,
      "handling_fee_currency": "usd",
      "handling_fee_converted": 0
    },
    "origin": {
      "pm_id": 0,
      "pay_method": 0,
      "goods_fee": 0,
      "discount_fee": 0,
      "handling_fee": 0,
      "pay_fee": 0,
      "total_fee": 0
    }
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK请求成功Inline

响应结构

直接渲染 Web 支付页

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/pay/web-direct-pay?trade_no=string \
  -H 'Accept: text/html' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/pay/web-direct-pay

参数

名称位置类型必填描述
team_idqueryResourceSpaceIdfalse无
trade_noquerystringtrue无
pm_idqueryintegerfalse无

响应示例

200 响应

"string"

响应

状态码含义描述数据模型
200OKHTML 支付页string

获取支付方式列表 (GET /end-point/payment/list)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/payment/list \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/payment/list

参数

名称位置类型必填描述
trade_noquerystringfalse订单号 - 部分订单需要获取特定支付方式时可传入
currencyquerystringfalse货币单位

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 0,
        "title": "string",
        "logo": "string",
        "group": "string",
        "handling_rate": 0,
        "handling_fee": 0,
        "disabled": false,
        "min": 0,
        "max": 0
      }
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK获取成功Inline

响应结构

获取支付方式列表 (GET /end-point/payment/groups)

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/payment/groups \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/payment/groups

参数

名称位置类型必填描述
trade_noquerystringfalse订单号 - 部分订单需要获取特定支付方式时可传入

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "name": "string",
        "logos": [
          "string"
        ],
        "items": [
          {
            "id": 0,
            "title": "string",
            "logo": "string",
            "group": "string",
            "disabled": false,
            "min": 0,
            "max": 0
          }
        ]
      }
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OK获取成功Inline

响应结构

营销

充值赠金比例

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/activity/balance-recharge-gift-ratio \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/activity/balance-recharge-gift-ratio

充值赠金比例

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      null
    ]
  },
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKOKInline

响应结构

产品

产品列表

代码示例

# 也可以使用 wget
curl -X GET https://api.proxylite.com/end-point/product \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /end-point/product

获取当前站点可购买的套餐列表，支持按类型、有效期等条件筛选。

参数

名称位置类型必填描述
typequeryintegerfalse套餐类型，见 Product.type 枚举说明。不传则返回所有类型。
parent_product_typequeryintegerfalse父套餐类型，仅 type=19（IP续费）时有效，用于筛选产品线：14=数据中心 25=住宅
time_daysqueryanyfalse有效期天数筛选，支持单值或数组，如 30 / [30,90,365]
show_typequeryanyfalse展示类型筛选，支持单值或数组

Detailed descriptions

type: 套餐类型，见 Product.type 枚举说明。不传则返回所有类型。

枚举值

ParameterValue
parent_product_type14
parent_product_type25

响应示例

200 响应

{
  "code": 200,
  "msg": "SUCCESS",
  "data": [
    {
      "id": 0,
      "title": "string",
      "type": 0,
      "show_type": 0,
      "status": 0,
      "price": 0.1,
      "usd_price": 0.1,
      "price_hkd": 0.1,
      "original_price": 0.1,
      "original_usd_price": 0.1,
      "original_price_hkd": 0.1,
      "local_price": 0.1,
      "local_original_price": 0.1,
      "preferred_currency": "string",
      "support_currencies": "string",
      "flow_value": 0.1,
      "flow_give": 0.1,
      "balance_give": 0.1,
      "balance_value": 0.1,
      "time_validity": 0.1,
      "time_price": 0.1,
      "time_days": 0,
      "tip1": "string",
      "tip2": "string",
      "introduce": [
        "string"
      ],
      "region_list_id": 0,
      "renew_product_list": "string",
      "parent_product_type": 0,
      "total_count": 0,
      "remain_count": 0,
      "extension_of_time_days": [
        0
      ],
      "time_days_price_rate": 0.1,
      "desc": {
        "subtitle": "string",
        "flow_value": 0.1,
        "flow_give": 0.1,
        "balance_give": 0.1,
        "time_validity": 0.1,
        "time_price": 0.1,
        "tip1": "string",
        "tip2": "string",
        "introduce": [
          "string"
        ]
      },
      "sku": {
        "bandwidth_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ],
        "duration_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ],
        "concurrency_list": [
          {
            "id": 0,
            "value": 0,
            "price": 0.1,
            "price_usd": 0.1,
            "price_hkd": 0.1
          }
        ]
      }
    }
  ],
  "request_id": "string"
}

响应

状态码含义描述数据模型
200OKOKInline

响应结构

数据结构

OpenApiAccountProfile

{
  "id": 0,
  "username": "string",
  "nickname": "string",
  "email": "string",
  "balance": "string",
  "gift_balance": "string",
  "currency": "string",
  "language": "string",
  "timezone": "string"
}

属性

名称类型必填约束描述
idintegertrue无用户 ID
usernamestringtrue无用户名
nicknamestringtrue无昵称
emailstringtrue无绑定邮箱
balancestringtrue无充值余额，十进制字符串
gift_balancestringtrue无当前赠送余额，十进制字符串
currencystringtrue无站点币种
languagestringtrue无用户语言，未配置时使用站点语言
timezonestringtrue无用户时区，未配置时使用站点时区

OpenApiBalanceRecord

{
  "id": 0,
  "re_type": 0,
  "transaction_type": 0,
  "balance_type": 0,
  "fee": "string"
}

属性

名称类型必填约束描述
idinteger,stringfalse无数据库数值可能序列化为字符串
re_typeinteger,stringfalse无0 支出，1 收入
transaction_typeinteger,stringfalse无交易类型
balance_typeinteger,stringfalse无余额类型
feestring,numberfalse无变动金额，站点币种

OpenApiLogExportTask

{
  "id": 0,
  "user_id": 0,
  "start_time": "string",
  "end_time": "string",
  "status": "pending",
  "file_size": 0,
  "record_count": 0,
  "created_at": "string",
  "completed_at": "string",
  "file_url": "string",
  "download_url": "string",
  "error_message": "string"
}

属性

名称类型必填约束描述
idinteger,stringfalse无数据库数值可能序列化为字符串
user_idinteger,stringfalse无详情接口返回
start_timestringfalse无Y-m-d H:i:s；非 RFC 3339 日期
end_timestringfalse无Y-m-d H:i:s；非 RFC 3339 日期
statusstringfalse无none
file_sizeinteger,string,nullfalse无none
record_countinteger,string,nullfalse无none
created_atstringfalse无Y-m-d H:i:s；非 RFC 3339 日期
completed_atstringfalse无Y-m-d H:i:s；非 RFC 3339 日期
file_urlstringfalse无完成后详情接口返回
download_urlstringfalse无完成后返回，有效期 24 小时的签名下载地址
error_messagestringfalse无失败时详情接口可能返回

枚举值

属性值
statuspending
statusprocessing
statuscompleted
statusfailed
statuscanceled
statusno_data

OpenApiCoupon

{
  "id": 0,
  "coupon_id": 0,
  "type": 0,
  "status": 0,
  "source": 0,
  "title": "string",
  "title_en": "string",
  "description": "string",
  "description_en": "string",
  "start_amount": "string",
  "start_amount_usd": "string",
  "start_amount_hkd": "string",
  "deduction_amount": "string",
  "deduction_amount_usd": "string",
  "deduction_amount_hkd": "string",
  "discount_rate": "string",
  "discount_ceiling_amount": "string",
  "discount_ceiling_amount_usd": "string",
  "discount_ceiling_amount_hkd": "string",
  "created_at": "string",
  "effect_at": "string",
  "expired_at": "string",
  "used_at": "string",
  "product_types": "string",
  "created_timestamp": 0,
  "effect_timestamp": 0,
  "expired_timestamp": 0,
  "used_timestamp": 0,
  "is_expired": true
}

属性

名称类型必填约束描述
idinteger,stringfalse无数据库数值可能序列化为字符串
coupon_idinteger,stringfalse无数据库数值可能序列化为字符串
typeinteger,stringfalse无数据库数值可能序列化为字符串
statusinteger,stringfalse无数据库数值可能序列化为字符串
sourceinteger,stringfalse无数据库数值可能序列化为字符串
titlestringfalse无none
title_enstringfalse无none
descriptionstringfalse无none
description_enstringfalse无none
start_amountstring,number,nullfalse无none
start_amount_usdstring,number,nullfalse无none
start_amount_hkdstring,number,nullfalse无none
deduction_amountstring,number,nullfalse无none
deduction_amount_usdstring,number,nullfalse无none
deduction_amount_hkdstring,number,nullfalse无none
discount_ratestring,number,nullfalse无none
discount_ceiling_amountstring,number,nullfalse无none
discount_ceiling_amount_usdstring,number,nullfalse无none
discount_ceiling_amount_hkdstring,number,nullfalse无none
created_atstring,nullfalse无Y-m-d H:i:s
effect_atstring,nullfalse无Y-m-d H:i:s
expired_atstring,nullfalse无Y-m-d H:i:s
used_atstring,nullfalse无Y-m-d H:i:s
product_typesstring,nullfalse无适用套餐类型
created_timestampinteger,nullfalse无none
effect_timestampinteger,nullfalse无none
expired_timestampinteger,nullfalse无none
used_timestampinteger,nullfalse无none
is_expiredbooleanfalse无列表接口返回

OpenApiNotification

{
  "id": 0,
  "title": "string",
  "content": "string",
  "type": 0,
  "read_status": 0,
  "created_at": "string",
  "created_timestamp": 0
}

属性

名称类型必填约束描述
idinteger,stringfalse无数据库数值可能序列化为字符串
titlestringfalse无none
contentstringfalse无按请求语言渲染的内容
typeinteger,stringfalse无数据库数值可能序列化为字符串
read_statusintegerfalse无none
created_atstringfalse无Y-m-d H:i:s；非 RFC 3339 日期
created_timestampintegerfalse无none

枚举值

属性值
read_status0
read_status1

productTypes

9

套餐类型，9 动态住宅流量套餐、11 动态住宅IP、14静态数据中心IP、25 静态住宅IP

属性

名称类型必填约束描述
anonymousintegerfalse无套餐类型，9 动态住宅流量套餐、11 动态住宅IP、14静态数据中心IP、25 静态住宅IP

枚举值

属性值
anonymous9
anonymous11
anonymous14
anonymous25

apiKey

"pa$$word"

API Key；使用 apiKeyAuth 或操作声明的请求参数传递

属性

名称类型必填约束描述
anonymousstring(password)false无API Key；使用 apiKeyAuth 或操作声明的请求参数传递

responseCode

200

状态码,200 成功、3 app_key 无效

属性

名称类型必填约束描述
anonymousintegerfalse无状态码,200 成功、3 app_key 无效

responseMsg

"success"

response message

属性

名称类型必填约束描述
anonymousstringfalse无response message

SuccessResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

属性

None

ErrorResponse

{
  "code": 2,
  "msg": "parameter error",
  "data": {},
  "request_id": "string"
}

属性

None

WebV1SuccessResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {},
  "request_id": "string"
}

属性

名称类型必填约束描述
codeintegertrue无none
msgstringtrue无none
dataobject,array,string,number,boolean,nulltrue无业务数据，具体类型由接口定义
request_idstringtrue无请求链路追踪 ID

WebV1ErrorResponse

{
  "code": 2,
  "msg": "parameter error",
  "data": {},
  "request_id": "string"
}

属性

名称类型必填约束描述
codeintegertrue无业务错误码

not

名称类型必填约束描述
» anonymousanyfalse无none

continued

名称类型必填约束描述
msgstringtrue无错误描述
dataobject,array,nulltrue无错误附加数据，无附加数据时为 null
request_idstringtrue无请求链路追踪 ID

TeamPublicId

"A1b2C3d4E5f6"

团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键

属性

名称类型必填约束描述
anonymousstringfalse无团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键

ResourceSpaceId

"A1b2C3d4E5f6"

公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识

属性

oneOf

名称类型必填约束描述
anonymousstringfalse无none

xor

名称类型必填约束描述
anonymousTeamPublicIdfalse无团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键

Team

{
  "id": "A1b2C3d4E5f6",
  "name": "string",
  "super_admin_user_id": 1,
  "status": 0,
  "current_role": 1,
  "dissolving_at": "string",
  "dissolved_at": "string",
  "created_at": "string",
  "updated_at": "string"
}

属性

名称类型必填约束描述
idTeamPublicIdtrue无团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
namestringtrue无团队名称
super_admin_user_idintegertrue无超级管理员用户 ID
statusintegertrue无团队状态：0=禁用，1=有效，2=解散中，3=已解散
current_roleinteger,nulltrue无当前用户在团队中的角色；无法确定时为 null
dissolving_atstring,nulltrue无开始解散时间
dissolved_atstring,nulltrue无解散完成时间
created_atstringtrue无创建时间
updated_atstringtrue无更新时间

枚举值

属性值
status0
status1
status2
status3
current_role1
current_role2
current_role3
current_role4
current_rolenull

TeamAsset

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "product_id": 1,
  "product_type": 0,
  "parent_product_type": 0,
  "status": 0,
  "total_amount": 0,
  "remain": 0,
  "bandwidth": 0,
  "concurrency": 0,
  "expired_at": "string",
  "created_at": "string",
  "ip": "string",
  "country_code": "string",
  "country_name": "string",
  "asn": "string",
  "port": 0
}

属性

名称类型必填约束描述
idintegertrue无用户套餐 ID
user_idintegertrue无资源所有人用户 ID
team_idResourceSpaceIdtrue无公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
team_user_idintegertrue无实际创建成员用户 ID
product_idintegertrue无产品 ID
product_typeintegertrue无产品类型
parent_product_typeintegertrue无父产品类型
statusintegertrue无套餐状态
total_amountinteger(int64)true无总量
remaininteger(int64)true无剩余量
bandwidthintegerfalse无带宽（Mbps）；仅 product_type=19 或 11 返回
concurrencyintegerfalse无并发数；仅 product_type=11 返回
expired_atstring,nulltrue无过期时间
created_atstringtrue无创建时间
ipstringfalse无静态 IP 地址；仅 product_type=19 返回
country_codestringfalse无静态 IP 国家代码；仅 product_type=19 返回
country_namestringfalse无静态 IP 国家名称；仅 product_type=19 返回
asnstringfalse无静态 IP ASN；仅 product_type=19 返回
portintegerfalse无静态 IP 代理端口；仅 product_type=19 返回

TeamProductInfo

{
  "team_id": "A1b2C3d4E5f6",
  "product_types": [
    0
  ],
  "product_residence_remain_count": 0,
  "product_residence_total_count": 0,
  "pdrue2_timestamp": 0,
  "remain": 0,
  "total_amount": 0,
  "scraping_remain": 0,
  "scraping_total_amount": 0,
  "scraping_timestamp": "string",
  "scraping_timestamp2": 0,
  "common_scraping_remain": 0,
  "common_scraping_total_amount": 0,
  "common_scraping_timestamp": "string",
  "common_scraping_timestamp2": 0,
  "pdidcr_count": 0,
  "pdidcr_total": 0,
  "pdidcr_traffic_remain": 0,
  "pdidcr_traffic_total": 0,
  "p_sitai_ip_count": 0,
  "p_sitai_ip": 0,
  "p_sitai_ip_total": 0,
  "p_sitai_remain": 0,
  "p_sitai_total": 0,
  "pdidc_count": 0,
  "pdidc_total": 0,
  "pdidc_ip_count": 0,
  "pdidc_ip_all_count": 0,
  "pdispr_count": 0,
  "pdispr_total": 0,
  "pdispr_traffic_remain": 0,
  "pdispr_traffic_total": 0,
  "product_datacenter_isp_traffic_ip_count": 0,
  "product_datacenter_isp_traffc_ip": 0,
  "product_datacenter_isp_traffc_ip_total": 0,
  "product_datacenter_isp_traffic_ip": 0,
  "product_datacenter_isp_traffic_ip_total": 0,
  "product_datacenter_isp_traffc_remain": 0,
  "product_datacenter_isp_traffc_total": 0,
  "product_datacenter_isp_traffic_remain": 0,
  "product_datacenter_isp_traffic_total": 0,
  "product_datacenter_isp_ip": 0,
  "product_datacenter_isp_ip_total": 0,
  "product_datacenter_isp_ip_count": 0,
  "product_datacenter_isp_ip_all_count": 0,
  "product_datacenter_isp_ip_traffic_remain": 0,
  "product_datacenter_isp_ip_traffic_total": 0,
  "product_agent_residence_remain_count": 0,
  "product_agent_residence_total_count": 0,
  "product_serp_remain": 0,
  "product_serp_total": 0,
  "product_serp_timestamp": "string",
  "product_serp_timestamp2": 0,
  "product_video_remain": 0,
  "product_video_total": 0,
  "product_video_timestamp": "string",
  "product_video_timestamp2": 0
}

套餐统计字段与 /web_v1/user/info 保持一致；取消、退款或软删除记录不计入摘要；除 team_id、product_types 外，仅返回当前站点支持产品类型对应的字段

属性

名称类型必填约束描述
team_idTeamPublicIdtrue无团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
product_types[integer]true无团队资源空间未取消、未软删除且当前站点支持的套餐类型
product_residence_remain_countinteger(int64)false无类型 9 剩余流量
product_residence_total_countinteger(int64)false无类型 9 总流量
pdrue2_timestampinteger(int64)false无类型 11 最晚过期时间戳；无团队套餐时为 0
remaininteger,stringfalse无类型 17 剩余数量
total_amountinteger,stringfalse无类型 17 总数量
scraping_remaininteger(int64)false无类型 18 剩余次数
scraping_total_amountinteger(int64)false无类型 18 总次数
scraping_timestampstringfalse无类型 18 最晚过期时间；无套餐时为 "-"
scraping_timestamp2integer(int64)false无类型 18 最晚过期时间戳
common_scraping_remaininteger(int64)false无类型 29 剩余次数
common_scraping_total_amountinteger(int64)false无类型 29 总次数
common_scraping_timestampstringfalse无类型 29 最晚过期时间；无套餐时为 "-"
common_scraping_timestamp2integer(int64)false无类型 29 最晚过期时间戳
pdidcr_countintegerfalse无类型 12 有效套餐数量
pdidcr_totalintegerfalse无类型 12 套餐总数
pdidcr_traffic_remaininteger(int64)false无类型 12 剩余流量
pdidcr_traffic_totalinteger(int64)false无类型 12 总流量
p_sitai_ip_countintegerfalse无类型 13 有效 IP 数量
p_sitai_ipintegerfalse无类型 13 有效套餐数量
p_sitai_ip_totalintegerfalse无类型 13 套餐总数
p_sitai_remaininteger(int64)false无类型 13/24 剩余流量
p_sitai_totalinteger(int64)false无类型 13/24 总流量
pdidc_countintegerfalse无类型 14 有效套餐数量
pdidc_totalintegerfalse无类型 14 套餐总数
pdidc_ip_countintegerfalse无类型 14 有效 IP 数量
pdidc_ip_all_countintegerfalse无类型 14 IP 总数
pdispr_countintegerfalse无类型 15 有效套餐数量
pdispr_totalintegerfalse无类型 15 套餐总数
pdispr_traffic_remaininteger(int64)false无类型 15 剩余流量
pdispr_traffic_totalinteger(int64)false无类型 15 总流量
product_datacenter_isp_traffic_ip_countintegerfalse无类型 16 有效 IP 数量
product_datacenter_isp_traffc_ipintegerfalse无类型 16 有效套餐数量；历史兼容拼写
product_datacenter_isp_traffc_ip_totalintegerfalse无类型 16 套餐总数；历史兼容拼写
product_datacenter_isp_traffic_ipintegerfalse无类型 16 有效套餐数量
product_datacenter_isp_traffic_ip_totalintegerfalse无类型 16 套餐总数
product_datacenter_isp_traffc_remaininteger(int64)false无类型 16/24 剩余流量；历史兼容拼写
product_datacenter_isp_traffc_totalinteger(int64)false无类型 16/24 总流量；历史兼容拼写
product_datacenter_isp_traffic_remaininteger(int64)false无类型 16/24 剩余流量
product_datacenter_isp_traffic_totalinteger(int64)false无类型 16/24 总流量
product_datacenter_isp_ipintegerfalse无类型 21 或 25 有效套餐数量
product_datacenter_isp_ip_totalintegerfalse无类型 21 或 25 套餐总数
product_datacenter_isp_ip_countintegerfalse无类型 21 或 25 有效 IP 数量
product_datacenter_isp_ip_all_countintegerfalse无类型 21 或 25 IP 总数
product_datacenter_isp_ip_traffic_remaininteger(int64)false无类型 21 对应类型 24 剩余流量
product_datacenter_isp_ip_traffic_totalinteger(int64)false无类型 21 对应类型 24 总流量
product_agent_residence_remain_countinteger(int64)false无类型 22 剩余流量
product_agent_residence_total_countinteger(int64)false无类型 22 总流量
product_serp_remaininteger(int64)false无类型 27 剩余次数
product_serp_totalinteger(int64)false无类型 27 总次数
product_serp_timestampstringfalse无类型 27 最晚过期时间；无套餐时为 "-"
product_serp_timestamp2integer(int64)false无类型 27 最晚过期时间戳
product_video_remaininteger(int64)false无类型 28 剩余流量
product_video_totalinteger(int64)false无类型 28 总流量
product_video_timestampstringfalse无类型 28 最晚过期时间；无套餐时为 "-"
product_video_timestamp2integer(int64)false无类型 28 最晚过期时间戳

TeamWallet

{
  "team_id": "A1b2C3d4E5f6",
  "balance": 0.1,
  "total_recharge_fee": 0.1,
  "updated_at": "string"
}

团队钱包，与超级管理员个人余额隔离；金额使用当前站点默认货币，最多 4 位小数。

属性

名称类型必填约束描述
team_idTeamPublicIdtrue无团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
balancenumber(double)true无当前可用团队余额
total_recharge_feenumber(double)true无当前未消费的团队充值本金，不含个人余额转入金额
updated_atstringtrue无钱包最近变更时间

TeamWalletRecord

{
  "id": 1,
  "team_id": "A1b2C3d4E5f6",
  "operator_user_id": 0,
  "creator": {
    "user_id": 0,
    "display_name": "string",
    "nickname": "string",
    "username": "string",
    "email": "string",
    "phone": "string"
  },
  "direction": 0,
  "transaction_type": 1,
  "amount": 0.1,
  "after_balance": 0.1,
  "link_id": 0,
  "request_id": "string",
  "remark": "string",
  "created_at": "string"
}

属性

名称类型必填约束描述
idintegertrue无none
team_idTeamPublicIdtrue无团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
operator_user_idintegertrue无操作人，系统退款为 0
creatorTeamCreatorfalse无none
directionintegertrue无0=支出，1=收入
transaction_typeintegertrue无1=充值入账，2=个人余额转入，3=余额消费，4=退款或充值退款扣回，5=转回个人余额
amountnumber(double)true无本次变动金额，方向由 direction 表示
after_balancenumber(double)true无变动后的团队钱包余额
link_idintegertrue无关联订单 ID；个人余额转入时为操作用户 ID
request_idstringtrue无none
remarkstringtrue无none
created_atstringtrue无none

枚举值

属性值
direction0
direction1
transaction_type1
transaction_type2
transaction_type3
transaction_type4
transaction_type5

TeamCreator

{
  "user_id": 0,
  "display_name": "string",
  "nickname": "string",
  "username": "string",
  "email": "string",
  "phone": "string"
}

属性

名称类型必填约束描述
user_idintegertrue无操作人用户 ID；系统操作为 0
display_namestringtrue无展示名称，依次取昵称、用户名、邮箱、手机号
nicknamestringtrue无none
usernamestringtrue无none
emailstringtrue无非管理员视角为脱敏值
phonestringtrue无非管理员视角为脱敏值

TeamResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": "A1b2C3d4E5f6",
    "name": "string",
    "super_admin_user_id": 1,
    "status": 0,
    "current_role": 1,
    "dissolving_at": "string",
    "dissolved_at": "string",
    "created_at": "string",
    "updated_at": "string"
  },
  "request_id": "string"
}

属性

allOf

名称类型必填约束描述
anonymousWebV1SuccessResponsefalse无none

and

名称类型必填约束描述
anonymousobjectfalse无none
» dataTeamfalse无none

TeamListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": "A1b2C3d4E5f6",
        "name": "string",
        "super_admin_user_id": 1,
        "status": 0,
        "current_role": 1,
        "dissolving_at": "string",
        "dissolved_at": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

属性

allOf

名称类型必填约束描述
anonymousWebV1SuccessResponsefalse无none

and

名称类型必填约束描述
anonymousobjectfalse无none
» dataobjectfalse无none
»» list[Team]true无none
»» totalintegertrue无none
»» pageintegertrue无none
»» page_sizeintegertrue无none

TeamMemberListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "team_member_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 1,
        "role": 1,
        "status": 0,
        "joined_at": "string",
        "nickname": "string",
        "username": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

属性

allOf

名称类型必填约束描述
anonymousWebV1SuccessResponsefalse无none

and

名称类型必填约束描述
anonymousobjectfalse无none
» dataobjectfalse无none
»» list[TeamMember]true无none
»» totalintegertrue无none
»» pageintegertrue无none
»» page_sizeintegertrue无none

TeamPersonListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "record_type": "member",
        "record_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 0,
        "inviter_user_id": 0,
        "invite_type": 0,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 0,
        "role": 1,
        "status": 0,
        "display_name": "string",
        "nickname": "string",
        "username": "string",
        "email": "string",
        "phone": "string",
        "joined_at": "string",
        "expired_at": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

属性

allOf

名称类型必填约束描述
anonymousWebV1SuccessResponsefalse无none

and

名称类型必填约束描述
anonymousobjectfalse无none
» dataobjectfalse无none
»» list[TeamPerson]true无none
»» totalintegertrue无none
»» pageintegertrue无none
»» page_sizeintegertrue无none

TeamAssetResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "user_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "team_user_id": 0,
    "product_id": 1,
    "product_type": 0,
    "parent_product_type": 0,
    "status": 0,
    "total_amount": 0,
    "remain": 0,
    "bandwidth": 0,
    "concurrency": 0,
    "expired_at": "string",
    "created_at": "string",
    "ip": "string",
    "country_code": "string",
    "country_name": "string",
    "asn": "string",
    "port": 0
  },
  "request_id": "string"
}

属性

allOf

名称类型必填约束描述
anonymousWebV1SuccessResponsefalse无none

and

名称类型必填约束描述
anonymousobjectfalse无none
» dataTeamAssetfalse无none

TeamProductInfoResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "product_types": [
      0
    ],
    "product_residence_remain_count": 0,
    "product_residence_total_count": 0,
    "pdrue2_timestamp": 0,
    "remain": 0,
    "total_amount": 0,
    "scraping_remain": 0,
    "scraping_total_amount": 0,
    "scraping_timestamp": "string",
    "scraping_timestamp2": 0,
    "common_scraping_remain": 0,
    "common_scraping_total_amount": 0,
    "common_scraping_timestamp": "string",
    "common_scraping_timestamp2": 0,
    "pdidcr_count": 0,
    "pdidcr_total": 0,
    "pdidcr_traffic_remain": 0,
    "pdidcr_traffic_total": 0,
    "p_sitai_ip_count": 0,
    "p_sitai_ip": 0,
    "p_sitai_ip_total": 0,
    "p_sitai_remain": 0,
    "p_sitai_total": 0,
    "pdidc_count": 0,
    "pdidc_total": 0,
    "pdidc_ip_count": 0,
    "pdidc_ip_all_count": 0,
    "pdispr_count": 0,
    "pdispr_total": 0,
    "pdispr_traffic_remain": 0,
    "pdispr_traffic_total": 0,
    "product_datacenter_isp_traffic_ip_count": 0,
    "product_datacenter_isp_traffc_ip": 0,
    "product_datacenter_isp_traffc_ip_total": 0,
    "product_datacenter_isp_traffic_ip": 0,
    "product_datacenter_isp_traffic_ip_total": 0,
    "product_datacenter_isp_traffc_remain": 0,
    "product_datacenter_isp_traffc_total": 0,
    "product_datacenter_isp_traffic_remain": 0,
    "product_datacenter_isp_traffic_total": 0,
    "product_datacenter_isp_ip": 0,
    "product_datacenter_isp_ip_total": 0,
    "product_datacenter_isp_ip_count": 0,
    "product_datacenter_isp_ip_all_count": 0,
    "product_datacenter_isp_ip_traffic_remain": 0,
    "product_datacenter_isp_ip_traffic_total": 0,
    "product_agent_residence_remain_count": 0,
    "product_agent_residence_total_count": 0,
    "product_serp_remain": 0,
    "product_serp_total": 0,
    "product_serp_timestamp": "string",
    "product_serp_timestamp2": 0,
    "product_video_remain": 0,
    "product_video_total": 0,
    "product_video_timestamp": "string",
    "product_video_timestamp2": 0
  },
  "request_id": "string"
}

属性

allOf

名称类型必填约束描述
anonymousWebV1SuccessResponsefalse无none

and

名称类型必填约束描述
anonymousobjectfalse无none
» dataTeamProductInfofalse无套餐统计字段与 /web_v1/user/info 保持一致；取消、退款或软删除记录不计入摘要；除 team_id、product_types 外，仅返回当前站点支持产品类型对应的字段

TeamWalletResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_id": "A1b2C3d4E5f6",
    "balance": 0.1,
    "total_recharge_fee": 0.1,
    "updated_at": "string"
  },
  "request_id": "string"
}

属性

allOf

名称类型必填约束描述
anonymousWebV1SuccessResponsefalse无none

and

名称类型必填约束描述
anonymousobjectfalse无none
» dataTeamWalletfalse无团队钱包，与超级管理员个人余额隔离；金额使用当前站点默认货币，最多 4 位小数。

TeamWalletRecordListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "operator_user_id": 0,
        "creator": {
          "user_id": 0,
          "display_name": "string",
          "nickname": "string",
          "username": "string",
          "email": "string",
          "phone": "string"
        },
        "direction": 0,
        "transaction_type": 1,
        "amount": 0.1,
        "after_balance": 0.1,
        "link_id": 0,
        "request_id": "string",
        "remark": "string",
        "created_at": "string"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

属性

allOf

名称类型必填约束描述
anonymousWebV1SuccessResponsefalse无none

and

名称类型必填约束描述
anonymousobjectfalse无none
» dataobjectfalse无none
»» list[TeamWalletRecord]true无none
»» totalintegertrue无none
»» pageintegertrue无none
»» page_sizeintegertrue无none

TeamAssetListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "user_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "team_user_id": 0,
        "product_id": 1,
        "product_type": 0,
        "parent_product_type": 0,
        "status": 0,
        "total_amount": 0,
        "remain": 0,
        "bandwidth": 0,
        "concurrency": 0,
        "expired_at": "string",
        "created_at": "string",
        "ip": "string",
        "country_code": "string",
        "country_name": "string",
        "asn": "string",
        "port": 0
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

属性

allOf

名称类型必填约束描述
anonymousWebV1SuccessResponsefalse无none

and

名称类型必填约束描述
anonymousobjectfalse无none
» dataobjectfalse无none
»» list[TeamAsset]true无none
»» totalintegertrue无none
»» pageintegertrue无none
»» page_sizeintegertrue无none

UserApiKeyMetadata

{
  "id": 1,
  "api_key": "string",
  "team_user_id": 0,
  "remark": "string",
  "status": 0,
  "created_at": "string",
  "updated_at": "string"
}

属性

名称类型必填约束描述
idintegertrue无API Key ID
api_keystringtrue无创建响应为完整 Key；团队列表中为脱敏值
team_user_idintegertrue无团队 Key 实际持有成员 ID，个人 Key 为 0
remarkstringtrue无备注
statusintegertrue无0=停用，1=启用
created_atstringtrue无创建时间
updated_atstring,nullfalse无更新时间

枚举值

属性值
status0
status1

InvoiceInfo

{
  "invoice_code": "string",
  "name": "string",
  "org_name": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "email": "[email protected]",
  "role_type": 1,
  "invoice_type": 0,
  "vat_id": "string",
  "tax_no": "string",
  "address_country": "string",
  "address_city": "string",
  "address_line1": "string",
  "address_line2": "string",
  "address_postal_code": "string",
  "bank_name": "string",
  "bank_account": "string",
  "is_def": true
}

属性

名称类型必填约束描述
invoice_codestringfalse无none
namestringfalse无none
org_namestringfalse无none
first_namestringfalse无none
last_namestringfalse无none
phonestringfalse无none
emailstring(email)false无none
role_typeintegerfalse无none
invoice_typeintegerfalse无none
vat_idstringfalse无none
tax_nostringfalse无none
address_countrystringfalse无none
address_citystringfalse无none
address_line1stringfalse无none
address_line2stringfalse无none
address_postal_codestringfalse无none
bank_namestringfalse无none
bank_accountstringfalse无none
is_defbooleanfalse无none

枚举值

属性值
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

MonthlyRenewalRequest

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [
    1
  ],
  "user_coupon_id": 1,
  "coupon_sn": "string"
}

属性

名称类型必填约束描述
team_idResourceSpaceIdfalse无公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
user_product_idsanytrue无用户套餐 ID 数组，也兼容英文逗号分隔字符串

oneOf

名称类型必填约束描述
» anonymous[integer]false无none

xor

名称类型必填约束描述
» anonymousstringfalse无none

continued

名称类型必填约束描述
user_coupon_idintegerfalse无none
coupon_snstringfalse无none

TeamInvitation

{
  "id": 1,
  "team_id": "A1b2C3d4E5f6",
  "inviter_user_id": 1,
  "invitee_user_id": 0,
  "invite_type": 1,
  "invite_country_code": 999,
  "invite_target": "string",
  "delivery_type": 1,
  "role": 2,
  "status": 0,
  "accepted_by_user_id": 0,
  "expired_at": "2026-07-17 10:00:00",
  "accepted_at": null,
  "rejected_at": null,
  "cancelled_at": null,
  "created_at": "2026-07-10 10:00:00"
}

属性

名称类型必填约束描述
idintegertrue无邀请 ID
team_idTeamPublicIdtrue无团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
inviter_user_idintegertrue无邀请人用户 ID
invitee_user_idintegertrue无受邀用户 ID，尚未匹配注册用户时为 0
invite_typeintegertrue无邀请类型：1=已注册用户，2=邮箱，3=手机号
invite_country_codeintegertrue无手机号国家或地区码，非手机号邀请为 0
invite_targetstringtrue无标准化后的邀请目标；已注册用户为 user:{user_id}
delivery_typeintegertrue无原始投递渠道：1=已注册用户，2=邮箱，3=手机号；邮箱或手机号匹配到已注册用户时仍保留原渠道
roleintegertrue无目标角色：2=管理员，3=普通成员
statusintegertrue无邀请状态：0=待处理，1=已接受，2=已拒绝，3=已取消，4=已过期
accepted_by_user_idintegertrue无接受人用户 ID，未接受时为 0
expired_atstringtrue无过期时间，格式 YYYY-MM-DD HH:mm:ss
accepted_atstring,nulltrue无接受时间
rejected_atstring,nulltrue无拒绝时间
cancelled_atstring,nulltrue无取消时间
created_atstringtrue无创建时间，格式 YYYY-MM-DD HH:mm:ss

枚举值

属性值
invite_type1
invite_type2
invite_type3
delivery_type1
delivery_type2
delivery_type3
role2
role3
status0
status1
status2
status3
status4

TeamMember

{
  "team_member_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "user_id": 1,
  "role": 1,
  "status": 0,
  "joined_at": "string",
  "nickname": "string",
  "username": "string"
}

属性

名称类型必填约束描述
team_member_idintegertrue无成员关系 ID
team_idTeamPublicIdtrue无团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
user_idintegertrue无成员用户 ID
roleintegertrue无角色：1=超级管理员，2=管理员，3=普通成员，4=财务成员
statusintegertrue无成员状态：0=禁用，1=有效，2=已退出，3=已移除
joined_atstring,nulltrue无加入时间，格式 YYYY-MM-DD HH:mm:ss
nicknamestringtrue无成员昵称
usernamestringtrue无成员用户名

枚举值

属性值
role1
role2
role3
role4
status0
status1
status2
status3

TeamPerson

{
  "record_type": "member",
  "record_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "user_id": 0,
  "inviter_user_id": 0,
  "invite_type": 0,
  "invite_country_code": 999,
  "invite_target": "string",
  "delivery_type": 0,
  "role": 1,
  "status": 0,
  "display_name": "string",
  "nickname": "string",
  "username": "string",
  "email": "string",
  "phone": "string",
  "joined_at": "string",
  "expired_at": "string",
  "created_at": "string"
}

属性

名称类型必填约束描述
record_typestringtrue无记录类型；member 为有效成员，invitation 为待处理邀请
record_idintegertrue无成员关系 ID 或邀请 ID
team_idTeamPublicIdtrue无团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
user_idintegertrue无用户 ID，未注册受邀用户为 0
inviter_user_idintegertrue无邀请人用户 ID，成员记录为 0
invite_typeintegertrue无邀请类型，成员记录为 0
invite_country_codeintegertrue无手机号国家或地区码，成员记录为 0
invite_targetstringtrue无邀请目标，成员记录为空字符串
delivery_typeintegertrue无原始投递渠道，成员记录为 0
roleintegertrue无角色：1=超级管理员，2=管理员，3=普通成员，4=财务成员
statusintegertrue无member 固定为 1，invitation 固定为 0
display_namestringtrue无统一展示名称，依次取昵称、用户名、邮箱、手机号；普通成员视角下联系方式使用脱敏值
nicknamestringtrue无成员或已注册受邀用户昵称
usernamestringtrue无成员或已注册受邀用户名
emailstringtrue无邮箱；超级管理员和管理员返回完整值，普通成员返回带星号的脱敏值
phonestringtrue无手机号；超级管理员和管理员返回完整值，普通成员返回带星号的脱敏值
joined_atstring,nulltrue无成员加入时间，邀请记录为 null
expired_atstring,nulltrue无邀请过期时间，成员记录为 null
created_atstringtrue无记录创建时间，格式 YYYY-MM-DD HH:mm:ss

枚举值

属性值
record_typemember
record_typeinvitation
invite_type0
invite_type1
invite_type2
invite_type3
delivery_type0
delivery_type1
delivery_type2
delivery_type3
role1
role2
role3
role4
status0
status1

TeamInvitationResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "id": 1,
    "team_id": "A1b2C3d4E5f6",
    "inviter_user_id": 1,
    "invitee_user_id": 0,
    "invite_type": 1,
    "invite_country_code": 999,
    "invite_target": "string",
    "delivery_type": 1,
    "role": 2,
    "status": 0,
    "accepted_by_user_id": 0,
    "expired_at": "2026-07-17 10:00:00",
    "accepted_at": null,
    "rejected_at": null,
    "cancelled_at": null,
    "created_at": "2026-07-10 10:00:00"
  },
  "request_id": "string"
}

属性

allOf

名称类型必填约束描述
anonymousWebV1SuccessResponsefalse无none

and

名称类型必填约束描述
anonymousobjectfalse无none
» dataTeamInvitationfalse无none

TeamMemberResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_member_id": 1,
    "team_id": "A1b2C3d4E5f6",
    "user_id": 1,
    "role": 1,
    "status": 0,
    "joined_at": "string",
    "nickname": "string",
    "username": "string"
  },
  "request_id": "string"
}

属性

allOf

名称类型必填约束描述
anonymousWebV1SuccessResponsefalse无none

and

名称类型必填约束描述
anonymousobjectfalse无none
» dataTeamMemberfalse无none

TeamInvitationCreateResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

属性

allOf

名称类型必填约束描述
anonymousWebV1SuccessResponsefalse无none

and

名称类型必填约束描述
anonymousobjectfalse无none
» dataobjectfalse无none
»» invitationTeamInvitationtrue无none
»» invitation_tokenstringtrue无明文邀请令牌，仅为兼容既有客户端保留；新客户端直接使用 invitation_url
»» invitation_urlstring(uri)true无包含邀请令牌的前端处理链接
»» notification_channelsTeamInvitationNotificationChannelstrue无none

TeamInvitationNotificationChannels

{
  "email": "queued",
  "sms": "queued",
  "site_inner_message": "created"
}

属性

名称类型必填约束描述
emailstringfalse无邮件渠道结果
smsstringfalse无短信渠道结果
site_inner_messagestringfalse无站内信渠道结果

枚举值

属性值
emailqueued
emailfailed
emailskipped
smsqueued
smsfailed
smsskipped
site_inner_messagecreated
site_inner_messageexists
site_inner_messagefailed

TeamInvitationPreviewResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "team_name": "string",
    "role": 2,
    "status": 0,
    "expired_at": "string"
  },
  "request_id": "string"
}

属性

allOf

名称类型必填约束描述
anonymousWebV1SuccessResponsefalse无none

and

名称类型必填约束描述
anonymousobjectfalse无none
» dataobjectfalse无none
»» team_namestringtrue无团队名称
»» roleintegertrue无目标角色
»» statusintegertrue无邀请状态
»» expired_atstringtrue无过期时间，格式 YYYY-MM-DD HH:mm:ss

枚举值

属性值
role2
role3
status0
status1
status2
status3
status4

TeamInvitationResendResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": 1,
      "team_id": "A1b2C3d4E5f6",
      "inviter_user_id": 1,
      "invitee_user_id": 0,
      "invite_type": 1,
      "invite_country_code": 999,
      "invite_target": "string",
      "delivery_type": 1,
      "role": 2,
      "status": 0,
      "accepted_by_user_id": 0,
      "expired_at": "2026-07-17 10:00:00",
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": "2026-07-10 10:00:00"
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": "queued",
      "sms": "queued",
      "site_inner_message": "created"
    }
  },
  "request_id": "string"
}

属性

allOf

名称类型必填约束描述
anonymousWebV1SuccessResponsefalse无none

and

名称类型必填约束描述
anonymousobjectfalse无none
» dataobjectfalse无none
»» invitationTeamInvitationtrue无none
»» invitation_urlstring(uri)true无新的邀请处理链接；旧链接已失效
»» notification_channelsTeamInvitationNotificationChannelstrue无none

TeamInvitationListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "inviter_user_id": 1,
        "invitee_user_id": 0,
        "invite_type": 1,
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": 1,
        "role": 2,
        "status": 0,
        "accepted_by_user_id": 0,
        "expired_at": "2026-07-17 10:00:00",
        "accepted_at": null,
        "rejected_at": null,
        "cancelled_at": null,
        "created_at": "2026-07-10 10:00:00"
      }
    ],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

属性

allOf

名称类型必填约束描述
anonymousWebV1SuccessResponsefalse无none

and

名称类型必填约束描述
anonymousobjectfalse无none
» dataobjectfalse无none
»» list[TeamInvitation]true无none
»» totalintegertrue无邀请总数
»» pageintegertrue无当前页码
»» page_sizeintegertrue无实际每页数量

User

{
  "id": 0,
  "email": "[email protected]",
  "phone": "string",
  "balance": 0.1,
  "status": 0,
  "is_real_name": true,
  "created_at": "2019-08-24T14:15:22Z"
}

属性

名称类型必填约束描述
idintegerfalse无none
emailstring(email)false无none
phonestringfalse无none
balancenumber(float)false无none
statusintegerfalse无none
is_real_namebooleanfalse无none
created_atstring(date-time)false无none

Order

{
  "id": 0,
  "trade_no": "string",
  "out_trade_no": "string",
  "product_id": 0,
  "product_type": 0,
  "amount": 0,
  "unit_price": 0.1,
  "total_fee": 0.1,
  "goods_fee": 0.1,
  "pay_fee": 0.1,
  "discount_fee": 0.1,
  "handling_fee": 0.1,
  "refund_fee": 0.1,
  "pm_id": 0,
  "pm_title": "string",
  "pm_logo": "string",
  "status": 0,
  "title": "string",
  "detail": "string",
  "region_desc": "string",
  "pay_at": "2019-08-24T14:15:22Z",
  "pay_timestamp": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "pay_fee_status": 0,
  "invoice": {
    "name": "string",
    "org_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "email": "[email protected]",
    "role_type": 0,
    "vat_id": "string",
    "address_country": "string",
    "address_city": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string"
  }
}

属性

名称类型必填约束描述
idintegerfalse无订单ID
trade_nostringfalse无内部订单编号
out_trade_nostringfalse无外部订单编号
product_idintegerfalse无套餐ID
product_typeintegerfalse无套餐类型，见产品类型枚举
amountintegerfalse无购买数量
unit_pricenumber(float)false无单价
total_feenumber(float)false无订单总价（不含折扣，含手续费）
goods_feenumber(float)false无商品价格（含折扣，不含手续费）
pay_feenumber(float)false无实付金额（含折扣，含手续费）
discount_feenumber(float)false无优惠金额
handling_feenumber(float)false无手续费
refund_feenumber(float)false无退款金额
pm_idintegerfalse无支付方式ID（来自 /openapi/payment/list）
pm_titlestringfalse无支付方式名称
pm_logostringfalse无支付方式Logo URL
statusintegerfalse无订单状态
titlestringfalse无套餐标题
detailstringfalse无套餐描述
region_descstringfalse无地区规格描述
pay_atstring(date-time)false无支付时间
pay_timestampintegerfalse无支付时间戳
created_atstring(date-time)false无创建时间
pay_fee_statusintegerfalse无长短款状态：0正常 1长款（超额支付） 2短款
invoiceobjectfalse无发票信息（仅线上支付订单有值）
» namestringfalse无全名
» org_namestringfalse无企业名称
» first_namestringfalse无none
» last_namestringfalse无none
» phonestringfalse无none
» emailstring(email)false无none
» role_typeintegerfalse无1个人 2企业
» vat_idstringfalse无税号
» address_countrystringfalse无none
» address_citystringfalse无none
» address_line1stringfalse无none
» address_line2stringfalse无none
» address_postal_codestringfalse无none

OrderCheckResult

{
  "product_id": 0,
  "amount": 0,
  "discount_fee": 0.1,
  "total_fee": 0.1,
  "pay_fee": 0.1,
  "product_type": 0,
  "title": "string",
  "detail": "string",
  "ip_result": [
    {
      "ip": "string",
      "price": 0.1,
      "country_code": "string",
      "current_time": "2019-08-24T14:15:22Z",
      "renewal_time": "2019-08-24T14:15:22Z",
      "country": {
        "name_zh_cn": "string",
        "flag": "string",
        "square_flag": "string"
      }
    }
  ]
}

订单预检结果

属性

名称类型必填约束描述
product_idintegerfalse无套餐ID
amountintegerfalse无数量
discount_feenumber(float)false无优惠金额
total_feenumber(float)false无订单总额
pay_feenumber(float)false无实付金额
product_typeintegerfalse无套餐类型
titlestringfalse无套餐标题
detailstringfalse无套餐描述
ip_result[object]false无IP批量续费结果（仅IP续费时返回）
» ipstringfalse无none
» pricenumber(float)false无none
» country_codestringfalse无none
» current_timestring(date-time)false无none
» renewal_timestring(date-time)false无none
» countryobjectfalse无none
»» name_zh_cnstringfalse无none
»» flagstringfalse无圆形旗帜URL
»» square_flagstringfalse无方形旗帜URL

Product

{
  "id": 0,
  "title": "string",
  "type": 0,
  "show_type": 0,
  "status": 0,
  "price": 0.1,
  "usd_price": 0.1,
  "price_hkd": 0.1,
  "original_price": 0.1,
  "original_usd_price": 0.1,
  "original_price_hkd": 0.1,
  "local_price": 0.1,
  "local_original_price": 0.1,
  "preferred_currency": "string",
  "support_currencies": "string",
  "flow_value": 0.1,
  "flow_give": 0.1,
  "balance_give": 0.1,
  "balance_value": 0.1,
  "time_validity": 0.1,
  "time_price": 0.1,
  "time_days": 0,
  "tip1": "string",
  "tip2": "string",
  "introduce": [
    "string"
  ],
  "region_list_id": 0,
  "renew_product_list": "string",
  "parent_product_type": 0,
  "total_count": 0,
  "remain_count": 0,
  "extension_of_time_days": [
    0
  ],
  "time_days_price_rate": 0.1,
  "desc": {
    "subtitle": "string",
    "flow_value": 0.1,
    "flow_give": 0.1,
    "balance_give": 0.1,
    "time_validity": 0.1,
    "time_price": 0.1,
    "tip1": "string",
    "tip2": "string",
    "introduce": [
      "string"
    ]
  },
  "sku": {
    "bandwidth_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ],
    "duration_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ],
    "concurrency_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ]
  }
}

属性

名称类型必填约束描述
idintegerfalse无套餐ID
titlestringfalse无套餐主标题
typeintegerfalse无套餐类型
show_typeintegerfalse无展示类型：1普通 2大额推荐 3不可购买（需定制） 4试用
statusintegerfalse无状态：1上架 0下架
pricenumber(float)false无人民币价格
usd_pricenumber(float)false无美元价格
price_hkdnumber(float)false无港币价格
original_pricenumber(float)false无原价（CNY）
original_usd_pricenumber(float)false无原价（USD）
original_price_hkdnumber(float)false无原价（HKD）
local_pricenumber(float)false无本地化价格（依赖 preferred_currency）
local_original_pricenumber(float)false无本地化原价（依赖 preferred_currency）
preferred_currencystringfalse无推荐显示货币，如 usd / cny / hkd
support_currenciesstringfalse无支持的货币列表，逗号分隔，如 usd,cny
flow_valuenumber(float)false无流量套餐默认流量（GB）
flow_givenumber(float)false无赠送流量（GB）
balance_givenumber(float)false无余额充值赠送金额
balance_valuenumber(float)false无充值金额
time_validitynumber(float)false无包量套餐默认有效时长
time_pricenumber(float)false无包量套餐每IP价格
time_daysintegerfalse无有效期天数，如 30/90/180/365
tip1stringfalse无标签说明1
tip2stringfalse无标签说明2
introduce[string]false无文本介绍列表
region_list_idintegerfalse无地区ID
renew_product_liststringfalse无可续订套餐ID列表（逗号分隔）
parent_product_typeintegerfalse无父套餐类型（type=19时有效）：14或25
total_countintegerfalse无总库存，0表示不限制
remain_countintegerfalse无剩余库存
extension_of_time_days[integer]false无时长倍数列表，为空或仅含1表示不支持
time_days_price_ratenumber(float)false无时长价格系数，价格 × (1 + (倍数-1) × rate)
descobjectfalse无套餐描述信息
» subtitlestringfalse无副标题
» flow_valuenumber(float)false无none
» flow_givenumber(float)false无none
» balance_givenumber(float)false无none
» time_validitynumber(float)false无none
» time_pricenumber(float)false无none
» tip1stringfalse无none
» tip2stringfalse无none
» introduce[string]false无none
skuobjectfalse无规格参数（type=11时返回）
» bandwidth_list[object]false无带宽规格列表
»» idintegerfalse无none
»» valueintegerfalse无带宽值（Mbps）
»» pricenumber(float)false无none
»» price_usdnumber(float)false无none
»» price_hkdnumber(float)false无none
» duration_list[object]false无时长规格列表
»» idintegerfalse无none
»» valueintegerfalse无时长（天）
»» pricenumber(float)false无none
»» price_usdnumber(float)false无none
»» price_hkdnumber(float)false无none
» concurrency_list[object]false无并发规格列表
»» idintegerfalse无none
»» valueintegerfalse无并发数
»» pricenumber(float)false无none
»» price_usdnumber(float)false无none
»» price_hkdnumber(float)false无none

WhiteIp

{
  "id": 0,
  "ip": "string",
  "remark": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

属性

名称类型必填约束描述
idintegerfalse无none
ipstringfalse无none
remarkstringfalse无none
created_atstring(date-time)false无none

WhitelistAccount

{
  "id": 0,
  "username": "string",
  "limit": 0,
  "used": 0,
  "status": 0
}

属性

名称类型必填约束描述
idintegerfalse无none
usernamestringfalse无none
limitintegerfalse无none
usedintegerfalse无none
statusintegerfalse无none

Coupon

{
  "id": 0,
  "name": "string",
  "code": "string",
  "discount": 0.1,
  "expire_time": "2019-08-24T14:15:22Z"
}

属性

名称类型必填约束描述
idintegerfalse无none
namestringfalse无none
codestringfalse无none
discountnumber(float)false无none
expire_timestring(date-time)false无none

Article

{
  "id": 0,
  "title": "string",
  "content": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

属性

名称类型必填约束描述
idintegerfalse无none
titlestringfalse无none
contentstringfalse无none
created_atstring(date-time)false无none

Pagination

{
  "total": 0,
  "page_no": 0,
  "page_size": 0,
  "total_pages": 0
}

属性

名称类型必填约束描述
totalintegerfalse无none
page_nointegerfalse无none
page_sizeintegerfalse无none
total_pagesintegerfalse无none

AutoRenewalConfig

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "product_type": 0,
  "left_traffic": 0,
  "left_days": 0,
  "user_product_id": 1,
  "product_id": 0,
  "status": 0,
  "currency": "string",
  "agreed_price": 0,
  "agreed_bandwidth_price": 0,
  "agreed_concurrency_price": 0,
  "bandwidth_id": 0,
  "concurrency_id": 0,
  "duration": 0,
  "renew_product_id": 0,
  "days_before_expire": 0,
  "traffic_threshold": 0,
  "parent_product_type": 0,
  "created_at": "string",
  "updated_at": "string"
}

单个套餐的自动续费配置快照

属性

名称类型必填约束描述
idintegerfalse无none
user_idintegerfalse无none
team_idResourceSpaceIdfalse无公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
team_user_idintegerfalse无none
product_typeintegerfalse无none
left_trafficintegerfalse无已废弃字段
left_daysintegerfalse无已废弃字段
user_product_idintegerfalse无none
product_idintegerfalse无已废弃字段
statusintegerfalse无0=停用，1=启用
currencystringfalse无none
agreed_pricenumberfalse无约定总价
agreed_bandwidth_pricenumberfalse无套餐 11 的约定带宽单价
agreed_concurrency_pricenumberfalse无套餐 11 的约定并发单价
bandwidth_idintegerfalse无none
concurrency_idintegerfalse无none
durationintegerfalse无续费时长，单位天
renew_product_idintegerfalse无none
days_before_expireintegerfalse无none
traffic_thresholdintegerfalse无流量阈值，数据库值单位 KB
parent_product_typeintegerfalse无none
created_atstringfalse无none
updated_atstringfalse无none

枚举值

属性值
status0
status1

AutoRenewalLog

{
  "id": 1,
  "user_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "team_user_id": 0,
  "config_id": 0,
  "user_product_id": 1,
  "product_type": 0,
  "renew_product_id": 0,
  "order_id": 0,
  "fee": 0,
  "currency": "string",
  "before_expired_at": "string",
  "after_expired_at": "string",
  "before_remain": 0,
  "after_remain": 0,
  "trigger_type": 0,
  "status": 1,
  "revoke_at": "string",
  "revoke_remark": "string",
  "created_at": "string",
  "updated_at": "string"
}

属性

名称类型必填约束描述
idintegertrue无none
user_idintegertrue无none
team_idResourceSpaceIdtrue无公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
team_user_idintegertrue无none
config_idintegertrue无none
user_product_idintegertrue无none
product_typeintegertrue无none
renew_product_idintegertrue无none
order_idintegertrue无none
feenumbertrue无none
currencystringtrue无none
before_expired_atstring,nullfalse无none
after_expired_atstring,nullfalse无none
before_remaininteger(int64)true无none
after_remaininteger(int64)true无none
trigger_typeintegertrue无0=到期前，1=流量不足
statusintegertrue无1=成功，2=已撤销，3=失败
revoke_atstring,nullfalse无none
revoke_remarkstringtrue无none
created_atstringtrue无none
updated_atstringtrue无none

枚举值

属性值
trigger_type0
trigger_type1
status1
status2
status3

MonthlyRenewalBatch

{
  "type": "current",
  "start_at": "string",
  "end_at": "string",
  "target_expired_at": "string",
  "timezone": "string"
}

属性

名称类型必填约束描述
typestringtrue无none
start_atstringtrue无none
end_atstringtrue无none
target_expired_atstringtrue无none
timezonestringtrue无none

枚举值

属性值
typecurrent
typenext

MonthlyRenewalItem

{
  "id": 0,
  "user_product_id": 1,
  "product_id": 1,
  "product_type": 0,
  "parent_product_type": 0,
  "title": "string",
  "expired_at": "string",
  "target_expired_at": "string",
  "renew_days": 1,
  "unit_month_price": 0,
  "pay_fee": 0,
  "currency": "string",
  "bandwidth": 0,
  "bandwidth_mbsp": 0,
  "concurrency": 0,
  "ip": "string",
  "country_code": "string",
  "paid_at": "string",
  "refunded_at": "string",
  "created_at": "string",
  "updated_at": "string"
}

属性

名称类型必填约束描述
idintegerfalse无历史账单明细 ID
user_product_idintegertrue无none
product_idintegertrue无none
product_typeintegertrue无none
parent_product_typeintegertrue无none
titlestringtrue无none
expired_atstringtrue无none
target_expired_atstringtrue无none
renew_daysintegertrue无none
unit_month_pricenumberfalse无none
pay_feenumbertrue无none
currencystringtrue无none
bandwidthintegerfalse无none
bandwidth_mbspnumberfalse无带宽换算值
concurrencyintegerfalse无none
ipstringfalse无静态 IP 套餐返回
country_codestringfalse无静态 IP 套餐返回
paid_atstring,nullfalse无none
refunded_atstring,nullfalse无none
created_atstringfalse无none
updated_atstringfalse无none

InvoiceRecord

{
  "id": 1,
  "invoice_no": "string",
  "invoice_amount": 0,
  "invoice_download_url": "string",
  "status": 0,
  "remark": "string",
  "order_ids": [
    0
  ],
  "created_at": 0,
  "invoice_info": {
    "invoice_code": "string",
    "name": "string",
    "org_name": "string",
    "role_type": 1,
    "invoice_type": 0
  }
}

属性

名称类型必填约束描述
idintegertrue无none
invoice_nostringtrue无none
invoice_amountnumbertrue无none
invoice_download_urlstringtrue无none
statusintegertrue无none
remarkstringtrue无none
order_ids[integer]true无none
created_atintegertrue无Unix 时间戳
invoice_infoanytrue无none

oneOf

名称类型必填约束描述
» anonymousobjectfalse无none
»» invoice_codestringtrue无none
»» namestringtrue无none
»» org_namestringtrue无none
»» role_typeintegertrue无none
»» invoice_typeintegertrue无none

xor

名称类型必填约束描述
» anonymousnullfalse无none

枚举值

属性值
role_type1
role_type2
invoice_type0
invoice_type1
invoice_type2

PayCheckData

{
  "trade_no": "string",
  "pm_id": 0,
  "pay_method": 0,
  "trade_type": "string",
  "country_code": "string",
  "currency": "string",
  "goods_fee": 0,
  "discount_fee": 0,
  "handling_fee": 0,
  "pay_fee": 0,
  "total_fee": 0,
  "pay_method_info": {
    "id": 0,
    "type": 0,
    "title": "string",
    "group": "string",
    "handling_rate": 0,
    "handling_fee": 0,
    "handling_fee_currency": "usd",
    "handling_fee_converted": 0
  },
  "origin": {
    "pm_id": 0,
    "pay_method": 0,
    "goods_fee": 0,
    "discount_fee": 0,
    "handling_fee": 0,
    "pay_fee": 0,
    "total_fee": 0
  }
}

属性

名称类型必填约束描述
trade_nostringtrue无none
pm_idintegertrue无none
pay_methodintegertrue无none
trade_typestringtrue无none
country_codestringtrue无none
currencystringtrue无none
goods_feenumbertrue无none
discount_feenumbertrue无none
handling_feenumbertrue无none
pay_feenumbertrue无none
total_feenumbertrue无none
pay_method_infoanytrue无none

oneOf

名称类型必填约束描述
» anonymousobjectfalse无none
»» idintegertrue无none
»» typeintegertrue无none
»» titlestringtrue无none
»» groupstringtrue无none
»» handling_ratenumbertrue无none
»» handling_feenumbertrue无none
»» handling_fee_currencystringtrue无none
»» handling_fee_convertednumbertrue无none

xor

名称类型必填约束描述
» anonymousnullfalse无none

continued

名称类型必填约束描述
originobjecttrue无none
» pm_idintegertrue无none
» pay_methodintegertrue无none
» goods_feenumbertrue无none
» discount_feenumbertrue无none
» handling_feenumbertrue无none
» pay_feenumbertrue无none
» total_feenumbertrue无none