NSocks

支持通过站点 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 为准。

Base URLs: "https://api.nsocks.com"

Authentication

HTTP Authentication, scheme: bearer

API Key (apiKeyAuth2)
- Parameter Name: app_key, in: query. 个人或团队 API Key。推荐查询参数 app_key；也兼容 key/appkey/openid 及 POST 请求体。团队 Key 只能访问绑定团队的受支持接口。

API Key 管理

GET API Key 列表

GET /ep/api-keys

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	资源空间标识；个人空间省略或传空字符串
page	query	integer	否	none
pageSize	query	integer	否	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	none
» msg	string	true	none	none
» request_id	string	true	none	none
» data	object	true	none	none
»» list	[UserApiKeyMetadata]	true	none	none
»»» id	integer	true	none	API Key ID
»»» api_key	string	true	none	创建响应为完整 Key；团队列表中为脱敏值
»»» team_user_id	integer	true	none	团队 Key 实际持有成员 ID，个人 Key 为 0
»»» remark	string	true	none	备注
»»» status	integer	true	none	0=停用，1=启用
»»» created_at	string	true	none	创建时间
»»» updated_at	string¦null	false	none	更新时间
»» total	integer	true	none	none
»» page	integer	true	none	none
»» pageSize	integer	true	none	none

枚举值

属性	值
status	0
status	1

POST 创建 API Key

POST /ep/api-keys/create

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» remark	body	string	否	none

返回示例

200 Response

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

返回结果

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

返回数据结构

枚举值

属性	值
status	0
status	1

POST 启用 API Key

POST /ep/api-keys/enable

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	ApiKeyManageRequest	是	none

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

POST 停用 API Key

POST /ep/api-keys/disable

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	ApiKeyManageRequest	是	none

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

POST 删除 API Key

POST /ep/api-keys/delete

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	ApiKeyManageRequest	是	none

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

POST 修改 API Key 备注

POST /ep/api-keys/update-remark

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» id	body	integer	是	none
» remark	body	string	是	none

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

团队管理

POST 创建团队

POST /ep/team/create

Body 请求参数

{
  "name": "string"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» name	body	string	是	团队名称

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

返回数据结构

枚举值

属性	值
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

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

GET /ep/team/list

请求参数

名称	位置	类型	必选	说明
page	query	integer	否	none
page_size	query	integer	否	none

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

返回数据结构

枚举值

属性	值
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

GET 团队详情

GET /ep/team/detail

请求参数

名称	位置	类型	必选	说明
team_id	query	TeamPublicId	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

返回数据结构

枚举值

属性	值
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

POST 修改团队名称

POST /ep/team/update-name

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	TeamPublicId	是	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» name	body	string	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

返回数据结构

枚举值

属性	值
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

POST 解散团队

POST /ep/team/dissolve

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

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	TeamPublicId	是	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» name	body	string	是	团队名称确认，必须与团队当前名称完全一致
» verify_type	body	string	否	二次验证方式；需要验证时与 verify_code 一起提交
» verify_code	body	string	否	二次验证码；处于 15 分钟信任状态时可不传

枚举值

属性	值
» verify_type	phone
» verify_type	email
» verify_type	wechat
» verify_type	totp

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

返回数据结构

枚举值

属性	值
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

GET 查询团队解散状态

GET /ep/team/dissolve-status

请求参数

名称	位置	类型	必选	说明
team_id	query	TeamPublicId	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

返回数据结构

枚举值

属性	值
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

团队资产

GET 团队套餐信息

GET /ep/team/product-info

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

请求参数

名称	位置	类型	必选	说明
team_id	query	TeamPublicId	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

GET 团队资产列表

GET /ep/team/assets

请求参数

名称	位置	类型	必选	说明
team_id	query	TeamPublicId	是	none
page	query	integer	否	none
page_size	query	integer	否	none

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

GET 可划入团队的个人资产

GET /ep/team/assets/personal-candidates

请求参数

名称	位置	类型	必选	说明
team_id	query	TeamPublicId	是	none
page	query	integer	否	none
page_size	query	integer	否	none

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

POST 个人资产划入团队

POST /ep/team/assets/move-in

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	TeamPublicId	是	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» user_product_id	body	integer	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

POST 团队资产移回个人

POST /ep/team/assets/move-out

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	TeamPublicId	是	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» user_product_id	body	integer	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

团队钱包

GET 查询团队钱包

GET /ep/team/wallet/detail

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

请求参数

名称	位置	类型	必选	说明
team_id	query	TeamPublicId	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

GET 查询团队钱包流水

GET /ep/team/wallet/records

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

请求参数

名称	位置	类型	必选	说明
team_id	query	TeamPublicId	是	none
page	query	integer	否	none
page_size	query	integer	否	none

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

返回数据结构

枚举值

属性	值
direction	0
direction	1
transaction_type	1
transaction_type	2
transaction_type	3
transaction_type	4
transaction_type	5

POST 个人余额转入团队钱包

POST /ep/team/wallet/transfer-in

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

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	TeamPublicId	是	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» amount	body	number(double)	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

POST 团队余额转回个人账户

POST /ep/team/wallet/transfer-out

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

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	TeamPublicId	是	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» amount	body	number(double)	是	不得超过团队当前可用余额

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

团队成员

GET 团队成员列表

GET /ep/team/members

请求参数

名称	位置	类型	必选	说明
team_id	query	TeamPublicId	是	none
page	query	integer	否	none
page_size	query	integer	否	none

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

返回数据结构

枚举值

属性	值
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

GET 团队人员统一列表

GET /ep/team/people

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

请求参数

名称	位置	类型	必选	说明
team_id	query	TeamPublicId	是	none
page	query	integer	否	none
page_size	query	integer	否	none

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

返回数据结构

枚举值

属性	值
record_type	member
record_type	invitation
invite_type	0
invite_type	1
invite_type	2
invite_type	3
delivery_type	0
delivery_type	1
delivery_type	2
delivery_type	3
role	1
role	2
role	3
role	4
status	0
status	1

POST 调整成员角色

POST /ep/team/members/update-role

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	TeamPublicId	是	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» team_member_id	body	integer	是	none
» role	body	integer	是	none

枚举值

属性	值
» role	2
» role	3

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

返回数据结构

枚举值

属性	值
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

POST 移除团队成员

POST /ep/team/members/remove

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	TeamPublicId	是	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» team_member_id	body	integer	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data.status=3	Inline

返回数据结构

枚举值

属性	值
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

POST 退出团队

POST /ep/team/members/leave

Body 请求参数

{
  "team_id": "A1b2C3d4E5f6"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	TeamPublicId	是	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data.status=2	Inline

返回数据结构

枚举值

属性	值
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

团队邀请

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

Body 请求参数

{
  "team_id": "A1b2C3d4E5f6",
  "invite_type": 1,
  "role": 2,
  "user_id": 1,
  "email": "user@example.com",
  "country_code": 1,
  "phone": "string",
  "invitation_url_template": "/team/invitation/{{token}}"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	TeamPublicId	是	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» invite_type	body	integer	是	1=已注册用户，2=邮箱，3=手机号
» role	body	integer	是	2=管理员，3=普通成员
» user_id	body	integer	否	invite_type=1 时必填
» email	body	string(email)	否	invite_type=2 时必填
» country_code	body	integer	否	invite_type=3 时必填
» phone	body	string	否	invite_type=3 时必填
» invitation_url_template	body	string	否	本站前端定义的相对路径模板；必须以单个 / 开头、不得包含域名或换行，且必须且只能包含一个占位符
»anonymous	body	object	否	none
»» invite_type	body	any	否	none
»anonymous	body	object	否	none
»» invite_type	body	any	否	none
»anonymous	body	object	否	none
»» invite_type	body	any	否	none

枚举值

属性	值
» invite_type	1
» invite_type	2
» invite_type	3
» role	2
» role	3

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": null,
      "team_id": null,
      "inviter_user_id": null,
      "invitee_user_id": null,
      "invite_type": null,
      "invite_country_code": null,
      "invite_target": null,
      "delivery_type": null,
      "role": null,
      "status": null,
      "accepted_by_user_id": null,
      "expired_at": null,
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": null
    },
    "invitation_token": "string",
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": null,
      "sms": null,
      "site_inner_message": null
    }
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code，200 为业务成功	Inline

返回数据结构

枚举值

属性	值
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4
email	queued
email	failed
email	skipped
sms	queued
sms	failed
sms	skipped
site_inner_message	created
site_inner_message	exists
site_inner_message	failed

GET 团队邀请列表

GET /ep/team/invitations

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

请求参数

名称	位置	类型	必选	说明
team_id	query	TeamPublicId	是	团队公开标识
page	query	integer	否	页码，从 1 开始
page_size	query	integer	否	每页数量

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 1,
    "page_size": 1
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

返回数据结构

枚举值

属性	值
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4

GET 预览团队邀请

GET /ep/team/invitations/preview

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

请求参数

名称	位置	类型	必选	说明
invitation_token	query	string	是	邀请链接携带的非空明文一次性令牌

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

返回数据结构

枚举值

属性	值
role	2
role	3
status	0
status	1
status	2
status	3
status	4

POST 重发团队邀请通知

POST /ep/team/invitations/resend

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

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	TeamPublicId	是	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» invitation_id	body	integer	是	邀请 ID

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invitation": {
      "id": null,
      "team_id": null,
      "inviter_user_id": null,
      "invitee_user_id": null,
      "invite_type": null,
      "invite_country_code": null,
      "invite_target": null,
      "delivery_type": null,
      "role": null,
      "status": null,
      "accepted_by_user_id": null,
      "expired_at": null,
      "accepted_at": null,
      "rejected_at": null,
      "cancelled_at": null,
      "created_at": null
    },
    "invitation_url": "http://example.com",
    "notification_channels": {
      "email": null,
      "sms": null,
      "site_inner_message": null
    }
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

返回数据结构

枚举值

属性	值
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4
email	queued
email	failed
email	skipped
sms	queued
sms	failed
sms	skipped
site_inner_message	created
site_inner_message	exists
site_inner_message	failed

POST 接受团队邀请

POST /ep/team/invitations/accept

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

Body 请求参数

