创建连接列表
POST
/account/api/v1/residential/lists/create请明确确认操作
此操作可能更改记录、余额或服务设置。请先阅读范围和注意事项。结果不明确时,应查询同一操作,不要另建操作。
授权
| Authorization | Bearer YOUR_ARNPROXY_API_KEY |
|---|---|
| 所需权限 | residential_management |
| Accept | application/json |
| Content-Type | application/json |
| Idempotency-Key | 16–100 个字母、数字、_ 或 -。保存并对同一操作重复使用相同值。 |
参数
| 名称 | 类型 | 说明 |
|---|---|---|
Idempotency-Key | string | 16–100 个字母/数字/_/-。操作及状态查询使用同一值,不可用于不同请求体。 |
package_id | integer | residential_packages 中的 ARNPROXY 套餐 ID,不能使用上游 package_key。 |
title | string | 非空 UTF-8 文本,最多 255 字节;禁止控制字符、< 或 >。 |
country | string | 两个大写字母的国家代码,例如 US。 |
region | string | 可选位置文本,最多 50 UTF-8 字节;默认为空。 默认值: "" |
city | string | 可选位置文本,最多 50 UTF-8 字节;默认为空。 默认值: "" |
isp | string | 位置响应中的 ISP 文本,最多 50 UTF-8 字节。 |
port_count | integer | 1–1000 个连接端口。 |
rotation_seconds | integer | -1–3600 整数秒,遵循现有列表轮换取值。 |
expected_revision | string | 来自此操作范围/设置查询的 revision,64 个小写十六进制字符。 |
terms | boolean | 明确确认必须发送 JSON 布尔值 true,不能发送字符串 "true"。 |
authentication | string | login_password 或 ip_auth。 默认值: "login_password" |
authorized_ips | string[] | 仅 authentication=ip_auth:1–20 个唯一公网 IPv4 地址。login_password 时省略。 |
请求体
请用相应目录、报价或范围中的值替换 YOUR_/FROM_。示例中的确认值为 false;只有明确同意真实操作时才确认。
{
"package_id": "YOUR_PACKAGE_ID",
"title": "My connection list",
"country": "US",
"port_count": 1,
"rotation_seconds": 0,
"expected_revision": "FROM_SCOPE_REVISION",
"terms": false
}请求示例
printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
curl --silent --show-error --header @- \
--header 'Accept: application/json' \
--connect-timeout 10 --max-time 30 \
--header 'Idempotency-Key: YOUR_SAVED_OPERATION_KEY' \
--request POST --header 'Content-Type: application/json' \
--data-binary @request.json \
'https://www.arnproxy.com/account/api/v1/residential/lists/create'本页不会执行示例。请将 API 密钥保存在服务器环境变量中,不要放入 URL 或浏览器代码。POST 示例需准备 request.json。
{"curl":"printf \u0027Authorization: Bearer %s\\n\u0027 \u0022$ARNPROXY_API_KEY\u0022 |\n curl --silent --show-error --header @- \\\n --header \u0027Accept: application\/json\u0027 \\\n --connect-timeout 10 --max-time 30 \\\n --header \u0027Idempotency-Key: YOUR_SAVED_OPERATION_KEY\u0027 \\\n --request POST --header \u0027Content-Type: application\/json\u0027 \\\n --data-binary @request.json \\\n \u0027https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/lists\/create\u0027","python":"import os, requests\n\nheaders = {\u0022Authorization\u0022: \u0022Bearer \u0022 + os.environ[\u0022ARNPROXY_API_KEY\u0022]}\nheaders[\u0022Idempotency-Key\u0022] = \u0022YOUR_SAVED_OPERATION_KEY\u0022\nimport json\nwith open(\u0022request.json\u0022, encoding=\u0022utf-8\u0022) as f:\n payload = json.load(f)\nresponse = requests.post(\n \u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/lists\/create\u0022,\n headers=headers, json=payload,\n timeout=(10, 30), allow_redirects=False\n)\nprint(response.status_code, response.text)\n# No automatic write retry.","javascript":"const headers = { Authorization: `Bearer ${process.env.ARNPROXY_API_KEY}` };\nheaders[\u0027Idempotency-Key\u0027] = \u0027YOUR_SAVED_OPERATION_KEY\u0027;\nconst { readFile } = await import(\u0027node:fs\/promises\u0027);\nheaders[\u0027Content-Type\u0027] = \u0027application\/json\u0027;\nconst body = await readFile(\u0027request.json\u0027, \u0027utf8\u0027);\nconst response = await fetch(\u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/lists\/create\u0022, {\n method: \u0027POST\u0027, headers, redirect: \u0027error\u0027,\n signal: AbortSignal.timeout(30000), body\n});\nconsole.log(response.status, await response.text());\n\/\/ A write timeout is ambiguous; query its saved operation.","php":"\u003C?php\n$headers = [\u0027Accept: application\/json\u0027,\n \u0027Authorization: Bearer \u0027.getenv(\u0027ARNPROXY_API_KEY\u0027)];\n$headers[] = \u0027Idempotency-Key: YOUR_SAVED_OPERATION_KEY\u0027;\n$headers[] = \u0027Content-Type: application\/json\u0027;\n$ch = curl_init(\u0027https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/lists\/create\u0027);\ncurl_setopt_array($ch, [\n CURLOPT_RETURNTRANSFER =\u003E true,\n CURLOPT_HTTPHEADER =\u003E $headers,\n CURLOPT_FOLLOWLOCATION =\u003E false,\n CURLOPT_SSL_VERIFYPEER =\u003E true, CURLOPT_SSL_VERIFYHOST =\u003E 2,\n CURLOPT_CONNECTTIMEOUT =\u003E 10, CURLOPT_TIMEOUT =\u003E 30,\n CURLOPT_POST =\u003E true,\n CURLOPT_POSTFIELDS =\u003E file_get_contents(\u0027request.json\u0027),\n]);\n$result = curl_exec($ch);\nif ($result === false) {\n \/\/ Do not repeat a write; use the original operation key.\n throw new RuntimeException(\u0027Transport result unknown\u0027);\n}\necho curl_getinfo($ch, CURLINFO_HTTP_CODE).PHP_EOL.$result;\ncurl_close($ch);","go":"package main\n\nimport (\n \u0022fmt\u0022\n \u0022io\u0022\n \u0022net\/http\u0022\n \u0022os\u0022\n \u0022time\u0022\n)\n\nfunc main() {\n client := \u0026http.Client{Timeout: 30*time.Second,\n CheckRedirect: func(req *http.Request, via []*http.Request) error {\n return http.ErrUseLastResponse\n }}\n var body io.Reader\n file, err := os.Open(\u0022request.json\u0022); if err != nil { panic(err) }\n defer file.Close(); body = file\n req, err := http.NewRequest(\u0022POST\u0022, \u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/lists\/create\u0022, body)\n if err != nil { panic(err) }\n req.Header.Set(\u0022Authorization\u0022, \u0022Bearer \u0022+os.Getenv(\u0022ARNPROXY_API_KEY\u0022))\n req.Header.Set(\u0022Idempotency-Key\u0022, \u0022YOUR_SAVED_OPERATION_KEY\u0022)\n req.Header.Set(\u0022Content-Type\u0022, \u0022application\/json\u0022)\n res, err := client.Do(req); if err != nil { panic(err) }\n defer res.Body.Close()\n data, err := io.ReadAll(res.Body); if err != nil { panic(err) }\n fmt.Println(res.StatusCode, string(data))\n}","csharp":"using System;\nusing System.IO;\nusing System.Net.Http;\nusing System.Net.Http.Headers;\nusing System.Text;\n\nusing var handler = new HttpClientHandler { AllowAutoRedirect = false };\nusing var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(30) };\nusing var request = new HttpRequestMessage(HttpMethod.Post,\n \u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/lists\/create\u0022);\nrequest.Headers.Authorization = new AuthenticationHeaderValue(\n \u0022Bearer\u0022, Environment.GetEnvironmentVariable(\u0022ARNPROXY_API_KEY\u0022));\nrequest.Headers.Add(\u0022Idempotency-Key\u0022, \u0022YOUR_SAVED_OPERATION_KEY\u0022);\nrequest.Content = new StringContent(\n await File.ReadAllTextAsync(\u0022request.json\u0022), Encoding.UTF8, \u0022application\/json\u0022);\nusing var response = await client.SendAsync(request);\nConsole.WriteLine((int)response.StatusCode);\nConsole.WriteLine(await response.Content.ReadAsStringAsync());\n\/\/ Never automatically retry an ambiguous write.","java":"import java.net.URI;\nimport java.net.http.*;\nimport java.nio.charset.StandardCharsets;\nimport java.nio.file.*;\n\n\/\/ Inside your application method:\nvar client = HttpClient.newHttpClient();\nvar request = HttpRequest.newBuilder(URI.create(\u0022https:\/\/www.arnproxy.com\/account\/api\/v1\/residential\/lists\/create\u0022))\n .header(\u0022Authorization\u0022, \u0022Bearer \u0022 + System.getenv(\u0022ARNPROXY_API_KEY\u0022))\n .header(\u0022Accept\u0022, \u0022application\/json\u0022)\n .header(\u0022Idempotency-Key\u0022, System.getenv(\u0022ARNPROXY_OPERATION_KEY\u0022))\n .header(\u0022Content-Type\u0022, \u0022application\/json\u0022)\n .POST(HttpRequest.BodyPublishers.ofString(\n Files.readString(Path.of(\u0022request.json\u0022), StandardCharsets.UTF_8)))\n .build();\nvar response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.statusCode());"}响应
200成功响应
{
"ok": true,
"data": {
"state": "completed",
"action": "create",
"package_id": 20001,
"list_id": 30001,
"reason_code": null,
"replayed": false,
"credentials_included": false,
"gb_purchased": 0,
"balance_changes": 0,
"package_expiry_changes": 0,
"manual_review_required": false
},
"meta": {
"request_id": "000000000000000000000001",
"phase": "public_v1",
"source": "arnproxy_records"
}
}响应字段与类型
| 名称 | 类型 | 说明 |
|---|---|---|
ok | boolean | 成功标志;为 false 时请检查 error.code。 |
data | object | 操作特定结果;示例均为演示用合成数据。 |
data.state | string | 记录/操作状态。accepted 不表示已交付,completed 不表示连接测试成功。 |
data.action | string | action 的操作特定值。请保留返回类型并查阅行为说明。 |
data.package_id | integer | 相关 ARNPROXY 记录 ID,请勿替换为上游内部 ID。 |
data.list_id | integer | 相关 ARNPROXY 记录 ID,请勿替换为上游内部 ID。 |
data.reason_code | string|null | 固定原因代码或 null,不返回原始上游错误文本。 |
data.replayed | boolean | 返回同一操作已保存的结果,不代表发生新的扣款或操作。 |
data.credentials_included | boolean | 此结果/密钥是否包含或允许访问敏感凭据。 |
data.gb_purchased | integer | 流量数量;列表/设置操作不会购买流量。 |
data.balance_changes | integer | 此次操作报告的效果;自动续期设置可能在将来产生单独扣款。 |
data.package_expiry_changes | integer | package expiry changes 的操作特定值。请保留返回类型并查阅行为说明。 |
data.manual_review_required | boolean | manual review required 的操作特定值。请保留返回类型并查阅行为说明。 |
meta | object | 请求关联与数据来源元信息。 |
meta.request_id | string | 此 HTTP 请求的跟踪 ID,不是操作键或订单 ID。 |
meta.phase | string | phase 的操作特定值。请保留返回类型并查阅行为说明。 |
meta.source | string | 数据来源;本地记录与实时上游查询属于不同证据。 |
错误响应
{
"ok": false,
"error": { "code": "INVALID_API_KEY" },
"meta": { "request_id": "000000000000000000000001" }
}身份验证和参数校验可能在执行前拒绝请求。请查阅错误参考,联系支持时保留 request_id。切勿发送密钥或密码。 错误与限制 →
行为与重要说明
- 套餐和列表 ID 均为 ARNPROXY 记录 ID,不是上游键值。过期快照不能授予访问;必要时使用 residential_package_refresh。
- 新列表支持 login_password 或 ip_auth。IP 认证列表允许 1–20 个唯一公网 IPv4。删除列表不会删除 GB 套餐,只会撤销使用此列表的连接。
- 超时/5xx 不能证明写操作失败。请使用原始 Idempotency-Key 查询状态,不要换新键重试;GET 不会重发更改。