住宅代理
Updated:
住宅代理是一种流量池 (GB),而非单个IP地址。您通过列表 — 每个列表都有其独立的地理过滤器、轮转规则、端口数量和凭据。
权限:account:read,account:write,计费:撰写
在本小组中
工具 | 功能说明 | |
|---|---|---|
🟢 | 流量限制、已用流量和剩余流量、有效期、默认轮换周期、自动续订状态、 | |
🟢 | 无 | |
🟢 | 该地点拥有多少个居住节点。 | |
🟢 | 使用数字代码搜索ISP目录。 | |
🟢 | 所有住宅列表:ID、标题、凭证、白名单、地理位置、轮换、导出设置。 | |
🟡 | 创建住宅列表。 | |
🟡 | 调整一个住宅列表的排列顺序。 | |
🟡 | 重命名一个住宅列表。 | |
🔴 | 删除一份住宅列表。 | |
🟡 | 创建“API 工具”列表,并返回其登录名和密码。 | |
🟢 | 按列表统计的流量使用量及其费用,以及套餐总流量和每GB价格。 | |
🟢 | 按列表和时间戳整理的原始使用时间线。 | |
🟢 | 住宅流量套餐的价格。 | |
💳 | 购买首个住宅套餐,或为现有套餐增加流量。 |
get_resident_package
🟢read-only · account:read
流量限制、已用流量和剩余流量、有效期、默认轮换周期、自动续订状态、package_key.
get_resident_geo
🟢read-only · account:read
不包含country — 可用国家/地区。附带country — 包括其各区域及其城市名称。其中country 以及region — 该地区的城市及其互联网服务提供商(ISP)。
参数 | 类型 | 描述 |
|---|---|---|
| 字符串 | ISO2代码,例如: |
| 字符串 | 地区名称应采用该国官方列表中的名称,例如: |
返回: 不包含country:{countries: [{code, name}]}。使用country:{code, name, regions: [{code, name, cities: [name]}]}。使用region:{code, name, region: {code, name, cities: [{name, isps[]}]}}. 未知代码或区域:{country | region: null, message, available[]}.
get_resident_geo_count
🟢read-only · account:read
某个地点拥有多少个住宅节点。在为特定城市或ISP创建列表前请参考此信息。
参数 | 类型 | 描述 |
|---|---|---|
| 字符串 | ISO2代码 |
| 字符串 | 子字符串过滤器 |
get_resident_isp_codes
🟢read-only · account:read
使用数字代码搜索ISP目录。
参数 | 类型 | 描述 |
|---|---|---|
| 字符串 | 服务商名称的一部分,例如: |
list_resident_lists
🟢read-only · account:read
所有住宅列表:ID、标题、凭证、白名单、地理位置、轮换、导出设置。password 除非您特别要求,否则结果将以匿名形式返回。
参数 | 类型 | 描述 |
|---|---|---|
| 布尔值 | 返回 |
add_resident_list
🟡changes account state · account:write
创建一个住宅列表。流量仅在使用时才计费。
参数 | 类型 | 描述 |
|---|---|---|
| 字符串 | 列表名称 |
| 整数 | 代理数量:1–1000 |
| 整数 |
|
| 字符串 | ISO2代码 |
| 字符串 | 地理过滤器,拼写必须完全与get_resident_geo 列出它们。一座城市需要所属的区域;当 |
| 字符串 | 用逗号分隔的IP地址;登录名/密码字段留空 |
| 字符串 | 导出格式: |
set_resident_rotation
🟡changes account state · account:write
调整一个住宅列表的排列顺序。
参数 | 类型 | 描述 |
|---|---|---|
| 字符串 | 整数 | 列表 ID |
| 整数 |
|
rename_resident_list
🟡changes account state · account:write
重命名一个住宅列表。
参数 | 类型 | 描述 |
|---|---|---|
| 字符串 | 整数 | 列表 ID |
| 字符串 | 新名称 |
delete_resident_list
🔴destructive · account:write
删除一份住宅列表。
参数 | 类型 | 描述 |
|---|---|---|
| 字符串 | 整数 | 列表 ID |
create_resident_tools_list
🟡changes account state · account:write
创建“API 工具”列表,并返回其登录名和密码。无需任何参数。
get_resident_consumption
🟢read-only · account:read
按列表统计的流量使用情况及其费用,以及套餐总流量和每GB价格。
参数 | 类型 | 描述 |
|---|---|---|
| 字符串 | 一个列表,按其登录名排序 |
| 字符串 |
|
get_resident_traffic_details
🟢read-only · account:read
按列表和时间戳整理原始使用时间线。请使用较窄的日期范围。
参数 | 类型 | 描述 |
|---|---|---|
| 字符串 | 您的专属密钥来自get_resident_package,或一个子包键,用于读取子用户的使用情况 |
| 字符串 | 该包内含一份列表 |
| 字符串 |
|
calc_resident_order
🟢read-only · account:read
住宅流量套餐的价格。参数与make_resident_order.
make_resident_order
💳spends money · billing:write
购买首个住宅套餐,或为现有套餐增加流量。已购买的GB为已添加 剩余流量。
参数 | 类型 | 描述 |
|---|---|---|
| 字符串 | 关税代码来自get_reference with |
| 字符串 |
|
| 字符串 | 促销代码 |