{
  "invitation_token": "string"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» invitation_token	body	string	是	明文一次性邀请令牌

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data 为成员对象	Inline

返回数据结构

枚举值

属性	值
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

POST 拒绝团队邀请

POST /ep/team/invitations/reject

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

Body 请求参数

{
  "invitation_token": "string"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» invitation_token	body	string	是	明文一次性邀请令牌

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data.status=2	Inline

返回数据结构

枚举值

属性	值
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4

POST 取消团队邀请

POST /ep/team/invitations/cancel

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

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	TeamPublicId	是	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» invitation_id	body	integer	是	邀请 ID

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data.status=3	Inline

返回数据结构

枚举值

属性	值
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4

积分管理

GET 获取积分套餐信息

GET /web_v1/credit/info

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

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	资源空间标识；个人空间省略或传空字符串；团队 API Key 可省略，传入时必须与 Key 一致

返回示例

200 Response

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

返回结果

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

返回数据结构

POST 设置余额自动补充积分

POST /web_v1/credit/update-auto-supplement

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

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» status	body	integer	是	0=关闭，1=开启

枚举值

属性	值
» status	0
» status	1

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data.status 为更新后的开关状态	Inline

返回数据结构

GET 获取积分消耗记录

GET /web_v1/credit/consumption-logs

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

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
page	query	integer	否	none
page_size	query	integer	否	none
start_date	query	string(date)	否	开始日期，按站点时区解释
end_date	query	string(date)	否	结束日期，按站点时区解释
consumption_type	query	string	否	消耗类型

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data 包含 list、page、page_size、total_count 和 total_page	Inline

返回数据结构

GET 获取积分重置记录

GET /web_v1/credit/reset-logs

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

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
page	query	integer	否	none
page_size	query	integer	否	none

返回示例

200 Response

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

返回结果

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

返回数据结构

GET 获取积分统计

GET /web_v1/credit/stats

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

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
start_date	query	string(date)	否	开始日期，按站点时区解释
end_date	query	string(date)	否	结束日期，按站点时区解释

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data 包含 by_type 和 total	Inline

返回数据结构

GET 获取按天积分统计

GET /web_v1/credit/daily-stats

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

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
start_date	query	string(date)	否	开始日期，默认 6 天前
end_date	query	string(date)	否	结束日期，默认今天
consumption_type	query	string	否	可选消耗类型
fill_gaps	query	integer	否	是否补齐缺失日期

枚举值

属性	值
fill_gaps	0
fill_gaps	1

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data 包含 daily_stats 和 summary	Inline

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
start_date	query	string(date)	否	开始日期，默认 6 天前
end_date	query	string(date)	否	结束日期，默认今天
consumption_type	query	string	否	可选消耗类型
fill_gaps	query	integer	否	是否补齐缺失小时

枚举值

属性	值
fill_gaps	0
fill_gaps	1

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data 包含 hourly_stats 和 summary	Inline

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	资源空间标识；个人空间省略或传空字符串；团队 API Key 可省略，传入时必须与 Key 一致

返回示例

200 Response

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

返回结果

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

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
page	query	integer	否	none
page_size	query	integer	否	none
start_date	query	string(date)	否	开始日期，按站点时区解释
end_date	query	string(date)	否	结束日期，按站点时区解释
consumption_type	query	string	否	消耗类型

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data 包含 list、page、page_size、total_count 和 total_page	Inline

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
page	query	integer	否	none
page_size	query	integer	否	none

返回示例

200 Response

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

返回结果

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

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
start_date	query	string(date)	否	开始日期，按站点时区解释
end_date	query	string(date)	否	结束日期，按站点时区解释

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data 包含 by_type 和 total	Inline

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
start_date	query	string(date)	否	开始日期，默认 6 天前
end_date	query	string(date)	否	结束日期，默认今天
consumption_type	query	string	否	可选消耗类型
fill_gaps	query	integer	否	是否补齐缺失日期

枚举值

属性	值
fill_gaps	0
fill_gaps	1

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data 包含 daily_stats 和 summary	Inline

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
start_date	query	string(date)	否	开始日期，默认 6 天前
end_date	query	string(date)	否	结束日期，默认今天
consumption_type	query	string	否	可选消耗类型
fill_gaps	query	integer	否	是否补齐缺失小时

枚举值

属性	值
fill_gaps	0
fill_gaps	1

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data 包含 hourly_stats 和 summary	Inline

返回数据结构

Xcrawl Activity Log

GET 获取 Xcrawl 近期任务列表

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

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

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
page	query	integer	否	none
page_size	query	integer	否	none
endpoint	query	string	否	端点类型
status	query	string	否	none
start_time	query	string	否	用户时区时间，格式 Y-m-d H:i:s
end_time	query	string	否	用户时区时间，包含结束边界
url	query	string	否	目标 URL 或 Data scraper 标识
job_id	query	string	否	任务 ID 前缀

枚举值

属性	值
status	pending
status	crawling
status	completed
status	failed

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data 包含分页 list 和 metadata	Inline

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
job_id	query	string	是	任务 ID

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data 包含 job_id 和 crawl_result	Inline

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
job_id	query	string	是	任务 ID
page	query	integer	否	crawl/data 子结果页码
page_size	query	integer	否	crawl/data 子结果分页数量

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data 包含 job 和按 endpoint 变化的 detail	Inline

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
limit	query	integer	否	返回数量；0 返回空列表

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data.list 为 scraper 聚合结果	Inline

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
page	query	integer	否	none
page_size	query	integer	否	none
endpoint	query	string	否	端点类型，通常为 batch_scrape
status	query	string	否	none
start_time	query	string	否	用户时区时间，格式 Y-m-d H:i:s
end_time	query	string	否	用户时区时间，包含结束边界
batch_id	query	string	否	批任务 ID 前缀

枚举值

属性	值
status	pending
status	crawling
status	completed
status	failed

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data 包含分页 list 和 metadata	Inline

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
batch_id	query	string	是	批任务 ID
page	query	integer	否	子项页码
page_size	query	integer	否	子项分页数量

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；业务成功时 data 包含 job 和批任务 detail	Inline

返回数据结构

代理账户管理

GET 代理账户列表

GET /ep/whitelist-account/list

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	资源空间标识；个人空间省略或传空字符串；团队 Key 可省略，传入时必须与 Key 一致

返回示例

200 Response

{
  "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
      }
    ]
  }
}

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	responseCode	false	none	状态码,200 成功、3 app_key 无效
» msg	string	false	none	状态消息
» data	object	false	none	none
»» list	[object]	false	none	none
»»» id	integer	false	none	账户编号
»»» username	string	false	none	代理账户名
»»» password	string	false	none	代理账户密码
»»» created_at	string	false	none	添加时间
»»» remark	string	false	none	备注
»»» product_type	productTypes	false	none	套餐类型，9 动态住宅流量套餐、11 动态住宅IP、14静态数据中心IP、25 静态住宅IP
»»» usage_flow	integer	false	none	已使用流量，单位：KB
»»» limit_flow	integer	false	none	自定义流量上限：单位GB最大102400，0 不限制
»»» status	integer	false	none	启用状态：1启用，0停用

枚举值

属性	值
product_type	9
product_type	11
product_type	14
product_type	25

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

POST /ep/whitelist-account/check

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» account	body	string	否	编辑已有代理账户时传入账号名称

返回示例

200 Response

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

返回结果

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

返回数据结构

枚举值

属性	值
isAgent	0
isAgent	1

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

GET /ep/whitelist-account/child-account

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	资源空间标识；个人空间省略或传空字符串

返回示例

200 Response

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

返回结果

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

返回数据结构

POST 添加代理账户。

POST /ep/whitelist-account/add

Body 请求参数

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

请求参数

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

枚举值

属性	值
» product_type	9
» product_type	11
» product_type	14
» product_type	25

返回示例

200 Response

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

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	null	false	none	none

POST 删除代理账户

POST /ep/whitelist-account/delete

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

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_key	body	string	否	授权密钥
» accounts	body	string	是	代理账户，仅支持数字和字母。支持批量操作，英文逗号（,）分隔代理账户

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	null	false	none	none

POST 禁用代理账户

POST /ep/whitelist-account/disable

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

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_key	body	string	否	授权密钥
» accounts	body	string	是	代理账户，仅支持数字和字母。支持批量操作，英文逗号（,）分隔代理账户

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	null	false	none	none

POST 启用代理账户

POST /ep/whitelist-account/enable

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_key	body	string	否	授权密钥
» accounts	body	string	是	代理账户，仅支持数字和字母。支持批量操作，英文逗号（,）分隔代理账户

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	null	false	none	none

POST 修改代理账户密码

POST /ep/whitelist-account/change-password

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

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_key	body	string	否	授权密钥
» account	body	string	是	代理账户，仅支持数字和字母。
» password	body	string	是	代理账户新密码，仅支持数字和字母。

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	null	false	none	none

POST 修改代理账户备注

POST /ep/whitelist-account/change-remark

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_key	body	string	否	授权密钥
» account	body	string	是	代理账户，仅支持数字和字母。
» remark	body	string	是	代理账户新备注，32个中文或64个英文以内。

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	null	false	none	none

POST 修改代理账户流量上限

POST /ep/whitelist-account/change-limit

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

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_key	body	string	否	授权密钥
» account	body	string	是	代理账户，仅支持数字和字母。
» limit	body	integer	否	流量限制，单位：GB，0为不设上限

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	null	false	none	none

POST 快速创建代理账户

POST /ep/whitelist-account/quick-add

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» product_type	body	integer	是	none

返回示例

200 Response

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

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	none
» msg	string	false	none	none
» request_id	string	false	none	none
» data	any	false	none	none

oneOf

名称	类型	必选	约束	说明
»»anonymous	object	false	none	none
»»» username	string	true	none	none
»»» password	string	true	none	none

xor

名称	类型	必选	约束	中文名	说明
»»anonymous	null	false	none		none

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

POST /ep/whitelist-account/change-daily-limit

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» account	body	string	是	none
» daily_limit	body	integer	否	单位 GB

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

POST 修改代理账户信息

POST /ep/whitelist-account/change

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» account	body	string	是	none
» password	body	string	否	none
» remark	body	string	否	none
» limit	body	integer	否	总流量上限，单位 GB
» daily_limit	body	integer	否	每日流量上限，单位 GB
» status	body	integer	否	none
» udp	body	integer	否	none

枚举值

属性	值
» status	0
» status	1
» udp	0
» udp	1

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

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

POST /ep/whitelist-account/refresh

Body 请求参数

{
  "team_id": "A1b2C3d4E5f6"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

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

GET /ep/whitelist-account/quota

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
product_type	query	integer	是	none

返回示例

200 Response

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

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	none
» msg	string	false	none	none
» request_id	string	false	none	none
» data	object	false	none	none
»» usage	integer	true	none	none
»» limit	integer	true	none	none
»» expand	integer	true	none	none

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

GET /ep/whitelist-account/quotas

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none

返回示例

200 Response

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

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	none
» msg	string	false	none	none
» request_id	string	false	none	none
» data	object	false	none	none
»» list	[object]	false	none	none
»»» product_type	integer	false	none	none
»»» limit	integer	false	none	none
»»» usage	integer	false	none	none

POST 修改代理账户信息

POST /ep/proxy-account/change

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

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_key	body	string	否	授权密钥
» account	body	string	是	代理账户名
» password	body	string	否	新密码，6-16 位数字或字母；不传则不修改
» remark	body	string	否	新备注
» limit	body	integer	否	流量上限，单位 GB，0 表示不限制
» daily_limit	body	integer	否	每日流量上限，单位 GB，0 表示不限制
» status	body	integer	否	启用状态
» udp	body	integer	否	UDP 支持开关，仅对套餐类型 14、16、21、25 生效

枚举值

属性	值
» status	0
» status	1
» udp	0
» udp	1

返回示例

200 Response

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

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功
» msg	string	false	none	状态消息
» data	null	false	none	none

GET 生成代理连接信息

GET /ep/whitelist-account/format

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

请求参数

名称	位置	类型	必选	说明
ac	query	integer	是	代理账号 ID 或用户名；兼容参数 account
ae	query	string	否	none
st	query	string	否	none
ct	query	string	否	none
lf	query	integer	否	none
n	query	integer	否	none
f	query	integer	否	仅影响 txt/csv 的连接串格式
type	query	string	否	none
lb	query	string	否	none
ep	query	string	否	none
team_id	query	ResourceSpaceId	否	none

枚举值

属性	值
f	1
f	2
f	3
f	4
f	5
type	json
type	xml
type	txt
type	csv

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}]
  },
  "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>

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	WebV1SuccessResponse

IP白名单

GET IP 白名单列表

GET /ep/proxy-ip/list

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	资源空间标识；个人空间省略或传空字符串
product_type	query	integer	否	套餐类型编号

返回示例

200 Response

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

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功
» msg	string	false	none	状态消息
» data	object	false	none	none
»» list	[object]	false	none	none
»»» ip	string	false	none	白名单 IP
»»» remark	string	false	none	备注
»»» product_type	integer	false	none	套餐类型
»»» created_at	string	false	none	创建时间

POST 添加 IP 白名单

POST /ep/proxy-ip/add

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_key	body	string	否	授权密钥
» ips	body	string	是	需要添加的白名单 IP，多个用英文逗号或换行分隔
» remark	body	string	否	备注
» product_type	body	integer	否	套餐类型编号
» user_product_id	body	integer	否	用户套餐 ID，套餐类型为 11 时必填

返回示例

200 Response

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

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功
» msg	string	false	none	状态消息
» data	null	false	none	none

POST 删除 IP 白名单

POST /ep/proxy-ip/delete

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» app_key	body	string	否	授权密钥
» ips	body	string	是	需要删除的白名单 IP，多个用英文逗号分隔
» verify_type	body	string	否	验证类型：phone、email、wechat、totp
» verify_code	body	string	否	验证码

返回示例

200 Response

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

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功
» msg	string	false	none	状态消息
» data	null	false	none	none

POST 修改 IP 白名单备注

POST /ep/white-ip/change-remark

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» ip	body	string(ipv4)	是	none
» remark	body	string	是	none

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

POST 刷新当前资源空间 IP 白名单认证缓存

POST /ep/white-ip/refresh

Body 请求参数

{
  "team_id": "A1b2C3d4E5f6"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

GET 指定产品类型的 IP 白名单配额

GET /ep/white-ip/quota

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
product_type	query	integer	是	none

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

GET 所有产品类型的 IP 白名单配额

GET /ep/white-ip/quotas

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

IP提取

GET IP 提取数量按天统计

GET /ep/user-extract-ip/days

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
start_date	query	string(date)	否	默认 6 天前
end_date	query	string(date)	否	默认今天
product_type	query	integer	否	none

枚举值

属性	值
product_type	9
product_type	17
product_type	22

返回示例

200 Response

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

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	none
» msg	string	false	none	none
» request_id	string	false	none	none
» data	object	false	none	none
»» list	[object]	false	none	none
»»» count	integer	true	none	none
»»» date	string(date)	true	none	none

GET 提取IP

GET /ep/ip/v3

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	团队 Key 可省略；传入时必须与 Key 绑定团队一致
app_key	query	string(password)	是	访问密钥
cc	query	string	否	国家或地区
state	query	string	否	省或州
city	query	string	否	城市
format	query	string	否	获取格式
lb	query	string	否	间隔符，仅text格式有效
num	query	number	否	提取数量
life	query	number	否	保持周期-分钟
ep	query	string	否	代理网络

枚举值

属性	值
ep	us
ep	hk
ep	de

返回示例

200 Response

{
  "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"
      ]
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	true	none	状态消息
» data	object	false	none	none
»» list	[any]	false	none	none

GET 动态地区城市列表V4

GET /ep/ip/dcl4

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

请求参数

名称	位置	类型	必选	说明
username	query	string	是	代理账户用户名

返回示例

200 Response

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

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功
» msg	string	false	none	状态消息
» data	object	false	none	none
»» cache	boolean	false	none	是否来自缓存
»» list	[object]	false	none	none
»»» City	string	false	none	城市
»»» Area	string	false	none	地区
»»» State	string	false	none	州/省

GET 动态地区州/省列表V4

GET /ep/ip/dsl4

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

请求参数

名称	位置	类型	必选	说明
username	query	string	是	代理账户用户名

返回示例

200 Response

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

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功
» msg	string	false	none	状态消息
» data	object	false	none	none
»» cache	boolean	false	none	是否来自缓存
»» list	[object]	false	none	none
»»» City	string	false	none	城市
»»» Area	string	false	none	地区
»»» State	string	false	none	州/省

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

GET /ep/ip/dal4

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

请求参数

名称	位置	类型	必选	说明
username	query	string	是	代理账户用户名

返回示例

200 Response

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

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功
» msg	string	false	none	状态消息
» data	object	false	none	none
»» cache	boolean	false	none	是否来自缓存
»» list	[object]	false	none	地区列表
»»» Area	string	false	none	地区代码
»»» states	[object]	false	none	州/省列表
»»»» State	string	false	none	州/省名称
»»»» cities	[string]	false	none	城市列表

GET 城市列表

GET /ep/ip/dynamic-citys

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	true	none	状态消息
» data	object	false	none	none
»» list	[object]	false	none	列表
»»» name_zh_cn	string	false	none	国家或地区名称
»»» name_en	string	false	none	国家或地区名称
»»» continent_code	string	false	none	大洲代码
»»» country_code	string	false	none	国家或地区代码
»»» items	[object]	false	none	省或州
»»»» city	string	false	none	城市名称
»»»» state	string	false	none	省或州名称代码
»»»» continent_code	string	false	none	大洲代码
»»»» country_code	string	false	none	国家或地区代码

GET 城市搜索

GET /ep/ip/dynamic-citys/search

请求参数

名称	位置	类型	必选	说明
country_code	query	string	是	国家或地区代码
state	query	string	是	州或省代码

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	true	none	状态消息
» data	object	false	none	none
»» list	[string]	false	none	列表

GET 州列表

GET /ep/ip/dynamic-states

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	true	none	状态消息
» data	object	false	none	none
»» list	[object]	false	none	列表
»»» name_zh_cn	string	false	none	国家或地区名称
»»» name_en	string	false	none	国家或地区名称
»»» continent_code	string	false	none	大洲代码
»»» country_code	string	false	none	国家或地区代码
»»» items	[object]	false	none	省或州
»»»» state	string	false	none	省或州名称代码
»»»» continent_code	string	false	none	大洲代码
»»»» country_code	string	false	none	国家或地区代码

GET 州/省搜索

GET /ep/ip/dynamic-states/search

请求参数

名称	位置	类型	必选	说明
country_code	query	string	是	国家或地区代码

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	true	none	状态消息
» data	object	false	none	none
»» list	[string]	false	none	列表

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

POST /ep/ip/get-datacenter-assign-ip-list

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

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	资源空间标识；个人空间省略或传空字符串；团队 Key 可省略，传入时必须与 Key 一致
area	query	string	否	国家/地区代码
status	query	integer	否	0=所有，1=有效，2=过期
trade_no	query	string	否	订单号
created_at	query	array[string]	否	创建时间范围，必须同时传开始和结束时间

枚举值

属性	值
status	0
status	1
status	2

返回示例

200 Response

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

返回结果

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

名称	位置	类型	必选	说明
country_code	query	string	否	国家或地区代码
product_type	query	number	否	产品类型, 25:静态住宅IP, 14: 数据中心IP
trade_no	query	string	否	通过订单号筛选IP
page	query	number	否	页码
size	query	number	否	每页数量
status	query	number	否	状态, 1:有效, 2:无效, 3:即将过期, 4:维护中

枚举值

属性	值
product_type	14
product_type	25
status	1 - 2 - 3 - 4

返回示例

200 Response

{}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	Inline

名称	位置	类型	必选	说明
isp	query	integer	否	ISP 筛选，不传则不筛选（站点 1/4/5 除外默认为 1）
asn	query	integer	否	是否返回 ASN 分组数据
exclusive	query	integer	否	是否按独享库存统计

详细说明

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

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

asn: 是否返回 ASN 分组数据

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

exclusive: 是否按独享库存统计

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

枚举值

属性	值
isp	0
isp	1
asn	0
asn	1
exclusive	0
exclusive	1

返回示例

200 Response

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

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	状态码,200 成功
» msg	string	true	none	状态消息
» data	object	false	none	none
»» list	[object]	false	none	none
»»» code	string	true	none	国家或地区代码
»»» number	integer	true	none	数量

GET 获取 host_pool 支持国家/地区

GET /ep/host-pool/regions

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

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

返回示例

200 Response

{
  "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"
      }
    ]
  }
}

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	状态码,200 成功
» msg	string	true	none	状态消息
» data	object	false	none	none
»» list	[object]	false	none	none
»»» code	string	true	none	国家或地区代码，ISO 3166-1 alpha-2
»»» number	integer	true	none	当前站点可用数据中心 IP 数量
»»» name_zh_cn	string	false	none	国家或地区中文名称
»»» name_en	string	false	none	国家或地区英文名称
»»» square_flag	string	false	none	方形旗帜图片 URL

流量日志查询

POST 近期使用流量按天汇总

POST /ep/user-usage-flow/days

Body 请求参数

{
  "team_id": "A1b2C3d4E5f6",
  "days": 7,
  "product_type": 0,
  "username": "string"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» days	body	integer	否	none
» product_type	body	integer	否	none
» username	body	string	否	none

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "days": "2019-08-24",
        "flow": 0
      }
    ],
    "days": 1
  },
  "request_id": "string"
}

返回结果

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

返回数据结构

POST 代理账户历史使用流量

POST /ep/user-usage-flow/username-total

Body 请求参数

{
  "team_id": "A1b2C3d4E5f6"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键

返回示例

200 Response

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

返回结果

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

返回数据结构

POST 导出代理账户月度使用流量

POST /ep/user-usage-flow/export-csv

Body 请求参数

{
  "team_id": "A1b2C3d4E5f6"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键

返回示例

200 Response

返回结果

状态码	状态码含义	说明	数据模型
200	OK	GBK 编码 CSV 文件	string

GET 套餐流量总量与剩余量

GET /ep/user-usage-flow/flow-total

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
unit	query	string	否	none

枚举值

属性	值
unit	KB
unit	MB
unit	GB
unit	TB
unit	PB

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "limit": 0,
    "total": 0,
    "remain": 0,
    "unit": "KB",
    "timestamp": 0
  },
  "request_id": "string"
}

返回结果

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

返回数据结构

枚举值

属性	值
unit	KB
unit	MB
unit	GB
unit	TB
unit	PB

GET 每日速率图

GET /ep/user-usage-flow/rate-graph

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
start	query	string(date)	否	none
end	query	string(date)	否	none
username	query	string	否	none
user_product_id	query	integer	否	none

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "date": "2019-08-24",
        "rate": 0,
        "corrent": 0
      }
    ]
  },
  "request_id": "string"
}

返回结果

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

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
start_time	query	string	否	none
end_time	query	string	否	none
product_type	query	integer	否	none
username	query	string	否	none

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "day": "2019-08-24",
        "cache_flow": 0,
        "cache_reduce_flow": 0
      }
    ]
  },
  "request_id": "string"
}

返回结果

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

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	资源空间标识；个人空间省略或传空字符串
app_key	query	string(password)	是	认证密钥
start_time	query	string(Y-m-d H:i:s)	否	起始时间，可精确到秒。请注意，日志记录有5分钟以内延迟。默认7天以内。
end_time	query	string(Y-m-d H:i:s)	否	截止时间，可精确到秒。请注意，日志记录有5分钟以内延迟。默认当前时间。
username	query	string	否	子账户名称,默认查询所有账户，可指定子账户。请注意如果您添加了相同名称的子账户，此查询将返回同名代理账户的所有使用记录。
product_type	query	number	否	套餐类型

返回示例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "day": "2022-08-01",
        "flow": 0
      }
    ]
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	true	none	状态消息
» data	object	false	none	none
»» list	[object]	false	none	none
»»» day	string	false	none	日期
»»» flow	integer	false	none	消耗流量,单位KB

代理日志

GET 客户端 IP 代理访问统计

GET /ep/http-t-dom/list-v2

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
start_time	query	string(date)	否	none
end_time	query	string(date)	否	none
export	query	string	否	none

枚举值

属性	值
export	csv

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	JSON 统计结果；`export=csv` 时返回 CSV 文件	string

GET 客户端 IP 访问占比

GET /ep/http-t-dom/client-ip-proportion

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
start_time	query	string(date)	否	none
end_time	query	string(date)	否	none
export	query	string	否	none

枚举值

属性	值
export	csv

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	JSON 占比结果；`export=csv` 时返回 CSV 文件	string

月度续费账单

GET 当前月度汇总续费账单

GET /ep/monthly-renewal-bill

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none

返回示例

200 Response

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

返回结果

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

返回数据结构

枚举值

属性	值
type	current
type	next

POST 检查月度汇总续费订单

POST /ep/monthly-renewal-bill/check

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	MonthlyRenewalRequest	是	none

返回示例

200 Response

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

返回结果

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

返回数据结构

枚举值

属性	值
type	current
type	next

POST 创建月度汇总续费订单

POST /ep/monthly-renewal-bill/create

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	MonthlyRenewalRequest	是	none

返回示例

200 Response

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

返回结果

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

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
trade_no	query	string	否	none
start_date	query	string(date)	否	none
end_date	query	string(date)	否	none
page	query	integer	否	none
size	query	integer	否	none

返回示例

200 Response

{
  "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": [null]
      }
    ]
  },
  "request_id": "string"
}

返回结果

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

返回数据结构

发票管理

GET 发票抬头详情

GET /ep/user-invoice/info

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
invoice_code	query	string	否	none

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "invoice_code": "string",
    "name": "string",
    "org_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "email": "user@example.com",
    "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"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

返回数据结构

枚举值

属性	值
role_type	1
role_type	2
invoice_type	0
invoice_type	1
invoice_type	2

POST 创建或修改发票抬头

POST /ep/user-invoice/create

Body 请求参数

{
  "invoice_code": "string",
  "name": "string",
  "org_name": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "email": "user@example.com",
  "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
}

请求参数

名称	位置	类型	必选	说明
body	body	any	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成功，data 为 null	Inline

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none

返回示例

200 Response

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

返回结果

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

返回数据结构

枚举值

属性	值
role_type	1
role_type	2
invoice_type	0
invoice_type	1
invoice_type	2

POST 删除发票抬头

POST /ep/user-invoice/delete

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» invoice_code	body	string	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成功，data 为 null	Inline

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
status	query	integer	否	none

枚举值

属性	值
status	0
status	1
status	2
status	3
status	4

返回示例

200 Response

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

返回结果

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

返回数据结构

枚举值

属性	值
role_type	1
role_type	2
invoice_type	0
invoice_type	1
invoice_type	2

POST 提交开票申请

POST /ep/user-invoice/submit

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» invoice_code	body	string	是	none
» order_ids	body	[integer]	是	none

返回示例

200 Response

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

返回结果

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

返回数据结构

POST 取消开票申请

POST /ep/user-invoice/cancel

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» invoice_id	body	integer	是	none
» reason	body	string	否	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成功，data 为 null	Inline

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none

返回示例

200 Response

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

返回结果

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

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none

返回示例

200 Response

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

返回结果

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

返回数据结构

套餐查询

GET 已购套餐列表

GET /ep/user-product/list

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	资源空间标识；个人空间省略或传空字符串
app_key	query	string(password)	是	认证密钥
trade_no	query	string	否	订单号，请输入完整订单号。不支持模糊搜索。
page	query	number	否	分页，默认：1
size	query	number	否	分页显示数量,默认：20
product_type	query	number	否	套餐类型

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	true	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	true	none	状态消息
» data	object	false	none	none
»» list	[object]	false	none	none
»»» id	integer	false	none	套餐编号
»»» created_at	string	false	none	套餐生效时间
»»» expired_at	string	false	none	套餐过期时间,过期后流量无法使用。
»»» product_type	productTypes	false	none	套餐类型，9 动态住宅流量套餐、11 动态住宅IP、14静态数据中心IP、25 静态住宅IP
»»» trade_no	string	false	none	订单交易号
»»» order	object	false	none	none
»»»» created_at	string	false	none	订单创建时间
»»»» pay_at	string	false	none	订单支付时间
»»»» title	string	false	none	订单描述
»» page	integer	true	none	当前分页
»» page_size	integer	false	none	分页大小
»» total_count	integer	false	none	总记录数量
»» total_page	integer	false	none	总分页数量

枚举值

属性	值
product_type	9
product_type	11
product_type	14
product_type	25

GET 用户套餐数据汇总

GET /ep/user-product/summary

获取用户套餐的统计汇总信息，包括总量、有效量、临期量、过期量等

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	资源空间标识；个人空间省略或传空字符串
app_key	query	string(password)	是	认证密钥
product_type	query	integer	否	产品类型，仅支持 9（动态流量套餐）、12（长效IDC流量套餐）

枚举值

属性	值
product_type	9
product_type	12

返回示例

200 Response

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

返回结果

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

返回数据结构

状态码 200

名称	类型	必选	约束	说明
» code	integer	false	none	状态码,200 成功、3 app_key 无效、156 账户未实名认证
» msg	string	false	none	状态消息
» data	object	false	none	none
»» total	integer	false	none	流量/IP总量（单位：KB）
»» total_count	integer	false	none	套餐总个数
»» effective	integer	false	none	有效剩余量（单位：KB）
»» effective_count	integer	false	none	有效套餐个数
»» effective_total	integer	false	none	有效总量（单位：KB）
»» effective_used	integer	false	none	有效已使用量（单位：KB）
»» temporary	integer	false	none	临期总量（7天内到期，单位：KB）
»» temporary_count	integer	false	none	临期套餐个数（7天内到期）
»» expired	integer	false	none	过期剩余量（单位：KB）
»» expired_count	integer	false	none	过期套餐个数
»» used	integer	false	none	已使用总量（单位：KB）

POST 静态 IP 列表

POST /ep/user-product/datacenter-isp-ip-list

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» status	body	integer	否	none
» page	body	integer	否	none
» size	body	integer	否	none
» user_product_id	body	integer	否	none
» country_code	body	string	否	none
» product_type	body	integer	否	none
» ip	body	string(ipv4)	否	none
» auto_renewal	body	integer	否	none
» support_renewal	body	integer	否	none
» remaining_days	body	integer	否	none
» limit_days	body	integer	否	none
» sort	body	string	否	none
» remark	body	string	否	none

枚举值

属性	值
» auto_renewal	0
» auto_renewal	1
» support_renewal	0
» support_renewal	1
» sort	exp_asc
» sort	exp_desc

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

POST 删除已过期套餐

POST /ep/user-product/delete

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» id	body	integer	是	none

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

POST 批量删除已过期套餐

POST /ep/user-product/batch-delete

Body 请求参数

{
  "team_id": "A1b2C3d4E5f6",
  "ids": [1]
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» ids	body	[integer]	是	none

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

POST 修改套餐备注

POST /ep/user-product/change-remark

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» id	body	integer	是	none
» remark	body	string	是	none

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

POST 批量设置静态 IP UDP 开关

POST /ep/user-product/set-ip-udp

Body 请求参数

{
  "team_id": "A1b2C3d4E5f6",
  "ids": [1],
  "udp": 0
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» ids	body	[integer]	是	none
» udp	body	integer	是	none

枚举值

属性	值
» udp	0
» udp	1

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

套餐管理

POST 更换数据中心 ISP 静态 IP

POST /ep/user-product/change-datacenter-isp-ip

Body 请求参数

{
  "team_id": "A1b2C3d4E5f6",
  "id": 1,
  "country_code": "string",
  "ip": "string"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» id	body	integer	是	用户套餐 ID
» country_code	body	string	否	目标国家/地区代码；不传时优先沿用当前 IP 国家/地区
» ip	body	string	否	目标 IP 前缀筛选

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "ip_id": 1,
    "ip": "string",
    "country_code": "string"
  },
  "request_id": "string"
}

返回结果

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

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	资源空间标识；个人空间省略或传空字符串
page	query	integer	否	none
page_size	query	integer	否	none

返回示例

200 Response

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

返回结果

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

返回数据结构

POST 设置单个套餐的自动续费开关

POST /ep/user-product/set-auto-renewal

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» user_product_id	body	integer	是	none
» status	body	integer	否	0=停用，1=启用

枚举值

属性	值
» status	0
» status	1

返回示例

200 Response

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

返回结果

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

返回数据结构

POST 批量设置套餐自动续费开关

POST /ep/user-product/batch-set-auto-renewal

Body 请求参数

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_ids": [1],
  "status": 0
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» user_product_ids	body	[integer]	是	none
» status	body	integer	否	0=停用，1=启用

枚举值

属性	值
» status	0
» status	1

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "results": [
      {
        "user_product_id": 1,
        "success": true,
        "id": 1
      }
    ]
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成功；每个套餐独立返回处理结果	Inline

返回数据结构

POST 设置产品类型的默认自动续费参数

POST /ep/user-product/set-auto-renewal-default-config

days_before_expire、traffic_threshold、renewal_cycle_days 至少传一个；值为 0 表示重置对应配置。

Body 请求参数

{
  "team_id": "A1b2C3d4E5f6",
  "product_type": 9,
  "days_before_expire": 30,
  "traffic_threshold": 100,
  "renewal_cycle_days": 0
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» product_type	body	integer	是	none
» days_before_expire	body	integer	否	none
» traffic_threshold	body	integer	否	单位 GB，仅 9/12/24 支持
» renewal_cycle_days	body	integer	否	仅 11/14/16/25 支持，且必须是当前在售产品周期
»anonymous	body	object	否	none
»anonymous	body	object	否	none
»anonymous	body	object	否	none

枚举值

属性	值
» product_type	9
» product_type	11
» product_type	12
» product_type	14
» product_type	16
» product_type	24
» product_type	25

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	请求成功，data 为 null	Inline

返回数据结构

POST 获取产品类型的默认自动续费参数

POST /ep/user-product/get-auto-renewal-default-config

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» product_type	body	integer	否	不传则返回全部支持类型

枚举值

属性	值
» product_type	9
» product_type	11
» product_type	12
» product_type	14
» product_type	16
» product_type	24
» product_type	25

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "configs": [
      {
        "product_type": "[",
        "days_before_expire": 0,
        "source": "[",
        "renewal_cycle": {},
        "traffic_threshold": 0,
        "traffic_source": "["
      }
    ]
  },
  "request_id": "string"
}

返回结果

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

返回数据结构

枚举值

属性	值
product_type	9
product_type	11
product_type	12
product_type	14
product_type	16
product_type	24
product_type	25
source	user
source	system
source	user
source	system
traffic_source	user
traffic_source	system

POST 获取单个套餐自动续费配置和续费预览

POST /ep/user-product/get-auto-renewal

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» user_product_id	body	integer	是	none

返回示例

200 Response

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

返回结果

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

返回数据结构

枚举值

属性	值
time_unit	day
time_unit	hour
status	0
status	1

POST 获取自动续费执行记录

POST /ep/user-product/auto-renewal-logs

Body 请求参数

{
  "team_id": "A1b2C3d4E5f6",
  "user_product_id": 1,
  "page": 1,
  "size": 20
}

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» user_product_id	body	integer	否	不传则查询当前空间全部记录
» page	body	integer	否	none
» size	body	integer	否	none

返回示例

200 Response

{
  "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": "[",
        "status": "[",
        "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"
}

返回结果

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

返回数据结构

枚举值

属性	值
trigger_type	0
trigger_type	1
status	1
status	2
status	3

订单管理

GET 订单列表

GET /ep/order/list

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

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	订单资源空间标识；个人空间省略或传空字符串
page_no	query	integer	否	none
page_size	query	integer	否	none
trade_no	query	string	否	订单编号
start_time	query	string(date-time)	否	开始时间（包含），如 2024-01-01 00:00:00
end_time	query	string(date-time)	否	结束时间（不包含）
status	query	integer	否	订单状态
product_type	query	integer	否	产品类型
invoice	query	integer	否	发票状态：0不限制 1已开发票 -1未开发票（可补开）
pay_fee_status	query	integer	否	长短款筛选：1超额支付 2短款支付

详细说明

status: 订单状态

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

product_type: 产品类型

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

枚举值

属性	值
status	0
status	1
status	2
status	3
product_type	3
product_type	9
product_type	11
product_type	12
product_type	14
product_type	16
product_type	17
product_type	18
product_type	19
product_type	21
product_type	24
product_type	25
product_type	26
product_type	27
product_type	28
invoice	-1
invoice	0
invoice	1
pay_fee_status	1
pay_fee_status	2

返回示例

200 Response

{
  "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": {}
      }
    ],
    "pagination": {
      "total": 0,
      "page_no": 0,
      "page_size": 0,
      "total_pages": 0
    }
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

{
    "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 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» pid	body	integer	是	套餐ID，来自 /openapi/product 接口返回的 id 字段
» upids	body	string	否	续费套餐ID列表（逗号分隔），来自 /openapi/user-product/list 或 /openapi/ip/get-static-ip 接口返回的 id 字段
» amount	body	number	否	新购套餐数量
» pm_id	body	integer	是	支付方式ID，来自 /openapi/payment/list 或 /openapi/payment/groups 接口返回的 id 字段
» region_list	body	string	否	购买静态IP时指定区域+数量+ASN编号，格式：地区,数量,ASN
» coupon_sn	body	string	否	优惠券编号
» use_invitation_registration_discount	body	boolean	否	是否使用邀请注册优惠
» renew_duration	body	integer	否	续费时长-静态IP可选
» product_sku_bandwidth_id	body	integer	否	套餐11：带宽套餐ID
» product_sku_concurrency_id	body	integer	否	套餐11：并发套餐ID
» product_sku_duration_id	body	integer	否	套餐type=11必填：时长规格ID
» etd	body	integer	否	时长倍数，从套餐 extension_of_time_days 获取，2代表天数×2，价格上浮
» recharge_amount	body	integer	否	套餐3：充值金额

返回示例

200 Response

{
  "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": "user@example.com",
      "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"
}

返回结果

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

返回数据结构

POST 取消订单

POST /ep/order/close

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» trade_no	body	string	是	none

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

GET 订单详情

GET /ep/order/info

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
trade_no	query	string	是	none

返回示例

200 Response

{
  "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": null,
      "org_name": null,
      "first_name": null,
      "last_name": null,
      "phone": null,
      "email": null,
      "role_type": null,
      "vat_id": null,
      "address_country": null,
      "address_city": null,
      "address_line1": null,
      "address_line2": null,
      "address_postal_code": null
    }
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请继续判断响应体 code	Inline

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
order_id	query	string	是	客户端加密后的订单 ID

返回示例

200 Response

{
  "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": null,
      "org_name": null,
      "first_name": null,
      "last_name": null,
      "phone": null,
      "email": null,
      "role_type": null,
      "vat_id": null,
      "address_country": null,
      "address_city": null,
      "address_line1": null,
      "address_line2": null,
      "address_postal_code": null
    }
  },
  "request_id": "string"
}

返回结果

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

返回数据结构

POST 历史订单补开发票

POST /ep/order/reissue-invoice

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» trade_no_list	body	[string]	是	none

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

POST 订单预检

POST /ep/order/check

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

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» pid	body	integer	是	套餐ID
» upids	body	string	否	IP续费：用户套餐ID列表，逗号分隔
» amount	body	integer	否	购买数量
» pm_id	body	integer	是	支付方式ID
» region_list	body	string	否	静态IP购买地区+数量，格式：地区ID,数量
» coupon_sn	body	string	否	优惠券编号
» renew_duration	body	string	否	IP续费时长：1m=1个月，2m=2个月，em=下个月月底
» product_sku_bandwidth_id	body	integer	否	套餐type=11必填：带宽规格ID
» product_sku_concurrency_id	body	integer	否	套餐type=11必填：并发规格ID
» product_sku_duration_id	body	integer	否	套餐type=11必填：时长规格ID
» etd	body	integer	否	时长倍数，从套餐 extension_of_time_days 获取
» recharge_amount	body	number	否	套餐type=3必填：充值金额

枚举值

属性	值
» renew_duration	1m
» renew_duration	2m
» renew_duration	em

返回示例

200 Response

{
  "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": {}
      }
    ]
  },
  "request_id": "string"
}

返回结果

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

返回数据结构

支付管理

POST 拉起订单支付

POST /ep/pay

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
trade_no	query	string	是	none
pm_id	query	integer	否	none

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

POST 后台开单未支付订单拉起支付

POST /ep/pay/index-choose

Body 请求参数

{
  "team_id": "A1b2C3d4E5f6",
  "trade_no": "string",
  "pay_method": 0,
  "pm_id": 0,
  "trade_type": "string"
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» team_id	body	any	否	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
»»anonymous	body	string	否	none
»»anonymous	body	TeamPublicId	否	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
» trade_no	body	string	是	none
» pay_method	body	integer	否	none
» pm_id	body	integer	否	none
» trade_type	body	string	否	none

返回结果

状态码	状态码含义	说明	数据模型
200	OK	操作成功	None

POST 支付校验和费用预览

POST /ep/pay/pay-check

请求参数

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
trade_no	query	string	是	none
pm_id	query	integer	否	none

返回示例

200 Response

{
  "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": null,
      "type": null,
      "title": null,
      "group": null,
      "handling_rate": null,
      "handling_fee": null,
      "handling_fee_currency": null,
      "handling_fee_converted": null
    },
    "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"
}

返回结果

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

名称	位置	类型	必选	说明
team_id	query	ResourceSpaceId	否	none
trade_no	query	string	是	none
pm_id	query	integer	否	none

返回示例

200 Response

"string"

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTML 支付页	string

GET 获取支付方式列表

GET /ep/payment/list

请求参数

名称	位置	类型	必选	说明
trade_no	query	string	否	订单号 - 部分订单需要获取特定支付方式时可传入
currency	query	string	否	货币单位

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	获取成功	Inline

名称	位置	类型	必选	说明
trade_no	query	string	否	订单号 - 部分订单需要获取特定支付方式时可传入

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "name": "string",
        "logos": [null],
        "items": [null]
      }
    ]
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	获取成功	Inline

返回数据结构

营销

GET 充值赠金比例

GET /ep/activity/balance-recharge-gift-ratio

充值赠金比例

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline

返回数据结构

产品

GET 产品列表

GET /ep/product

获取当前站点可购买的套餐列表，支持按类型、有效期等条件筛选。

请求参数

名称	位置	类型	必选	说明
type	query	integer	否	套餐类型，见 Product.type 枚举说明。不传则返回所有类型。
parent_product_type	query	integer	否	父套餐类型，仅 type=19（IP续费）时有效，用于筛选产品线：14=数据中心 25=住宅
time_days	query	any	否	有效期天数筛选，支持单值或数组，如 30 / [30,90,365]
show_type	query	any	否	展示类型筛选，支持单值或数组

详细说明

type: 套餐类型，见 Product.type 枚举说明。不传则返回所有类型。

枚举值

属性	值
parent_product_type	14
parent_product_type	25

返回示例

200 Response

{
  "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": [null]
      },
      "sku": {
        "bandwidth_list": [null],
        "duration_list": [null],
        "concurrency_list": [null]
      }
    }
  ],
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	Inline

返回数据结构

账户管理

GET 获取个人账户概览

GET /ep/account/profile

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

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

名称	位置	类型	必选	说明
re_type	query	integer	否	none
transaction_type	query	integer	否	none
balance_type	query	integer	否	none
page	query	integer	否	none
page_size	query	integer	否	none

枚举值

属性	值
re_type	0
re_type	1

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "page": 0,
    "page_size": 0,
    "total_count": 0
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

日志导出

POST 创建代理日志导出任务

POST /ep/user-usage-flow-log-export/create

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

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» start_time	body	integer	是	开始 Unix 时间戳，秒
» end_time	body	integer	是	结束 Unix 时间戳，秒
» type	body	string	否	none

枚举值

属性	值
» type	dynamic
» type	host_pool

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

名称	位置	类型	必选	说明
task_id	query	integer	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

枚举值

属性	值
status	pending
status	processing
status	completed
status	failed
status	canceled
status	no_data

GET 查询日志导出任务列表

GET /ep/user-usage-flow-log-export/list

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

请求参数

名称	位置	类型	必选	说明
page	query	integer	否	none
size	query	integer	否	none

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "total": 0,
    "page": 0,
    "size": 0
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

枚举值

属性	值
status	pending
status	processing
status	completed
status	failed
status	canceled
status	no_data

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

POST /ep/user-usage-flow-log-export/cancel

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

Body 请求参数

{
  "task_id": 1
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» task_id	body	integer	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

优惠券

POST 查询个人优惠券列表

POST /ep/user-coupon/list

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

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
body	body	object	否	none
» status	body	integer	否	none
» page	body	integer	否	none
» size	body	integer	否	none

枚举值

属性	值
» status	0
» status	1
» status	2

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "page": 0,
    "page_size": 0,
    "page_count": 0
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

POST 查询个人优惠券详情

POST /ep/user-coupon/info

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

Body 请求参数

{
  "id": 1
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» id	body	integer	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

通知管理

GET 查询站内通知

GET /ep/notify/list

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

请求参数

名称	位置	类型	必选	说明
page	query	integer	否	none
size	query	integer	否	none
read	query	integer	否	none
type	query	integer	否	none

枚举值

属性	值
read	0
read	1

返回示例

200 Response

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [{}],
    "page": 0,
    "size": 0,
    "total": 0,
    "total_unread_count": 0,
    "unread_count_by_type": {}
  },
  "request_id": "string"
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

枚举值

属性	值
read_status	0
read_status	1

GET 查询站内通知详情

GET /ep/notify/detail

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

请求参数

名称	位置	类型	必选	说明
id	query	integer	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

枚举值

属性	值
read_status	0
read_status	1

POST 将站内通知标记为已读

POST /ep/notify/read

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

Body 请求参数

{
  "id": 1
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» id	body	integer	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

POST 批量标记站内通知为已读

POST /ep/notify/batch-read

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

Body 请求参数

{
  "ids": [1]
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» ids	body	[integer]	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

GET 查询通知渠道配置

GET /ep/user-notify

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

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

GET 查询通知邮箱

GET /ep/user-notification-email/list

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

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

GET 查询通知场景

GET /ep/user-notification-email/scenes

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

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

名称	位置	类型	必选	说明
id	query	integer	是	none

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

代理配置

GET 查询个人代理缓存开关

GET /ep/proxy-cache/status

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

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

枚举值

属性	值
status	0
status	1

POST 设置个人代理缓存开关

POST /ep/proxy-cache/change

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

Body 请求参数

{
  "status": 0
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» status	body	integer	是	none

枚举值

属性	值
» status	0
» status	1

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

GET 查询个人代理 UDP 开关

GET /ep/user-proxy-config/udp

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

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

枚举值

属性	值
enabled	0
enabled	1

POST 设置个人代理 UDP 开关

POST /ep/user-proxy-config/udp

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

Body 请求参数

{
  "udp": 0
}

请求参数

名称	位置	类型	必选	说明
body	body	object	是	none
» udp	body	integer	是	none

枚举值

属性	值
» udp	0
» udp	1

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	HTTP 成功；请检查业务 code，200 为成功。	Inline

返回数据结构

枚举值

属性	值
enabled	0
enabled	1

数据模型

ApiKeyManageRequest

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

属性

名称	类型	必选	约束	中文名	说明
team_id	ResourceSpaceId	false	none		公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
id	integer	true	none		API Key ID

OpenApiAccountProfile

{
  "id": 0,
  "username": "string",
  "nickname": "string",
  "email": "string",
  "balance": "string",
  "gift_balance": "string",
  "currency": "string",
  "language": "string",
  "timezone": "string"
}

属性

名称	类型	必选	约束	说明
id	integer	true	none	用户 ID
username	string	true	none	用户名
nickname	string	true	none	昵称
email	string	true	none	绑定邮箱
balance	string	true	none	充值余额，十进制字符串
gift_balance	string	true	none	当前赠送余额，十进制字符串
currency	string	true	none	站点币种
language	string	true	none	用户语言，未配置时使用站点语言
timezone	string	true	none	用户时区，未配置时使用站点时区

OpenApiBalanceRecord

{
  "id": 0,
  "re_type": 0,
  "transaction_type": 0,
  "balance_type": 0,
  "fee": "string"
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	数据库数值可能序列化为字符串
re_type	integer	false	none	0 支出，1 收入
transaction_type	integer	false	none	交易类型
balance_type	integer	false	none	余额类型
fee	string	false	none	变动金额，站点币种

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

属性

名称	类型	必选	约束	说明
id	integer	false	none	数据库数值可能序列化为字符串
user_id	integer	false	none	详情接口返回
start_time	string	false	none	Y-m-d H:i:s；非 RFC 3339 日期
end_time	string	false	none	Y-m-d H:i:s；非 RFC 3339 日期
status	string	false	none	none
file_size	integer¦null	false	none	none
record_count	integer¦null	false	none	none
created_at	string	false	none	Y-m-d H:i:s；非 RFC 3339 日期
completed_at	string	false	none	Y-m-d H:i:s；非 RFC 3339 日期
file_url	string	false	none	完成后详情接口返回
download_url	string	false	none	完成后返回，有效期 24 小时的签名下载地址
error_message	string	false	none	失败时详情接口可能返回

枚举值

属性	值
status	pending
status	processing
status	completed
status	failed
status	canceled
status	no_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
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	数据库数值可能序列化为字符串
coupon_id	integer	false	none	数据库数值可能序列化为字符串
type	integer	false	none	数据库数值可能序列化为字符串
status	integer	false	none	数据库数值可能序列化为字符串
source	integer	false	none	数据库数值可能序列化为字符串
title	string	false	none	none
title_en	string	false	none	none
description	string	false	none	none
description_en	string	false	none	none
start_amount	string¦null	false	none	none
start_amount_usd	string¦null	false	none	none
start_amount_hkd	string¦null	false	none	none
deduction_amount	string¦null	false	none	none
deduction_amount_usd	string¦null	false	none	none
deduction_amount_hkd	string¦null	false	none	none
discount_rate	string¦null	false	none	none
discount_ceiling_amount	string¦null	false	none	none
discount_ceiling_amount_usd	string¦null	false	none	none
discount_ceiling_amount_hkd	string¦null	false	none	none
created_at	string¦null	false	none	Y-m-d H:i:s
effect_at	string¦null	false	none	Y-m-d H:i:s
expired_at	string¦null	false	none	Y-m-d H:i:s
used_at	string¦null	false	none	Y-m-d H:i:s
product_types	string¦null	false	none	适用套餐类型
created_timestamp	integer¦null	false	none	none
effect_timestamp	integer¦null	false	none	none
expired_timestamp	integer¦null	false	none	none
used_timestamp	integer¦null	false	none	none
is_expired	boolean	false	none	列表接口返回

OpenApiNotification

{
  "id": 0,
  "title": "string",
  "content": "string",
  "type": 0,
  "read_status": 0,
  "created_at": "string",
  "created_timestamp": 0
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	数据库数值可能序列化为字符串
title	string	false	none	none
content	string	false	none	按请求语言渲染的内容
type	integer	false	none	数据库数值可能序列化为字符串
read_status	integer	false	none	none
created_at	string	false	none	Y-m-d H:i:s；非 RFC 3339 日期
created_timestamp	integer	false	none	none

枚举值

属性	值
read_status	0
read_status	1

productTypes

套餐类型，9 动态住宅流量套餐、11 动态住宅IP、14静态数据中心IP、25 静态住宅IP

属性

名称	类型	必选	约束	中文名	说明
anonymous	integer	false	none		套餐类型，9 动态住宅流量套餐、11 动态住宅IP、14静态数据中心IP、25 静态住宅IP

枚举值

属性	值
anonymous	9
anonymous	11
anonymous	14
anonymous	25

apiKey

"pa$$word"

API Key；使用 apiKeyAuth 或操作声明的请求参数传递

属性

名称	类型	必选	约束	中文名	说明
anonymous	string(password)	false	none		API Key；使用 apiKeyAuth 或操作声明的请求参数传递

responseCode

状态码,200 成功、3 app_key 无效

属性

名称	类型	必选	约束	中文名	说明
anonymous	integer	false	none		状态码,200 成功、3 app_key 无效

responseMsg

"success"

response message

属性

名称	类型	必选	约束	中文名	说明
anonymous	string	false	none		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"
}

属性

名称	类型	必选	约束	说明
code	integer	true	none	none
msg	string	true	none	none
data	object¦null	true	none	业务数据，具体类型由接口定义
request_id	string	true	none	请求链路追踪 ID

WebV1ErrorResponse

{
  "code": 2,
  "msg": "parameter error",
  "data": {},
  "request_id": "string"
}

属性

名称	类型	必选	约束	中文名	说明
code	integer	true	none		业务错误码

not

名称	类型	必选	约束	中文名	说明
»anonymous	any	false	none		none

continued

名称	类型	必选	约束	说明
msg	string	true	none	错误描述
data	object¦null	true	none	错误附加数据，无附加数据时为 null
request_id	string	true	none	请求链路追踪 ID

TeamPublicId

"A1b2C3d4E5f6"

团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键

属性

名称	类型	必选	约束	中文名	说明
anonymous	string	false	none		团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键

ResourceSpaceId

"A1b2C3d4E5f6"

公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识

属性

oneOf

名称	类型	必选	约束	中文名	说明
anonymous	string	false	none		none

xor

名称	类型	必选	约束	中文名	说明
anonymous	TeamPublicId	false	none		团队公开标识，首字符为 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"
}

属性

名称	类型	必选	约束	说明
id	TeamPublicId	true	none	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
name	string	true	none	团队名称
super_admin_user_id	integer	true	none	超级管理员用户 ID
status	integer	true	none	团队状态：0=禁用，1=有效，2=解散中，3=已解散
current_role	integer¦null	true	none	当前用户在团队中的角色；无法确定时为 null
dissolving_at	string¦null	true	none	开始解散时间
dissolved_at	string¦null	true	none	解散完成时间
created_at	string	true	none	创建时间
updated_at	string	true	none	更新时间

枚举值

属性	值
status	0
status	1
status	2
status	3
current_role	1
current_role	2
current_role	3
current_role	4
current_role	null

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
}

属性

名称	类型	必选	约束	说明
id	integer	true	none	用户套餐 ID
user_id	integer	true	none	资源所有人用户 ID
team_id	ResourceSpaceId	true	none	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
team_user_id	integer	true	none	实际创建成员用户 ID
product_id	integer	true	none	产品 ID
product_type	integer	true	none	产品类型
parent_product_type	integer	true	none	父产品类型
status	integer	true	none	套餐状态
total_amount	integer(int64)	true	none	总量
remain	integer(int64)	true	none	剩余量
bandwidth	integer	false	none	带宽（Mbps）；仅 product_type=19 或 11 返回
concurrency	integer	false	none	并发数；仅 product_type=11 返回
expired_at	string¦null	true	none	过期时间
created_at	string	true	none	创建时间
ip	string	false	none	静态 IP 地址；仅 product_type=19 返回
country_code	string	false	none	静态 IP 国家代码；仅 product_type=19 返回
country_name	string	false	none	静态 IP 国家名称；仅 product_type=19 返回
asn	string	false	none	静态 IP ASN；仅 product_type=19 返回
port	integer	false	none	静态 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_id	TeamPublicId	true	none	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
product_types	[integer]	true	none	团队资源空间未取消、未软删除且当前站点支持的套餐类型
product_residence_remain_count	integer(int64)	false	none	类型 9 剩余流量
product_residence_total_count	integer(int64)	false	none	类型 9 总流量
pdrue2_timestamp	integer(int64)	false	none	类型 11 最晚过期时间戳；无团队套餐时为 0
remain	integer	false	none	类型 17 剩余数量
total_amount	integer	false	none	类型 17 总数量
scraping_remain	integer(int64)	false	none	类型 18 剩余次数
scraping_total_amount	integer(int64)	false	none	类型 18 总次数
scraping_timestamp	string	false	none	类型 18 最晚过期时间；无套餐时为 "-"
scraping_timestamp2	integer(int64)	false	none	类型 18 最晚过期时间戳
common_scraping_remain	integer(int64)	false	none	类型 29 剩余次数
common_scraping_total_amount	integer(int64)	false	none	类型 29 总次数
common_scraping_timestamp	string	false	none	类型 29 最晚过期时间；无套餐时为 "-"
common_scraping_timestamp2	integer(int64)	false	none	类型 29 最晚过期时间戳
pdidcr_count	integer	false	none	类型 12 有效套餐数量
pdidcr_total	integer	false	none	类型 12 套餐总数
pdidcr_traffic_remain	integer(int64)	false	none	类型 12 剩余流量
pdidcr_traffic_total	integer(int64)	false	none	类型 12 总流量
p_sitai_ip_count	integer	false	none	类型 13 有效 IP 数量
p_sitai_ip	integer	false	none	类型 13 有效套餐数量
p_sitai_ip_total	integer	false	none	类型 13 套餐总数
p_sitai_remain	integer(int64)	false	none	类型 13/24 剩余流量
p_sitai_total	integer(int64)	false	none	类型 13/24 总流量
pdidc_count	integer	false	none	类型 14 有效套餐数量
pdidc_total	integer	false	none	类型 14 套餐总数
pdidc_ip_count	integer	false	none	类型 14 有效 IP 数量
pdidc_ip_all_count	integer	false	none	类型 14 IP 总数
pdispr_count	integer	false	none	类型 15 有效套餐数量
pdispr_total	integer	false	none	类型 15 套餐总数
pdispr_traffic_remain	integer(int64)	false	none	类型 15 剩余流量
pdispr_traffic_total	integer(int64)	false	none	类型 15 总流量
product_datacenter_isp_traffic_ip_count	integer	false	none	类型 16 有效 IP 数量
product_datacenter_isp_traffc_ip	integer	false	none	类型 16 有效套餐数量；历史兼容拼写
product_datacenter_isp_traffc_ip_total	integer	false	none	类型 16 套餐总数；历史兼容拼写
product_datacenter_isp_traffic_ip	integer	false	none	类型 16 有效套餐数量
product_datacenter_isp_traffic_ip_total	integer	false	none	类型 16 套餐总数
product_datacenter_isp_traffc_remain	integer(int64)	false	none	类型 16/24 剩余流量；历史兼容拼写
product_datacenter_isp_traffc_total	integer(int64)	false	none	类型 16/24 总流量；历史兼容拼写
product_datacenter_isp_traffic_remain	integer(int64)	false	none	类型 16/24 剩余流量
product_datacenter_isp_traffic_total	integer(int64)	false	none	类型 16/24 总流量
product_datacenter_isp_ip	integer	false	none	类型 21 或 25 有效套餐数量
product_datacenter_isp_ip_total	integer	false	none	类型 21 或 25 套餐总数
product_datacenter_isp_ip_count	integer	false	none	类型 21 或 25 有效 IP 数量
product_datacenter_isp_ip_all_count	integer	false	none	类型 21 或 25 IP 总数
product_datacenter_isp_ip_traffic_remain	integer(int64)	false	none	类型 21 对应类型 24 剩余流量
product_datacenter_isp_ip_traffic_total	integer(int64)	false	none	类型 21 对应类型 24 总流量
product_agent_residence_remain_count	integer(int64)	false	none	类型 22 剩余流量
product_agent_residence_total_count	integer(int64)	false	none	类型 22 总流量
product_serp_remain	integer(int64)	false	none	类型 27 剩余次数
product_serp_total	integer(int64)	false	none	类型 27 总次数
product_serp_timestamp	string	false	none	类型 27 最晚过期时间；无套餐时为 "-"
product_serp_timestamp2	integer(int64)	false	none	类型 27 最晚过期时间戳
product_video_remain	integer(int64)	false	none	类型 28 剩余流量
product_video_total	integer(int64)	false	none	类型 28 总流量
product_video_timestamp	string	false	none	类型 28 最晚过期时间；无套餐时为 "-"
product_video_timestamp2	integer(int64)	false	none	类型 28 最晚过期时间戳

TeamWallet

{
  "team_id": "A1b2C3d4E5f6",
  "balance": 0.1,
  "total_recharge_fee": 0.1,
  "updated_at": "string"
}

团队钱包，与超级管理员个人余额隔离；金额使用当前站点默认货币，最多 4 位小数。

属性

名称	类型	必选	约束	说明
team_id	TeamPublicId	true	none	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
balance	number(double)	true	none	当前可用团队余额
total_recharge_fee	number(double)	true	none	当前未消费的团队充值本金，不含个人余额转入金额
updated_at	string	true	none	钱包最近变更时间

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

属性

名称	类型	必选	约束	说明
id	integer	true	none	none
team_id	TeamPublicId	true	none	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
operator_user_id	integer	true	none	操作人，系统退款为 0
creator	TeamCreator	false	none	none
direction	integer	true	none	0=支出，1=收入
transaction_type	integer	true	none	1=充值入账，2=个人余额转入，3=余额消费，4=退款或充值退款扣回，5=转回个人余额
amount	number(double)	true	none	本次变动金额，方向由 direction 表示
after_balance	number(double)	true	none	变动后的团队钱包余额
link_id	integer	true	none	关联订单 ID；个人余额转入时为操作用户 ID
request_id	string	true	none	none
remark	string	true	none	none
created_at	string	true	none	none

枚举值

属性	值
direction	0
direction	1
transaction_type	1
transaction_type	2
transaction_type	3
transaction_type	4
transaction_type	5

TeamCreator

{
  "user_id": 0,
  "display_name": "string",
  "nickname": "string",
  "username": "string",
  "email": "string",
  "phone": "string"
}

属性

名称	类型	必选	约束	说明
user_id	integer	true	none	操作人用户 ID；系统操作为 0
display_name	string	true	none	展示名称，依次取昵称、用户名、邮箱、手机号
nickname	string	true	none	none
username	string	true	none	none
email	string	true	none	非管理员视角为脱敏值
phone	string	true	none	非管理员视角为脱敏值

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

名称	类型	必选	约束	中文名	说明
anonymous	WebV1SuccessResponse	false	none		none

and

名称	类型	必选	约束	中文名	说明
anonymous	object	false	none		none
» data	Team	false	none		none

TeamListResponse

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

属性

allOf

名称	类型	必选	约束	中文名	说明
anonymous	WebV1SuccessResponse	false	none		none

and

名称	类型	必选	约束	说明
anonymous	object	false	none	none
» data	object	false	none	none
»» list	[Team]	true	none	none
»» total	integer	true	none	none
»» page	integer	true	none	none
»» page_size	integer	true	none	none

TeamMemberListResponse

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

属性

allOf

名称	类型	必选	约束	中文名	说明
anonymous	WebV1SuccessResponse	false	none		none

and

名称	类型	必选	约束	说明
anonymous	object	false	none	none
» data	object	false	none	none
»» list	[TeamMember]	true	none	none
»» total	integer	true	none	none
»» page	integer	true	none	none
»» page_size	integer	true	none	none

TeamPersonListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "record_type": "[",
        "record_id": 1,
        "team_id": "A1b2C3d4E5f6",
        "user_id": 0,
        "inviter_user_id": 0,
        "invite_type": "[",
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": "[",
        "role": "[",
        "status": "[",
        "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

名称	类型	必选	约束	中文名	说明
anonymous	WebV1SuccessResponse	false	none		none

and

名称	类型	必选	约束	说明
anonymous	object	false	none	none
» data	object	false	none	none
»» list	[TeamPerson]	true	none	none
»» total	integer	true	none	none
»» page	integer	true	none	none
»» page_size	integer	true	none	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

名称	类型	必选	约束	中文名	说明
anonymous	WebV1SuccessResponse	false	none		none

and

名称	类型	必选	约束	中文名	说明
anonymous	object	false	none		none
» data	TeamAsset	false	none		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

名称	类型	必选	约束	中文名	说明
anonymous	WebV1SuccessResponse	false	none		none

and

名称	类型	必选	约束	中文名	说明
anonymous	object	false	none		none
» data	TeamProductInfo	false	none		套餐统计字段与 /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

名称	类型	必选	约束	中文名	说明
anonymous	WebV1SuccessResponse	false	none		none

and

名称	类型	必选	约束	中文名	说明
anonymous	object	false	none		none
» data	TeamWallet	false	none		团队钱包，与超级管理员个人余额隔离；金额使用当前站点默认货币，最多 4 位小数。

TeamWalletRecordListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "operator_user_id": 0,
        "creator": {},
        "direction": "[",
        "transaction_type": "[",
        "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

名称	类型	必选	约束	中文名	说明
anonymous	WebV1SuccessResponse	false	none		none

and

名称	类型	必选	约束	说明
anonymous	object	false	none	none
» data	object	false	none	none
»» list	[TeamWalletRecord]	true	none	none
»» total	integer	true	none	none
»» page	integer	true	none	none
»» page_size	integer	true	none	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

名称	类型	必选	约束	中文名	说明
anonymous	WebV1SuccessResponse	false	none		none

and

名称	类型	必选	约束	说明
anonymous	object	false	none	none
» data	object	false	none	none
»» list	[TeamAsset]	true	none	none
»» total	integer	true	none	none
»» page	integer	true	none	none
»» page_size	integer	true	none	none

UserApiKeyMetadata

{
  "id": 1,
  "api_key": "string",
  "team_user_id": 0,
  "remark": "string",
  "status": 0,
  "created_at": "string",
  "updated_at": "string"
}

属性

名称	类型	必选	约束	说明
id	integer	true	none	API Key ID
api_key	string	true	none	创建响应为完整 Key；团队列表中为脱敏值
team_user_id	integer	true	none	团队 Key 实际持有成员 ID，个人 Key 为 0
remark	string	true	none	备注
status	integer	true	none	0=停用，1=启用
created_at	string	true	none	创建时间
updated_at	string¦null	false	none	更新时间

枚举值

属性	值
status	0
status	1

InvoiceInfo

{
  "invoice_code": "string",
  "name": "string",
  "org_name": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "email": "user@example.com",
  "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_code	string	false	none	none
name	string	false	none	none
org_name	string	false	none	none
first_name	string	false	none	none
last_name	string	false	none	none
phone	string	false	none	none
email	string(email)	false	none	none
role_type	integer	false	none	none
invoice_type	integer	false	none	none
vat_id	string	false	none	none
tax_no	string	false	none	none
address_country	string	false	none	none
address_city	string	false	none	none
address_line1	string	false	none	none
address_line2	string	false	none	none
address_postal_code	string	false	none	none
bank_name	string	false	none	none
bank_account	string	false	none	none
is_def	boolean	false	none	none

枚举值

属性	值
role_type	1
role_type	2
invoice_type	0
invoice_type	1
invoice_type	2

MonthlyRenewalRequest

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

属性

名称	类型	必选	约束	中文名	说明
team_id	ResourceSpaceId	false	none		公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
user_product_ids	any	true	none		用户套餐 ID 数组，也兼容英文逗号分隔字符串

oneOf

名称	类型	必选	约束	中文名	说明
»anonymous	[integer]	false	none		none

xor

名称	类型	必选	约束	中文名	说明
»anonymous	string	false	none		none

continued

名称	类型	必选	约束	中文名	说明
user_coupon_id	integer	false	none		none
coupon_sn	string	false	none		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"
}

属性

名称	类型	必选	约束	说明
id	integer	true	none	邀请 ID
team_id	TeamPublicId	true	none	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
inviter_user_id	integer	true	none	邀请人用户 ID
invitee_user_id	integer	true	none	受邀用户 ID，尚未匹配注册用户时为 0
invite_type	integer	true	none	邀请类型：1=已注册用户，2=邮箱，3=手机号
invite_country_code	integer	true	none	手机号国家或地区码，非手机号邀请为 0
invite_target	string	true	none	标准化后的邀请目标；已注册用户为 user:{user_id}
delivery_type	integer	true	none	原始投递渠道：1=已注册用户，2=邮箱，3=手机号；邮箱或手机号匹配到已注册用户时仍保留原渠道
role	integer	true	none	目标角色：2=管理员，3=普通成员
status	integer	true	none	邀请状态：0=待处理，1=已接受，2=已拒绝，3=已取消，4=已过期
accepted_by_user_id	integer	true	none	接受人用户 ID，未接受时为 0
expired_at	string	true	none	过期时间，格式 YYYY-MM-DD HH:mm:ss
accepted_at	string¦null	true	none	接受时间
rejected_at	string¦null	true	none	拒绝时间
cancelled_at	string¦null	true	none	取消时间
created_at	string	true	none	创建时间，格式 YYYY-MM-DD HH:mm:ss

枚举值

属性	值
invite_type	1
invite_type	2
invite_type	3
delivery_type	1
delivery_type	2
delivery_type	3
role	2
role	3
status	0
status	1
status	2
status	3
status	4

TeamMember

{
  "team_member_id": 1,
  "team_id": "A1b2C3d4E5f6",
  "user_id": 1,
  "role": 1,
  "status": 0,
  "joined_at": "string",
  "nickname": "string",
  "username": "string"
}

属性

名称	类型	必选	约束	说明
team_member_id	integer	true	none	成员关系 ID
team_id	TeamPublicId	true	none	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
user_id	integer	true	none	成员用户 ID
role	integer	true	none	角色：1=超级管理员，2=管理员，3=普通成员，4=财务成员
status	integer	true	none	成员状态：0=禁用，1=有效，2=已退出，3=已移除
joined_at	string¦null	true	none	加入时间，格式 YYYY-MM-DD HH:mm:ss
nickname	string	true	none	成员昵称
username	string	true	none	成员用户名

枚举值

属性	值
role	1
role	2
role	3
role	4
status	0
status	1
status	2
status	3

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_type	string	true	none	记录类型；member 为有效成员，invitation 为待处理邀请
record_id	integer	true	none	成员关系 ID 或邀请 ID
team_id	TeamPublicId	true	none	团队公开标识，首字符为 ASCII 字母，其余字符仅包含 ASCII 字母和数字；不下发数据库数字主键
user_id	integer	true	none	用户 ID，未注册受邀用户为 0
inviter_user_id	integer	true	none	邀请人用户 ID，成员记录为 0
invite_type	integer	true	none	邀请类型，成员记录为 0
invite_country_code	integer	true	none	手机号国家或地区码，成员记录为 0
invite_target	string	true	none	邀请目标，成员记录为空字符串
delivery_type	integer	true	none	原始投递渠道，成员记录为 0
role	integer	true	none	角色：1=超级管理员，2=管理员，3=普通成员，4=财务成员
status	integer	true	none	member 固定为 1，invitation 固定为 0
display_name	string	true	none	统一展示名称，依次取昵称、用户名、邮箱、手机号；普通成员视角下联系方式使用脱敏值
nickname	string	true	none	成员或已注册受邀用户昵称
username	string	true	none	成员或已注册受邀用户名
email	string	true	none	邮箱；超级管理员和管理员返回完整值，普通成员返回带星号的脱敏值
phone	string	true	none	手机号；超级管理员和管理员返回完整值，普通成员返回带星号的脱敏值
joined_at	string¦null	true	none	成员加入时间，邀请记录为 null
expired_at	string¦null	true	none	邀请过期时间，成员记录为 null
created_at	string	true	none	记录创建时间，格式 YYYY-MM-DD HH:mm:ss

枚举值

属性	值
record_type	member
record_type	invitation
invite_type	0
invite_type	1
invite_type	2
invite_type	3
delivery_type	0
delivery_type	1
delivery_type	2
delivery_type	3
role	1
role	2
role	3
role	4
status	0
status	1

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

名称	类型	必选	约束	中文名	说明
anonymous	WebV1SuccessResponse	false	none		none

and

名称	类型	必选	约束	中文名	说明
anonymous	object	false	none		none
» data	TeamInvitation	false	none		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

名称	类型	必选	约束	中文名	说明
anonymous	WebV1SuccessResponse	false	none		none

and

名称	类型	必选	约束	中文名	说明
anonymous	object	false	none		none
» data	TeamMember	false	none		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

名称	类型	必选	约束	中文名	说明
anonymous	WebV1SuccessResponse	false	none		none

and

名称	类型	必选	约束	说明
anonymous	object	false	none	none
» data	object	false	none	none
»» invitation	TeamInvitation	true	none	none
»» invitation_token	string	true	none	明文邀请令牌，仅为兼容既有客户端保留；新客户端直接使用 invitation_url
»» invitation_url	string(uri)	true	none	包含邀请令牌的前端处理链接
»» notification_channels	TeamInvitationNotificationChannels	true	none	none

TeamInvitationNotificationChannels

{
  "email": "queued",
  "sms": "queued",
  "site_inner_message": "created"
}

属性

名称	类型	必选	约束	说明
email	string	false	none	邮件渠道结果
sms	string	false	none	短信渠道结果
site_inner_message	string	false	none	站内信渠道结果

枚举值

属性	值
email	queued
email	failed
email	skipped
sms	queued
sms	failed
sms	skipped
site_inner_message	created
site_inner_message	exists
site_inner_message	failed

TeamInvitationPreviewResponse

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

属性

allOf

名称	类型	必选	约束	中文名	说明
anonymous	WebV1SuccessResponse	false	none		none

and

名称	类型	必选	约束	说明
anonymous	object	false	none	none
» data	object	false	none	none
»» team_name	string	true	none	团队名称
»» role	integer	true	none	目标角色
»» status	integer	true	none	邀请状态
»» expired_at	string	true	none	过期时间，格式 YYYY-MM-DD HH:mm:ss

枚举值

属性	值
role	2
role	3
status	0
status	1
status	2
status	3
status	4

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

名称	类型	必选	约束	中文名	说明
anonymous	WebV1SuccessResponse	false	none		none

and

名称	类型	必选	约束	说明
anonymous	object	false	none	none
» data	object	false	none	none
»» invitation	TeamInvitation	true	none	none
»» invitation_url	string(uri)	true	none	新的邀请处理链接；旧链接已失效
»» notification_channels	TeamInvitationNotificationChannels	true	none	none

TeamInvitationListResponse

{
  "code": 200,
  "msg": "SUCCESS",
  "data": {
    "list": [
      {
        "id": 1,
        "team_id": "A1b2C3d4E5f6",
        "inviter_user_id": 1,
        "invitee_user_id": 0,
        "invite_type": "[",
        "invite_country_code": 999,
        "invite_target": "string",
        "delivery_type": "[",
        "role": "[",
        "status": "[",
        "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

名称	类型	必选	约束	中文名	说明
anonymous	WebV1SuccessResponse	false	none		none

and

名称	类型	必选	约束	说明
anonymous	object	false	none	none
» data	object	false	none	none
»» list	[TeamInvitation]	true	none	none
»» total	integer	true	none	邀请总数
»» page	integer	true	none	当前页码
»» page_size	integer	true	none	实际每页数量

User

{
  "id": 0,
  "email": "user@example.com",
  "phone": "string",
  "balance": 0.1,
  "status": 0,
  "is_real_name": true,
  "created_at": "2019-08-24T14:15:22Z"
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	none
email	string(email)	false	none	none
phone	string	false	none	none
balance	number(float)	false	none	none
status	integer	false	none	none
is_real_name	boolean	false	none	none
created_at	string(date-time)	false	none	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": "user@example.com",
    "role_type": 0,
    "vat_id": "string",
    "address_country": "string",
    "address_city": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string"
  }
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	订单ID
trade_no	string	false	none	内部订单编号
out_trade_no	string	false	none	外部订单编号
product_id	integer	false	none	套餐ID
product_type	integer	false	none	套餐类型，见产品类型枚举
amount	integer	false	none	购买数量
unit_price	number(float)	false	none	单价
total_fee	number(float)	false	none	订单总价（不含折扣，含手续费）
goods_fee	number(float)	false	none	商品价格（含折扣，不含手续费）
pay_fee	number(float)	false	none	实付金额（含折扣，含手续费）
discount_fee	number(float)	false	none	优惠金额
handling_fee	number(float)	false	none	手续费
refund_fee	number(float)	false	none	退款金额
pm_id	integer	false	none	支付方式ID（来自 /openapi/payment/list）
pm_title	string	false	none	支付方式名称
pm_logo	string	false	none	支付方式Logo URL
status	integer	false	none	订单状态
title	string	false	none	套餐标题
detail	string	false	none	套餐描述
region_desc	string	false	none	地区规格描述
pay_at	string(date-time)	false	none	支付时间
pay_timestamp	integer	false	none	支付时间戳
created_at	string(date-time)	false	none	创建时间
pay_fee_status	integer	false	none	长短款状态：0正常 1长款（超额支付） 2短款
invoice	object	false	none	发票信息（仅线上支付订单有值）
» name	string	false	none	全名
» org_name	string	false	none	企业名称
» first_name	string	false	none	none
» last_name	string	false	none	none
» phone	string	false	none	none
» email	string(email)	false	none	none
» role_type	integer	false	none	1个人 2企业
» vat_id	string	false	none	税号
» address_country	string	false	none	none
» address_city	string	false	none	none
» address_line1	string	false	none	none
» address_line2	string	false	none	none
» address_postal_code	string	false	none	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_id	integer	false	none	套餐ID
amount	integer	false	none	数量
discount_fee	number(float)	false	none	优惠金额
total_fee	number(float)	false	none	订单总额
pay_fee	number(float)	false	none	实付金额
product_type	integer	false	none	套餐类型
title	string	false	none	套餐标题
detail	string	false	none	套餐描述
ip_result	[object]	false	none	IP批量续费结果（仅IP续费时返回）
» ip	string	false	none	none
» price	number(float)	false	none	none
» country_code	string	false	none	none
» current_time	string(date-time)	false	none	none
» renewal_time	string(date-time)	false	none	none
» country	object	false	none	none
»» name_zh_cn	string	false	none	none
»» flag	string	false	none	圆形旗帜URL
»» square_flag	string	false	none	方形旗帜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
      }
    ]
  }
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	套餐ID
title	string	false	none	套餐主标题
type	integer	false	none	套餐类型
show_type	integer	false	none	展示类型：1普通 2大额推荐 3不可购买（需定制） 4试用
status	integer	false	none	状态：1上架 0下架
price	number(float)	false	none	人民币价格
usd_price	number(float)	false	none	美元价格
price_hkd	number(float)	false	none	港币价格
original_price	number(float)	false	none	原价（CNY）
original_usd_price	number(float)	false	none	原价（USD）
original_price_hkd	number(float)	false	none	原价（HKD）
local_price	number(float)	false	none	本地化价格（依赖 preferred_currency）
local_original_price	number(float)	false	none	本地化原价（依赖 preferred_currency）
preferred_currency	string	false	none	推荐显示货币，如 usd / cny / hkd
support_currencies	string	false	none	支持的货币列表，逗号分隔，如 usd,cny
flow_value	number(float)	false	none	流量套餐默认流量（GB）
flow_give	number(float)	false	none	赠送流量（GB）
balance_give	number(float)	false	none	余额充值赠送金额
balance_value	number(float)	false	none	充值金额
time_validity	number(float)	false	none	包量套餐默认有效时长
time_price	number(float)	false	none	包量套餐每IP价格
time_days	integer	false	none	有效期天数，如 30/90/180/365
tip1	string	false	none	标签说明1
tip2	string	false	none	标签说明2
introduce	[string]	false	none	文本介绍列表
region_list_id	integer	false	none	地区ID
renew_product_list	string	false	none	可续订套餐ID列表（逗号分隔）
parent_product_type	integer	false	none	父套餐类型（type=19时有效）：14或25
total_count	integer	false	none	总库存，0表示不限制
remain_count	integer	false	none	剩余库存
extension_of_time_days	[integer]	false	none	时长倍数列表，为空或仅含1表示不支持
time_days_price_rate	number(float)	false	none	时长价格系数，价格 × (1 + (倍数-1) × rate)
desc	object	false	none	套餐描述信息
» subtitle	string	false	none	副标题
» flow_value	number(float)	false	none	none
» flow_give	number(float)	false	none	none
» balance_give	number(float)	false	none	none
» time_validity	number(float)	false	none	none
» time_price	number(float)	false	none	none
» tip1	string	false	none	none
» tip2	string	false	none	none
» introduce	[string]	false	none	none
sku	object	false	none	规格参数（type=11时返回）
» bandwidth_list	[object]	false	none	带宽规格列表
»» id	integer	false	none	none
»» value	integer	false	none	带宽值（Mbps）
»» price	number(float)	false	none	none
»» price_usd	number(float)	false	none	none
»» price_hkd	number(float)	false	none	none
» duration_list	[object]	false	none	时长规格列表
»» id	integer	false	none	none
»» value	integer	false	none	时长（天）
»» price	number(float)	false	none	none
»» price_usd	number(float)	false	none	none
»» price_hkd	number(float)	false	none	none
» concurrency_list	[object]	false	none	并发规格列表
»» id	integer	false	none	none
»» value	integer	false	none	并发数
»» price	number(float)	false	none	none
»» price_usd	number(float)	false	none	none
»» price_hkd	number(float)	false	none	none

WhiteIp

{
  "id": 0,
  "ip": "string",
  "remark": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	none
ip	string	false	none	none
remark	string	false	none	none
created_at	string(date-time)	false	none	none

WhitelistAccount

{
  "id": 0,
  "username": "string",
  "limit": 0,
  "used": 0,
  "status": 0
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	none
username	string	false	none	none
limit	integer	false	none	none
used	integer	false	none	none
status	integer	false	none	none

Coupon

{
  "id": 0,
  "name": "string",
  "code": "string",
  "discount": 0.1,
  "expire_time": "2019-08-24T14:15:22Z"
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	none
name	string	false	none	none
code	string	false	none	none
discount	number(float)	false	none	none
expire_time	string(date-time)	false	none	none

Article

{
  "id": 0,
  "title": "string",
  "content": "string",
  "created_at": "2019-08-24T14:15:22Z"
}

属性

名称	类型	必选	约束	说明
id	integer	false	none	none
title	string	false	none	none
content	string	false	none	none
created_at	string(date-time)	false	none	none

Pagination

{
  "total": 0,
  "page_no": 0,
  "page_size": 0,
  "total_pages": 0
}

属性

名称	类型	必选	约束	说明
total	integer	false	none	none
page_no	integer	false	none	none
page_size	integer	false	none	none
total_pages	integer	false	none	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"
}

单个套餐的自动续费配置快照

属性

名称	类型	必选	约束	说明
id	integer	false	none	none
user_id	integer	false	none	none
team_id	ResourceSpaceId	false	none	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
team_user_id	integer	false	none	none
product_type	integer	false	none	none
left_traffic	integer	false	none	已废弃字段
left_days	integer	false	none	已废弃字段
user_product_id	integer	false	none	none
product_id	integer	false	none	已废弃字段
status	integer	false	none	0=停用，1=启用
currency	string	false	none	none
agreed_price	number	false	none	约定总价
agreed_bandwidth_price	number	false	none	套餐 11 的约定带宽单价
agreed_concurrency_price	number	false	none	套餐 11 的约定并发单价
bandwidth_id	integer	false	none	none
concurrency_id	integer	false	none	none
duration	integer	false	none	续费时长，单位天
renew_product_id	integer	false	none	none
days_before_expire	integer	false	none	none
traffic_threshold	integer	false	none	流量阈值，数据库值单位 KB
parent_product_type	integer	false	none	none
created_at	string	false	none	none
updated_at	string	false	none	none

枚举值

属性	值
status	0
status	1

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

属性

名称	类型	必选	约束	说明
id	integer	true	none	none
user_id	integer	true	none	none
team_id	ResourceSpaceId	true	none	公开资源空间标识；请求个人空间时省略 team_id 或传空字符串，响应个人空间时为空字符串；数字 0 和字符串 "0" 均非法，团队空间使用 6-12 位团队公开标识
team_user_id	integer	true	none	none
config_id	integer	true	none	none
user_product_id	integer	true	none	none
product_type	integer	true	none	none
renew_product_id	integer	true	none	none
order_id	integer	true	none	none
fee	number	true	none	none
currency	string	true	none	none
before_expired_at	string¦null	false	none	none
after_expired_at	string¦null	false	none	none
before_remain	integer(int64)	true	none	none
after_remain	integer(int64)	true	none	none
trigger_type	integer	true	none	0=到期前，1=流量不足
status	integer	true	none	1=成功，2=已撤销，3=失败
revoke_at	string¦null	false	none	none
revoke_remark	string	true	none	none
created_at	string	true	none	none
updated_at	string	true	none	none

枚举值

属性	值
trigger_type	0
trigger_type	1
status	1
status	2
status	3

MonthlyRenewalBatch

{
  "type": "current",
  "start_at": "string",
  "end_at": "string",
  "target_expired_at": "string",
  "timezone": "string"
}

属性

名称	类型	必选	约束	说明
type	string	true	none	none
start_at	string	true	none	none
end_at	string	true	none	none
target_expired_at	string	true	none	none
timezone	string	true	none	none

枚举值

属性	值
type	current
type	next

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

属性

名称	类型	必选	约束	说明
id	integer	false	none	历史账单明细 ID
user_product_id	integer	true	none	none
product_id	integer	true	none	none
product_type	integer	true	none	none
parent_product_type	integer	true	none	none
title	string	true	none	none
expired_at	string	true	none	none
target_expired_at	string	true	none	none
renew_days	integer	true	none	none
unit_month_price	number	false	none	none
pay_fee	number	true	none	none
currency	string	true	none	none
bandwidth	integer	false	none	none
bandwidth_mbsp	number	false	none	带宽换算值
concurrency	integer	false	none	none
ip	string	false	none	静态 IP 套餐返回
country_code	string	false	none	静态 IP 套餐返回
paid_at	string¦null	false	none	none
refunded_at	string¦null	false	none	none
created_at	string	false	none	none
updated_at	string	false	none	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
  }
}

属性

名称	类型	必选	约束	说明
id	integer	true	none	none
invoice_no	string	true	none	none
invoice_amount	number	true	none	none
invoice_download_url	string	true	none	none
status	integer	true	none	none
remark	string	true	none	none
order_ids	[integer]	true	none	none
created_at	integer	true	none	Unix 时间戳
invoice_info	any	true	none	none

oneOf

名称	类型	必选	约束	说明
»anonymous	object	false	none	none
»» invoice_code	string	true	none	none
»» name	string	true	none	none
»» org_name	string	true	none	none
»» role_type	integer	true	none	none
»» invoice_type	integer	true	none	none

xor

名称	类型	必选	约束	中文名	说明
»anonymous	null	false	none		none

枚举值

属性	值
role_type	1
role_type	2
invoice_type	0
invoice_type	1
invoice_type	2

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_no	string	true	none	none
pm_id	integer	true	none	none
pay_method	integer	true	none	none
trade_type	string	true	none	none
country_code	string	true	none	none
currency	string	true	none	none
goods_fee	number	true	none	none
discount_fee	number	true	none	none
handling_fee	number	true	none	none
pay_fee	number	true	none	none
total_fee	number	true	none	none
pay_method_info	any	true	none	none

oneOf

名称	类型	必选	约束	说明
»anonymous	object	false	none	none
»» id	integer	true	none	none
»» type	integer	true	none	none
»» title	string	true	none	none
»» group	string	true	none	none
»» handling_rate	number	true	none	none
»» handling_fee	number	true	none	none
»» handling_fee_currency	string	true	none	none
»» handling_fee_converted	number	true	none	none

xor

名称	类型	必选	约束	中文名	说明
»anonymous	null	false	none		none

continued

名称	类型	必选	约束	说明
origin	object	true	none	none
» pm_id	integer	true	none	none
» pay_method	integer	true	none	none
» goods_fee	number	true	none	none
» discount_fee	number	true	none	none
» handling_fee	number	true	none	none
» pay_fee	number	true	none	none
» total_fee	number	true	none	none